1. Overview
Congrid Public API enables customers & third parties to integrate with the Congrid platform. The API is a REST style API with JSON as the data format making it easy to approach with plenty of tooling available. Through the API you can access and manage different resources of the Congrid platform. The API provides an easy way to automate day-to-day tasks, such as creating a project and managing the base data of the project. Currently supported operations by the API are creating and configuring projects in the system.
1.1. Version information
Version : 2.0
1.2. Contact information
Contact : Congrid support
Contact Email : support@congrid.com
1.3. URI scheme
Host : api.congrid.com
BasePath : /v2
Schemes : HTTPS
1.4. Tags
-
companies
-
concrete
-
contacts
-
diaries
-
events
-
files
-
floor plans
-
measurements
-
notes
-
photos
-
projects
-
quality matrix
-
tags
-
targets
-
templates
-
users
-
version
1.5. Consumes
-
application/json
1.6. Produces
-
application/json
2. Resources
2.1. Companies
2.1.1. GET /companies
Description
This endpoint accesses all companies for all projects this user has access to.
The company object describes a contractor or subcontractor that is part of a project. Tasks, notes, items etc that are created during the project can only be assigned to companies that are part of the project.
Note
|
A company with the same name can exist in two different projects and still have different id property in both of the projects. |
Note
|
VAT number is not a unique property in the scope of a project, hence multiple company entities in Congrid system can have the same vat code. |
GET returns all companies for all projects this user has access to.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
vatCode |
Fetch by given VAT-code |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyTypeId |
Company type. |
enum (DESIGNER, CONTRACTOR, CLIENT, SUPPLIER, SUPERVISOR, OTHER, CUSTOM) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Company name. |
string |
projectIds |
List of project IDs that this company is working for. |
< string > array |
specifier |
Description for the company. |
string |
vatCode |
Company VAT code. |
string |
verifiedVatCodeRequired |
Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects. |
boolean |
Produces
-
application/json
Example HTTP request
Request path
/companies
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"name" : "The Construction Company Ltd.",
"vatCode" : "12-123456AY",
"verifiedVatCodeRequired" : true
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.2. GET /companies/{id}
Description
This endpoint accesses all companies for all projects this user has access to.
The company object describes a contractor or subcontractor that is part of a project. Tasks, notes, items etc that are created during the project can only be assigned to companies that are part of the project.
Note
|
A company with the same name can exist in two different projects and still have different id property in both of the projects. |
Note
|
VAT number is not a unique property in the scope of a project, hence multiple company entities in Congrid system can have the same vat code. |
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyTypeId |
Company type. |
enum (DESIGNER, CONTRACTOR, CLIENT, SUPPLIER, SUPERVISOR, OTHER, CUSTOM) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Company name. |
string |
projectIds |
List of project IDs that this company is working for. |
< string > array |
specifier |
Description for the company. |
string |
vatCode |
Company VAT code. |
string |
verifiedVatCodeRequired |
Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects. |
boolean |
Produces
-
application/json
Example HTTP request
Request path
/companies/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"name" : "The Construction Company Ltd.",
"vatCode" : "12-123456AY",
"verifiedVatCodeRequired" : true
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.3. GET /companyUnits
Description
Company units describe in more detail what the Company looks like. Company units can be linked to projects to indicate which unit is working with the project.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
typeId |
Example : |
enum (UNIT, FOREMAN, SITE, PERSONNEL, COMPANY, CORPORATION) |
Produces
-
application/json
Example HTTP request
Request path
/companyUnits
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.4. POST /companyUnits
Description
Company units describe in more detail what the Company looks like. Company units can be linked to projects to indicate which unit is working with the project.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
typeId |
Example : |
enum (UNIT, FOREMAN, SITE, PERSONNEL, COMPANY, CORPORATION) |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
typeId |
Example : |
enum (UNIT, FOREMAN, SITE, PERSONNEL, COMPANY, CORPORATION) |
Produces
-
application/json
Example HTTP request
Request path
/companyUnits
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.5. GET /companyUnits/{id}
Description
Company units describe in more detail what the Company looks like. Company units can be linked to projects to indicate which unit is working with the project.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
typeId |
Example : |
enum (UNIT, FOREMAN, SITE, PERSONNEL, COMPANY, CORPORATION) |
Produces
-
application/json
Example HTTP request
Request path
/companyUnits/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.6. PUT /companyUnits/{id}
Description
Company units describe in more detail what the Company looks like. Company units can be linked to projects to indicate which unit is working with the project.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
typeId |
Example : |
enum (UNIT, FOREMAN, SITE, PERSONNEL, COMPANY, CORPORATION) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
typeId |
Example : |
enum (UNIT, FOREMAN, SITE, PERSONNEL, COMPANY, CORPORATION) |
Produces
-
application/json
Example HTTP request
Request path
/companyUnits/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.7. DELETE /companyUnits/{id}
Description
Company units describe in more detail what the Company looks like. Company units can be linked to projects to indicate which unit is working with the project.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/companyUnits/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.8. GET /projects/{projectId}/companies
Description
This endpoint accesses all companies from a project given as part of URL.
The company object describes a contractor or subcontractor that is part of a project. Tasks, notes, items etc that are created during the project can only be assigned to companies that are part of the project.
Note
|
A company with the same name can exist in two different projects and still have different id property in both of the projects. |
Note
|
VAT number is not a unique property in the scope of a project, hence multiple company entities in Congrid system can have the same vat code. |
Returns all companies (the main contractor and sub contractors) that participate in the project given as part of URL.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
vatCode |
Fetch by given VAT-code |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyTypeId |
Company type. |
enum (DESIGNER, CONTRACTOR, CLIENT, SUPPLIER, SUPERVISOR, OTHER, CUSTOM) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Company name. |
string |
projectIds |
List of project IDs that this company is working for. |
< string > array |
specifier |
Description for the company. |
string |
vatCode |
Company VAT code. |
string |
verifiedVatCodeRequired |
Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects. |
boolean |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/companies
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"name" : "The Construction Company Ltd.",
"vatCode" : "12-123456AY",
"verifiedVatCodeRequired" : true
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.9. POST /projects/{projectId}/companies
Description
This endpoint accesses all companies from a project given as part of URL.
The company object describes a contractor or subcontractor that is part of a project. Tasks, notes, items etc that are created during the project can only be assigned to companies that are part of the project.
Note
|
A company with the same name can exist in two different projects and still have different id property in both of the projects. |
Note
|
VAT number is not a unique property in the scope of a project, hence multiple company entities in Congrid system can have the same vat code. |
POST creates a new company. After you have created a project, the project only has one company atteched to it; the company that created the project. Use this end-point to add all the relevant subcontractors to it. This end-point creates a new company and attaches it to the project. If you will not explicitly set the companyTypeId
property then it is set with the default value CONTRACTOR
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
companyTypeId |
Company type. |
enum (DESIGNER, CONTRACTOR, CLIENT, SUPPLIER, SUPERVISOR, OTHER, CUSTOM) |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Company name. |
string |
projectIds |
List of project IDs that this company is working for. |
< string > array |
specifier |
Description for the company. |
string |
vatCode |
Company VAT code. |
string |
verifiedVatCodeRequired |
Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
companyTypeId |
Company type. |
enum (DESIGNER, CONTRACTOR, CLIENT, SUPPLIER, SUPERVISOR, OTHER, CUSTOM) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Company name. |
string |
projectIds |
List of project IDs that this company is working for. |
< string > array |
specifier |
Description for the company. |
string |
vatCode |
Company VAT code. |
string |
verifiedVatCodeRequired |
Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects. |
boolean |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/companies
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"name" : "The Construction Company Ltd.",
"vatCode" : "12-123456AY",
"verifiedVatCodeRequired" : true
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"name" : "The Construction Company Ltd.",
"vatCode" : "12-123456AY",
"verifiedVatCodeRequired" : true
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.10. GET /projects/{projectId}/companies/{id}
Description
This endpoint accesses all companies from a project given as part of URL.
The company object describes a contractor or subcontractor that is part of a project. Tasks, notes, items etc that are created during the project can only be assigned to companies that are part of the project.
Note
|
A company with the same name can exist in two different projects and still have different id property in both of the projects. |
Note
|
VAT number is not a unique property in the scope of a project, hence multiple company entities in Congrid system can have the same vat code. |
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyTypeId |
Company type. |
enum (DESIGNER, CONTRACTOR, CLIENT, SUPPLIER, SUPERVISOR, OTHER, CUSTOM) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Company name. |
string |
projectIds |
List of project IDs that this company is working for. |
< string > array |
specifier |
Description for the company. |
string |
vatCode |
Company VAT code. |
string |
verifiedVatCodeRequired |
Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects. |
boolean |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/companies/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"name" : "The Construction Company Ltd.",
"vatCode" : "12-123456AY",
"verifiedVatCodeRequired" : true
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.11. PUT /projects/{projectId}/companies/{id}
Description
This endpoint accesses all companies from a project given as part of URL.
The company object describes a contractor or subcontractor that is part of a project. Tasks, notes, items etc that are created during the project can only be assigned to companies that are part of the project.
Note
|
A company with the same name can exist in two different projects and still have different id property in both of the projects. |
Note
|
VAT number is not a unique property in the scope of a project, hence multiple company entities in Congrid system can have the same vat code. |
PUT updates company information. If you will not explicitly set the companyTypeId
property in the PUT request, then it is set with the default value CONTRACTOR
.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
companyTypeId |
Company type. |
enum (DESIGNER, CONTRACTOR, CLIENT, SUPPLIER, SUPERVISOR, OTHER, CUSTOM) |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Company name. |
string |
projectIds |
List of project IDs that this company is working for. |
< string > array |
specifier |
Description for the company. |
string |
vatCode |
Company VAT code. |
string |
verifiedVatCodeRequired |
Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyTypeId |
Company type. |
enum (DESIGNER, CONTRACTOR, CLIENT, SUPPLIER, SUPERVISOR, OTHER, CUSTOM) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Company name. |
string |
projectIds |
List of project IDs that this company is working for. |
< string > array |
specifier |
Description for the company. |
string |
vatCode |
Company VAT code. |
string |
verifiedVatCodeRequired |
Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects. |
boolean |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/companies/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"name" : "The Construction Company Ltd.",
"vatCode" : "12-123456AY",
"verifiedVatCodeRequired" : true
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"name" : "The Construction Company Ltd.",
"vatCode" : "12-123456AY",
"verifiedVatCodeRequired" : true
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.12. DELETE /projects/{projectId}/companies/{id}
Description
This endpoint accesses all companies from a project given as part of URL.
The company object describes a contractor or subcontractor that is part of a project. Tasks, notes, items etc that are created during the project can only be assigned to companies that are part of the project.
Note
|
A company with the same name can exist in two different projects and still have different id property in both of the projects. |
Note
|
VAT number is not a unique property in the scope of a project, hence multiple company entities in Congrid system can have the same vat code. |
DELETE removes a company from the project.
Note
|
Removing a company from the project does not remove the users of that company from the project. The users need to be removed separately through the project/users end-point.
|
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/companies/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.13. GET /workGroups
Description
The work group object describes a group of users working for a project.
GET returns all work groups for all projects this user has access to.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work group description. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work group name. |
string |
projectId |
Project ID for the project that owns work group. |
string |
Produces
-
application/json
Example HTTP request
Request path
/workGroups
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.14. POST /workGroups
Description
The work group object describes a group of users working for a project.
POST creates a new work group.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work group description. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Work group name. |
string |
projectId |
Project ID for the project that owns work group. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work group description. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work group name. |
string |
projectId |
Project ID for the project that owns work group. |
string |
Produces
-
application/json
Example HTTP request
Request path
/workGroups
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.15. GET /workGroups/{id}
Description
The work group object describes a group of users working for a project.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work group description. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work group name. |
string |
projectId |
Project ID for the project that owns work group. |
string |
Produces
-
application/json
Example HTTP request
Request path
/workGroups/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.16. PUT /workGroups/{id}
Description
The work group object describes a group of users working for a project.
PUT updates work group information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work group description. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Work group name. |
string |
projectId |
Project ID for the project that owns work group. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work group description. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work group name. |
string |
projectId |
Project ID for the project that owns work group. |
string |
Produces
-
application/json
Example HTTP request
Request path
/workGroups/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.1.17. DELETE /workGroups/{id}
Description
The work group object describes a group of users working for a project.
DELETE removes a work group.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/workGroups/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.2. Concrete
2.2.1. POST /concreteData/{concreteFileFormatId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
concreteFileFormatId |
string |
|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
errors |
Example : |
< string > array |
file |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
status |
Example : |
enum (SUCCESS, PENDING, QUEUED, FAILED, PARSING) |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
errors |
Example : |
< string > array |
file |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
status |
Example : |
enum (SUCCESS, PENDING, QUEUED, FAILED, PARSING) |
Produces
-
application/json
Example HTTP request
Request path
/concreteData/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.2.2. GET /concreteData/{concreteFileFormatId}/{id}
Parameters
Type | Name | Schema |
---|---|---|
Path |
concreteFileFormatId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
errors |
Example : |
< string > array |
file |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
status |
Example : |
enum (SUCCESS, PENDING, QUEUED, FAILED, PARSING) |
Produces
-
application/json
Example HTTP request
Request path
/concreteData/string/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.3. Contacts
2.3.1. GET /contacts
Description
This endpoint accesses all contacts from all projects.
A contact describes the contact details for one contact in a project. The contact is associated with a company.
GET returns all the contacts for all the projects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
email |
Fetch all contacts with given e-mail address |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
isManager |
Example : |
boolean |
isVisibleInMobileClient |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
phone |
Example : |
string |
projectId |
Example : |
string |
taxNumber |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/contacts
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.3.2. GET /contacts/{id}
Description
This endpoint accesses all contacts from all projects.
A contact describes the contact details for one contact in a project. The contact is associated with a company.
GET returns detailed information of a given contact.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
isManager |
Example : |
boolean |
isVisibleInMobileClient |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
phone |
Example : |
string |
projectId |
Example : |
string |
taxNumber |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/contacts/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.3.3. GET /projects/{projectId}/contacts
Description
This endpoint accesses all contacts from a project given as part of URL.
A contact describes the contact details for one contact in a project. The contact is associated with a company.
LIST returns all the contacts in the scope of a project.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
email |
Fetch all contacts with given e-mail address |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
isManager |
Example : |
boolean |
isVisibleInMobileClient |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
phone |
Example : |
string |
projectId |
Example : |
string |
taxNumber |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/contacts
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.3.4. POST /projects/{projectId}/contacts
Description
This endpoint accesses all contacts from a project given as part of URL.
A contact describes the contact details for one contact in a project. The contact is associated with a company.
POST add contacts for a company in the scope of a project.
Note
|
Removing a company from the project does not remove the associated contacts. |
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
isManager |
Example : |
boolean |
isVisibleInMobileClient |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
phone |
Example : |
string |
projectId |
Example : |
string |
taxNumber |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
isManager |
Example : |
boolean |
isVisibleInMobileClient |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
phone |
Example : |
string |
projectId |
Example : |
string |
taxNumber |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/contacts
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.3.5. GET /projects/{projectId}/contacts/{id}
Description
This endpoint accesses all contacts from a project given as part of URL.
A contact describes the contact details for one contact in a project. The contact is associated with a company.
GET returns detailed information of a given contact.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
isManager |
Example : |
boolean |
isVisibleInMobileClient |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
phone |
Example : |
string |
projectId |
Example : |
string |
taxNumber |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/contacts/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.3.6. PUT /projects/{projectId}/contacts/{id}
Description
This endpoint accesses all contacts from a project given as part of URL.
A contact describes the contact details for one contact in a project. The contact is associated with a company.
PUT updates contact information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
isManager |
Example : |
boolean |
isVisibleInMobileClient |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
phone |
Example : |
string |
projectId |
Example : |
string |
taxNumber |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
isManager |
Example : |
boolean |
isVisibleInMobileClient |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
phone |
Example : |
string |
projectId |
Example : |
string |
taxNumber |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/contacts/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.3.7. DELETE /projects/{projectId}/contacts/{id}
Description
This endpoint accesses all contacts from a project given as part of URL.
A contact describes the contact details for one contact in a project. The contact is associated with a company.
DELETE removes a contact from the company.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/contacts/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4. Diaries
2.4.1. GET /diaries
Description
Diary object describes a single diary date. Object gathers together all information from one day.
GET returns list of Diary objects.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
acceptedAt |
Example : |
string (date-time) |
acceptedById |
Example : |
string |
acceptedComments |
Example : |
string |
copyFromDiaryId |
Example : |
string |
copyOptions |
Example : |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
date |
Example : |
string (date) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
lockedAt |
Example : |
string (date-time) |
lockedById |
Example : |
string |
lockedComments |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
originalProjectId |
Example : |
string |
projectId |
Example : |
string |
statusId |
Example : |
enum (ACCEPTED, LOCKED, UNLOCKED) |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
statusIdFrom |
Status ID value before the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusIdTo |
Status ID value after the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/diaries
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.2. POST /diaries
Description
Diary object describes a single diary date. Object gathers together all information from one day.
POST creates a new Diary date object.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
acceptedAt |
Example : |
string (date-time) |
acceptedById |
Example : |
string |
acceptedComments |
Example : |
string |
copyFromDiaryId |
Example : |
string |
copyOptions |
Example : |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
date |
Example : |
string (date) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
lockedAt |
Example : |
string (date-time) |
lockedById |
Example : |
string |
lockedComments |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
originalProjectId |
Example : |
string |
projectId |
Example : |
string |
statusId |
Example : |
enum (ACCEPTED, LOCKED, UNLOCKED) |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
statusIdFrom |
Status ID value before the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusIdTo |
Status ID value after the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
acceptedAt |
Example : |
string (date-time) |
acceptedById |
Example : |
string |
acceptedComments |
Example : |
string |
copyFromDiaryId |
Example : |
string |
copyOptions |
Example : |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
date |
Example : |
string (date) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
lockedAt |
Example : |
string (date-time) |
lockedById |
Example : |
string |
lockedComments |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
originalProjectId |
Example : |
string |
projectId |
Example : |
string |
statusId |
Example : |
enum (ACCEPTED, LOCKED, UNLOCKED) |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
statusIdFrom |
Status ID value before the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusIdTo |
Status ID value after the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/diaries
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.3. GET /diaries/{id}
Description
Diary object describes a single diary date. Object gathers together all information from one day.
Returns one single Diary object by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
acceptedAt |
Example : |
string (date-time) |
acceptedById |
Example : |
string |
acceptedComments |
Example : |
string |
copyFromDiaryId |
Example : |
string |
copyOptions |
Example : |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
date |
Example : |
string (date) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
lockedAt |
Example : |
string (date-time) |
lockedById |
Example : |
string |
lockedComments |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
originalProjectId |
Example : |
string |
projectId |
Example : |
string |
statusId |
Example : |
enum (ACCEPTED, LOCKED, UNLOCKED) |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
statusIdFrom |
Status ID value before the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusIdTo |
Status ID value after the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/diaries/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.4. PUT /diaries/{id}
Description
Diary object describes a single diary date. Object gathers together all information from one day.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
acceptedAt |
Example : |
string (date-time) |
acceptedById |
Example : |
string |
acceptedComments |
Example : |
string |
copyFromDiaryId |
Example : |
string |
copyOptions |
Example : |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
date |
Example : |
string (date) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
lockedAt |
Example : |
string (date-time) |
lockedById |
Example : |
string |
lockedComments |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
originalProjectId |
Example : |
string |
projectId |
Example : |
string |
statusId |
Example : |
enum (ACCEPTED, LOCKED, UNLOCKED) |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
statusIdFrom |
Status ID value before the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusIdTo |
Status ID value after the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
acceptedAt |
Example : |
string (date-time) |
acceptedById |
Example : |
string |
acceptedComments |
Example : |
string |
copyFromDiaryId |
Example : |
string |
copyOptions |
Example : |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
date |
Example : |
string (date) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
lockedAt |
Example : |
string (date-time) |
lockedById |
Example : |
string |
lockedComments |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
originalProjectId |
Example : |
string |
projectId |
Example : |
string |
statusId |
Example : |
enum (ACCEPTED, LOCKED, UNLOCKED) |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
statusIdFrom |
Status ID value before the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusIdTo |
Status ID value after the status change event. |
enum (ACCEPTED, LOCKED, UNLOCKED) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/diaries/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.5. DELETE /diaries/{id}
Description
Diary object describes a single diary date. Object gathers together all information from one day.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/diaries/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.6. GET /diaryLabor
Description
Diary labor describes a single diary date labor information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
diaryId |
Fetch all items related to a given diary |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
count |
Example : |
integer |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
laborTypeId |
Example : |
enum (CONSTRUCTION_WORKERS, SUBCONTRACTORS, FOREMEN, OTHER, CONTRACTORS) |
laborTypeName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/diaryLabor
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.7. POST /diaryLabor
Description
Diary labor describes a single diary date labor information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
count |
Example : |
integer |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
laborTypeId |
Example : |
enum (CONSTRUCTION_WORKERS, SUBCONTRACTORS, FOREMEN, OTHER, CONTRACTORS) |
laborTypeName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
count |
Example : |
integer |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
laborTypeId |
Example : |
enum (CONSTRUCTION_WORKERS, SUBCONTRACTORS, FOREMEN, OTHER, CONTRACTORS) |
laborTypeName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/diaryLabor
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.8. GET /diaryLabor/{id}
Description
Diary labor describes a single diary date labor information.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Example : |
integer |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
laborTypeId |
Example : |
enum (CONSTRUCTION_WORKERS, SUBCONTRACTORS, FOREMEN, OTHER, CONTRACTORS) |
laborTypeName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/diaryLabor/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.9. PUT /diaryLabor/{id}
Description
Diary labor describes a single diary date labor information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
count |
Example : |
integer |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
laborTypeId |
Example : |
enum (CONSTRUCTION_WORKERS, SUBCONTRACTORS, FOREMEN, OTHER, CONTRACTORS) |
laborTypeName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Example : |
integer |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
laborTypeId |
Example : |
enum (CONSTRUCTION_WORKERS, SUBCONTRACTORS, FOREMEN, OTHER, CONTRACTORS) |
laborTypeName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/diaryLabor/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.10. DELETE /diaryLabor/{id}
Description
Diary labor describes a single diary date labor information.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/diaryLabor/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.11. GET /diaryNotes
Description
Diary note describes a single diary date note.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
diaryId |
Fetch all items related to a given diary |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
completedAt |
Example : |
string (date-time) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
diaryNoteTypeId |
Example : |
enum (URGENT_ITEMS, OTHERS, NOTES_AND_ENTRIES, REVIEWS_AND_INSPECTIONS, REQUESTED_EXTRA_TIME, ORDERS_AND_SUPPLIES, OFFERS) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
startedAt |
Example : |
string (date-time) |
targetIds |
Example : |
< string > array |
workSectionIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/diaryNotes
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.12. POST /diaryNotes
Description
Diary note describes a single diary date note.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
completedAt |
Example : |
string (date-time) |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
diaryNoteTypeId |
Example : |
enum (URGENT_ITEMS, OTHERS, NOTES_AND_ENTRIES, REVIEWS_AND_INSPECTIONS, REQUESTED_EXTRA_TIME, ORDERS_AND_SUPPLIES, OFFERS) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
startedAt |
Example : |
string (date-time) |
targetIds |
Example : |
< string > array |
workSectionIds |
Example : |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
completedAt |
Example : |
string (date-time) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
diaryNoteTypeId |
Example : |
enum (URGENT_ITEMS, OTHERS, NOTES_AND_ENTRIES, REVIEWS_AND_INSPECTIONS, REQUESTED_EXTRA_TIME, ORDERS_AND_SUPPLIES, OFFERS) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
startedAt |
Example : |
string (date-time) |
targetIds |
Example : |
< string > array |
workSectionIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/diaryNotes
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.13. GET /diaryNotes/{id}
Description
Diary note describes a single diary date note.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
completedAt |
Example : |
string (date-time) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
diaryNoteTypeId |
Example : |
enum (URGENT_ITEMS, OTHERS, NOTES_AND_ENTRIES, REVIEWS_AND_INSPECTIONS, REQUESTED_EXTRA_TIME, ORDERS_AND_SUPPLIES, OFFERS) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
startedAt |
Example : |
string (date-time) |
targetIds |
Example : |
< string > array |
workSectionIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/diaryNotes/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.14. PUT /diaryNotes/{id}
Description
Diary note describes a single diary date note.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
completedAt |
Example : |
string (date-time) |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
diaryNoteTypeId |
Example : |
enum (URGENT_ITEMS, OTHERS, NOTES_AND_ENTRIES, REVIEWS_AND_INSPECTIONS, REQUESTED_EXTRA_TIME, ORDERS_AND_SUPPLIES, OFFERS) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
startedAt |
Example : |
string (date-time) |
targetIds |
Example : |
< string > array |
workSectionIds |
Example : |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
completedAt |
Example : |
string (date-time) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
diaryNoteTypeId |
Example : |
enum (URGENT_ITEMS, OTHERS, NOTES_AND_ENTRIES, REVIEWS_AND_INSPECTIONS, REQUESTED_EXTRA_TIME, ORDERS_AND_SUPPLIES, OFFERS) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
startedAt |
Example : |
string (date-time) |
targetIds |
Example : |
< string > array |
workSectionIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/diaryNotes/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.15. DELETE /diaryNotes/{id}
Description
Diary note describes a single diary date note.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/diaryNotes/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.16. GET /diaryTasks
Description
Diary task describes a single diary date task information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
copiedFromTaskId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
statusId |
Example : |
enum (ONGOING, ON_HOLD, NOT_STARTED, COMPLETED) |
targetIds |
Example : |
< string > array |
taskTypeId |
Example : |
enum (DYNAMIC_TASK, STATIC_TASK) |
workSectionIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/diaryTasks
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.17. POST /diaryTasks
Description
Diary task describes a single diary date task information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
copiedFromTaskId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
statusId |
Example : |
enum (ONGOING, ON_HOLD, NOT_STARTED, COMPLETED) |
targetIds |
Example : |
< string > array |
taskTypeId |
Example : |
enum (DYNAMIC_TASK, STATIC_TASK) |
workSectionIds |
Example : |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
copiedFromTaskId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
statusId |
Example : |
enum (ONGOING, ON_HOLD, NOT_STARTED, COMPLETED) |
targetIds |
Example : |
< string > array |
taskTypeId |
Example : |
enum (DYNAMIC_TASK, STATIC_TASK) |
workSectionIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/diaryTasks
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.18. GET /diaryTasks/{id}
Description
Diary task describes a single diary date task information.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
copiedFromTaskId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
statusId |
Example : |
enum (ONGOING, ON_HOLD, NOT_STARTED, COMPLETED) |
targetIds |
Example : |
< string > array |
taskTypeId |
Example : |
enum (DYNAMIC_TASK, STATIC_TASK) |
workSectionIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/diaryTasks/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.19. PUT /diaryTasks/{id}
Description
Diary task describes a single diary date task information.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
copiedFromTaskId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
statusId |
Example : |
enum (ONGOING, ON_HOLD, NOT_STARTED, COMPLETED) |
targetIds |
Example : |
< string > array |
taskTypeId |
Example : |
enum (DYNAMIC_TASK, STATIC_TASK) |
workSectionIds |
Example : |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
copiedFromTaskId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
diaryId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
orderNumber |
Example : |
integer |
statusId |
Example : |
enum (ONGOING, ON_HOLD, NOT_STARTED, COMPLETED) |
targetIds |
Example : |
< string > array |
taskTypeId |
Example : |
enum (DYNAMIC_TASK, STATIC_TASK) |
workSectionIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/diaryTasks/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.4.20. DELETE /diaryTasks/{id}
Description
Diary task describes a single diary date task information.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/diaryTasks/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5. Events
2.5.1. GET /comments
Description
Comment object in Congrid system.
Comment objects can be linked to all objects that allow commenting in Congrid system.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
noteId |
Filter by note that owns the comment |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
noteTypeId |
Fetch all items that are the given note type |
string |
Query |
noteCid |
Filter by note that owns the comment |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
ID of the related Note. |
string |
Produces
-
application/json
Example HTTP request
Request path
/comments
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.2. POST /comments
Description
Comment object in Congrid system.
Comment objects can be linked to all objects that allow commenting in Congrid system.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
noteId |
ID of the related Note. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
ID of the related Note. |
string |
Produces
-
application/json
Example HTTP request
Request path
/comments
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.3. GET /comments/{id}
Description
Comment object in Congrid system.
Comment objects can be linked to all objects that allow commenting in Congrid system.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
ID of the related Note. |
string |
Produces
-
application/json
Example HTTP request
Request path
/comments/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.4. PUT /comments/{id}
Description
Comment object in Congrid system.
Comment objects can be linked to all objects that allow commenting in Congrid system.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
noteId |
ID of the related Note. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
ID of the related Note. |
string |
Produces
-
application/json
Example HTTP request
Request path
/comments/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.5. DELETE /comments/{id}
Description
Comment object in Congrid system.
Comment objects can be linked to all objects that allow commenting in Congrid system.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/comments/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.6. GET /events
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
noteId |
Fetch all items related to a given note |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
tags |
Fetch all items that contain a given tag |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/events
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.7. GET /events/{id}
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/events/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.8. GET /noteEvents
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
noteId |
Fetch all items related to a given note |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
tags |
Fetch all items that contain a given tag |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/noteEvents
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.9. POST /noteEvents
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/noteEvents
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.5.10. GET /noteEvents/{id}
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, UNLOCKED, COMPLETED, PENDING, LOCKED, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
Produces
-
application/json
Example HTTP request
Request path
/noteEvents/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.6. Files
2.6.1. GET /files
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
noteId |
Fetch all items related to a given note |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
tags |
Fetch all items that contain a given tag |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Example : |
string |
filename |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionIds |
Example : |
string |
listIds |
Example : |
string |
measurementIds |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
projectId |
Example : |
string |
tags |
Example : |
< string > array |
workActivityIds |
Example : |
string |
workSectionIds |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/files
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.6.2. GET /projects/{projectId}/files
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
noteId |
Fetch all items related to a given note |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
tags |
Fetch all items that contain a given tag |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Example : |
string |
filename |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionIds |
Example : |
string |
listIds |
Example : |
string |
measurementIds |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
projectId |
Example : |
string |
tags |
Example : |
< string > array |
workActivityIds |
Example : |
string |
workSectionIds |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/files
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7. Floor Plans
2.7.1. GET /floorPlanTypes
Description
This endpoint accesses all available floor plan types.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
name |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/floorPlanTypes
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"deletedAt" : "2020-01-01T00:00:00.000000Z"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.2. DELETE /projects/{projectId}/floorPlanSlug/{id}
Description
A floor plan object describes the metadata for a floor plan image. This metadata is used to map the floor plan to the correct location on the construction.
The floor plan has two important properties that require further explanation, namely the id
and slug
. The id uniquely identifies a floor plan metadata and floor plan image data combination. The slug on the other maps multiple versions a particular floor plan together.
What this means in practise is that you can update the floor plan image data without losing the old image data. In order to do this, POST a new floor plan with an existing slug
and the API will automatically handle the mapping.
Now if you ever need to resume an old floor plan version for a floor plan, you can use the id of the old floor plan to do it.
DELETE removes all versions of a floor plan with the given slug from the project.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/floorPlanSlug/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.3. GET /projects/{projectId}/floorPlans
Description
This endpoint accesses all floor plans from a project given as part of URL.
A floor plan object describes the metadata for a floor plan image. This metadata is used to map the floor plan to the correct location on the construction.
The floor plan has two important properties that require further explanation, namely the id
and slug
. The id uniquely identifies a floor plan metadata and floor plan image data combination. The slug on the other maps multiple versions a particular floor plan together.
What this means in practise is that you can update the floor plan image data without losing the old image data. In order to do this, POST a new floor plan with an existing slug
and the API will automatically handle the mapping.
Now if you ever need to resume an old floor plan version for a floor plan, you can use the id of the old floor plan to do it.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
slug |
Fetch all items whose slug contains a given string |
string |
Query |
availableForTiling |
Fetch all items that are available for tiling (availableForTiling=1) or that are not available for tiling (availableForTiling=0) |
string |
Query |
availableInApp |
Fetch all items that are available in application (availableInApp=1) or that are not available in application (availableInApp=0) |
string |
Query |
invalidFloorPlan |
Fetch all items with invalid floor plan (invalidFloorPlan=1) or with valid floor plan (invalidFloorPlan=0) |
string |
Query |
typeId |
Fetch all items with a given type |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
targetRecordId |
Fetch all items related to a given target record |
string |
Query |
maintenanceCycleId |
Fetch all items related to a given maintenance cycle |
string |
Query |
updatedVersionId |
Fetch all items related to a given floor plan |
string |
Query |
nextVersionId |
Fetch all items related to a given floor plan |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
availableForTiling |
Example : |
boolean |
availableInApp |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
downloadUrl |
Example : |
string |
floorPlanTypeId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
invalidFloorPlan |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nextVersionId |
Example : |
string |
projectId |
Example : |
string |
slug |
Floor plan slug. Floor plan slug is used to map different versions of a floor plan together. If two floor plans objects have the same slug that means those floor plans are actually two different versions of the same floor plan. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/floorPlans
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.4. POST /projects/{projectId}/floorPlans
Description
This endpoint accesses all floor plans from a project given as part of URL.
A floor plan object describes the metadata for a floor plan image. This metadata is used to map the floor plan to the correct location on the construction.
The floor plan has two important properties that require further explanation, namely the id
and slug
. The id uniquely identifies a floor plan metadata and floor plan image data combination. The slug on the other maps multiple versions a particular floor plan together.
What this means in practise is that you can update the floor plan image data without losing the old image data. In order to do this, POST a new floor plan with an existing slug
and the API will automatically handle the mapping.
Now if you ever need to resume an old floor plan version for a floor plan, you can use the id of the old floor plan to do it.
POST adds a new floor plan to the project.
Adding a floor plan to a project is a three step operation: 1) Create (POST) a new floor plan object (this step). 2) Upload (PUT) the floor plan data to Congrid platform using the uploadUrl property. 3) Inform (POST) Congrid platform once the data has been succesfully uploaded via the floor plan uploaded endpoint /projects/{projectId}/floorPlans/{floorPlanId}/uploaded
.
The response object for step 1 specifies the URL that should be used in step 2 to upload the floor plan data with a HTTP PUT.
The PUT request should specify the actual file of the floor plan. An example curl request for the PUT:
curl -X PUT -H "Content-Type: application/pdf" -T "floor-plan.pdf" "https://{the 'uploadUrl' from the POST response}"
To create a new version of an existing floor plan use this same end-point but set the slug property in the POST request to point to an existing floor plan slug.
Note
|
The uploadUrl property is only present in the POST response because it has a validity time which starts counting when the POST is performed. |
For more details see API documentation tutorial at https://docs.congrid.com.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
availableForTiling |
Example : |
boolean |
availableInApp |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
downloadUrl |
Example : |
string |
floorPlanTypeId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
invalidFloorPlan |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
nextVersionId |
Example : |
string |
projectId |
Example : |
string |
slug |
Floor plan slug. Floor plan slug is used to map different versions of a floor plan together. If two floor plans objects have the same slug that means those floor plans are actually two different versions of the same floor plan. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
availableForTiling |
Example : |
boolean |
availableInApp |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
downloadUrl |
Example : |
string |
floorPlanTypeId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
invalidFloorPlan |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nextVersionId |
Example : |
string |
projectId |
Example : |
string |
slug |
Floor plan slug. Floor plan slug is used to map different versions of a floor plan together. If two floor plans objects have the same slug that means those floor plans are actually two different versions of the same floor plan. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/floorPlans
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.5. POST /projects/{projectId}/floorPlans/{floorPlanId}/uploaded
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
floorPlanId |
string |
|
Body |
Post data |
Object to create |
object |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
object |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/floorPlans/string/uploaded
Request body
{ }
Example HTTP response
Response 200
"object"
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.6. GET /projects/{projectId}/floorPlans/{id}
Description
This endpoint accesses all floor plans from a project given as part of URL.
A floor plan object describes the metadata for a floor plan image. This metadata is used to map the floor plan to the correct location on the construction.
The floor plan has two important properties that require further explanation, namely the id
and slug
. The id uniquely identifies a floor plan metadata and floor plan image data combination. The slug on the other maps multiple versions a particular floor plan together.
What this means in practise is that you can update the floor plan image data without losing the old image data. In order to do this, POST a new floor plan with an existing slug
and the API will automatically handle the mapping.
Now if you ever need to resume an old floor plan version for a floor plan, you can use the id of the old floor plan to do it.
GET returns all the floor plans of the project. By default this end-point returns all the versions of all floor plans. Use the optional active
query parameter to fetch only the latest versions of each floor plan. Use the optional slugId
query parameter to only retrieve floor plans with a specific slug. This is equal to returning all versions of a particular floor plan.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
availableForTiling |
Example : |
boolean |
availableInApp |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
downloadUrl |
Example : |
string |
floorPlanTypeId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
invalidFloorPlan |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nextVersionId |
Example : |
string |
projectId |
Example : |
string |
signedUploadPost |
Example : |
string |
slug |
Floor plan slug. Floor plan slug is used to map different versions of a floor plan together. If two floor plans objects have the same slug that means those floor plans are actually two different versions of the same floor plan. |
string |
uploadUrl |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/floorPlans/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.7. PUT /projects/{projectId}/floorPlans/{id}
Description
This endpoint accesses all floor plans from a project given as part of URL.
A floor plan object describes the metadata for a floor plan image. This metadata is used to map the floor plan to the correct location on the construction.
The floor plan has two important properties that require further explanation, namely the id
and slug
. The id uniquely identifies a floor plan metadata and floor plan image data combination. The slug on the other maps multiple versions a particular floor plan together.
What this means in practise is that you can update the floor plan image data without losing the old image data. In order to do this, POST a new floor plan with an existing slug
and the API will automatically handle the mapping.
Now if you ever need to resume an old floor plan version for a floor plan, you can use the id of the old floor plan to do it.
PUT updates floor plan metadata.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
availableForTiling |
Example : |
boolean |
availableInApp |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
downloadUrl |
Example : |
string |
floorPlanTypeId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
invalidFloorPlan |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
nextVersionId |
Example : |
string |
projectId |
Example : |
string |
signedUploadPost |
Example : |
string |
slug |
Floor plan slug. Floor plan slug is used to map different versions of a floor plan together. If two floor plans objects have the same slug that means those floor plans are actually two different versions of the same floor plan. |
string |
uploadUrl |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
availableForTiling |
Example : |
boolean |
availableInApp |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
downloadUrl |
Example : |
string |
floorPlanTypeId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
invalidFloorPlan |
Example : |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nextVersionId |
Example : |
string |
projectId |
Example : |
string |
signedUploadPost |
Example : |
string |
slug |
Floor plan slug. Floor plan slug is used to map different versions of a floor plan together. If two floor plans objects have the same slug that means those floor plans are actually two different versions of the same floor plan. |
string |
uploadUrl |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/floorPlans/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.8. DELETE /projects/{projectId}/floorPlans/{id}
Description
This endpoint accesses all floor plans from a project given as part of URL.
A floor plan object describes the metadata for a floor plan image. This metadata is used to map the floor plan to the correct location on the construction.
The floor plan has two important properties that require further explanation, namely the id
and slug
. The id uniquely identifies a floor plan metadata and floor plan image data combination. The slug on the other maps multiple versions a particular floor plan together.
What this means in practise is that you can update the floor plan image data without losing the old image data. In order to do this, POST a new floor plan with an existing slug
and the API will automatically handle the mapping.
Now if you ever need to resume an old floor plan version for a floor plan, you can use the id of the old floor plan to do it.
DELETE removes a floor plan version from the project. To remove all the versions of a floor plan use floorPlanSlug
-endpoint.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/floorPlans/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.9. GET /projects/{projectId}/targetFloorPlans
Description
This endpoint accesses all floor plan targets from a project given as part of URL.
This object specifies a floor plan to target mapping. The mapping is Many-To-Many by nature which means that one target can have many floor plans associated with it and vice versa. A target does not need to have a floor plan associated with it, and nor does a floor plan need to be associated with any target.
GET returns all the target to floor plan mappings.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
floorPlanId |
Fetch all items related to a given floor plan |
string |
Query |
targetId |
Fetch all items related to a given target |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
floorPlanId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
targetId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targetFloorPlans
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ "object" ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.10. POST /projects/{projectId}/targetFloorPlans
Description
This endpoint accesses all floor plan targets from a project given as part of URL.
This object specifies a floor plan to target mapping. The mapping is Many-To-Many by nature which means that one target can have many floor plans associated with it and vice versa. A target does not need to have a floor plan associated with it, and nor does a floor plan need to be associated with any target.
POST creates a new floor plan to target mapping. To update or remove this mapping, use the returned id
in the followup requests
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
floorPlanId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
targetId |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
floorPlanId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
targetId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targetFloorPlans
Request body
{
"floorPlanId" : "string",
"id" : "string",
"targetId" : "string"
}
Example HTTP response
Response 201
"object"
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.11. GET /projects/{projectId}/targetFloorPlans/{id}
Description
This endpoint accesses all floor plan targets from a project given as part of URL.
This object specifies a floor plan to target mapping. The mapping is Many-To-Many by nature which means that one target can have many floor plans associated with it and vice versa. A target does not need to have a floor plan associated with it, and nor does a floor plan need to be associated with any target.
GET returns a single target to floor plan mapping
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
floorPlanId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
targetId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targetFloorPlans/string
Example HTTP response
Response 200
"object"
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.12. PUT /projects/{projectId}/targetFloorPlans/{id}
Description
This endpoint accesses all floor plan targets from a project given as part of URL.
This object specifies a floor plan to target mapping. The mapping is Many-To-Many by nature which means that one target can have many floor plans associated with it and vice versa. A target does not need to have a floor plan associated with it, and nor does a floor plan need to be associated with any target.
PUT updates a target floor plan mapping.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
floorPlanId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
targetId |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
floorPlanId |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
targetId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targetFloorPlans/string
Request body
{
"floorPlanId" : "string",
"id" : "string",
"targetId" : "string"
}
Example HTTP response
Response 200
"object"
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.7.13. DELETE /projects/{projectId}/targetFloorPlans/{id}
Description
This endpoint accesses all floor plan targets from a project given as part of URL.
This object specifies a floor plan to target mapping. The mapping is Many-To-Many by nature which means that one target can have many floor plans associated with it and vice versa. A target does not need to have a floor plan associated with it, and nor does a floor plan need to be associated with any target.
DELETE removes a single target to floor plan mapping. Removing the mapping does NOT remove the floor plan or the target.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targetFloorPlans/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8. Measurements
2.8.1. GET /inspectionTopicDetailResults
Description
Inspection topic detail describes a detail which is part of a topic.
GET retrieves all inspection topic details related to a inspection.
Use the optional inspectionId
query parameter to get all the inspection topics related to a particular inspection.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
inspectionId |
Fetch all items related to a given inspection |
string |
Query |
topicId |
Fetch all items related to a given topic |
string |
Query |
detailId |
Fetch all items related to a given detail |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
detailId |
ID of the related detail. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
topicId |
ID of the related detail. |
string |
value |
Measured value from the inspection for the detail. |
number |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopicDetailResults
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.2. GET /inspectionTopicDetailResults/{id}
Description
Inspection topic detail describes a detail which is part of a topic.
GET returns one single inspection topic detail by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
detailId |
ID of the related detail. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
topicId |
ID of the related detail. |
string |
value |
Measured value from the inspection for the detail. |
number |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopicDetailResults/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.3. GET /inspectionTopicDetails
Description
Inspection topic detail describes a detail which is part of a topic.
GET retrieves all inspection topic details related to a inspection.
Use the optional inspectionId
query parameter to get all the inspection topics related to a particular inspection.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
inspectionId |
Fetch all items related to a given inspection |
string |
Query |
topicId |
Fetch all items related to a given topic |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
targetValue |
Target value. |
number |
targetValueUnit |
Target value unit. |
string |
toleranceMinus |
Tolerance below the target value. |
number |
tolerancePlus |
Tolerance above the target value. |
number |
topicId |
ID of the related topic. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopicDetails
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.4. GET /inspectionTopicDetails/{id}
Description
Inspection topic detail describes a detail which is part of a topic.
GET returns one single inspection topic detail by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
targetValue |
Target value. |
number |
targetValueUnit |
Target value unit. |
string |
toleranceMinus |
Tolerance below the target value. |
number |
tolerancePlus |
Tolerance above the target value. |
number |
topicId |
ID of the related topic. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopicDetails/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.5. GET /inspectionTopics
Description
Measurement topic describes a topic which is part of a measurement.
GET retrieves all measurement topics related to a measurement.
Use the optional measurementId
query parameter to get all the measurement topics related to a particular measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
inspectionId |
Fetch all items related to a given inspection |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopics
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.6. POST /inspectionTopics
Description
Measurement topic describes a topic which is part of a measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopics
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.7. GET /inspectionTopics/{id}
Description
Measurement topic describes a topic which is part of a measurement.
GET returns one single measurement topic by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopics/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.8. PUT /inspectionTopics/{id}
Description
Measurement topic describes a topic which is part of a measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopics/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.9. DELETE /inspectionTopics/{id}
Description
Measurement topic describes a topic which is part of a measurement.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopics/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.10. GET /inspections
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
isCombinedMeasurement |
Fetch items that are combined of multiple measurements. Filter can be used to fetch all measurements that created by combining multiple measurements. If set to true (1), filter returns all measurements that are created by combining multiple measurements. |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
workSectionId |
Fetch all items related to a given work section |
string |
Query |
workActivityId |
Fetch all items related to a given work activity |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
matrixCellId |
Fetch all items related to a given matrix cell |
string |
Query |
measurementCategoryId |
Fetch all items with a given measurement category |
string |
Query |
objectTypeId |
Fetch all items with a given object type |
string |
Query |
listTypeId |
Fetch all items with a given list type |
string |
Query |
measurementTypeId |
Fetch all items with a given measurement type |
string |
Query |
inspectionTypeId |
Fetch all items with a given inspection type |
string |
Query |
statusId |
Fetch all items with a given status |
string |
Query |
languageIds |
Fetch all items that match with all given language tags (one or more) |
string |
Query |
isCompleteMeasurement |
Fetch items that are complete measurements. Either complete by itself or complete combination of multiple partial measurements. Filter can be used to fetch all measurements that are only part of a combined measurements. If set false (0), filter returns only measurements that are sub-set of a combined measurements. All complete measurements are excluded. If set to true (1), filter returns all measurements that are complete measurements. I.e all partial measurements are excluded. If set to true also all measurements that are formed by combining sub-measurements are included. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionCategoryId |
Inspection category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
inspectionTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspections
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.11. POST /inspections
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
POST creates or imports a new measurement to Congrid system. The API expects the imported measurements to be final ones and hence those are automatically completed. Additionally all the negative notes that are automatically generated from the minusCount
value are marked as "Accepted".
To create a new measurement in Congrid the API user needs to know the relevant templateId
values for both the measurement and the measurement topics. A company usually has multiple templates and those can be further customised per project if needed. Hence the API cannot make the decision to which template to map the new measurement but this needs to be done by the API user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionCategoryId |
Inspection category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
inspectionTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name of the object. |
string |
projectCode |
Example : |
string |
projectId |
Example : |
string |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionCategoryId |
Inspection category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
inspectionTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspections
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.12. GET /inspections/{id}
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Returns one single measurement by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionCategoryId |
Inspection category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
inspectionTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspections/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.13. PUT /inspections/{id}
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionCategoryId |
Inspection category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
inspectionTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name of the object. |
string |
projectCode |
Example : |
string |
projectId |
Example : |
string |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionCategoryId |
Inspection category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
inspectionTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionId |
Measurement ID of parent measurement. This is same as "measurementId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementId" and to be deprecated. Developers should use "measurementId" instead. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
statusId |
Status value for the measurement topic. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
topicCode |
User settable string of data for measurement topic. Topic code is visible for user as part of measurement topic’s title, so it can be used for numbering titles. for example "1", "1a", "1b", "2"… This field does not determine how measurement topic titles are sorted. For that use "uiOrderNumber" property. Example: if we have measurement topics: 1a The first item 1b The second item 2 The third item Then topic codes should be "1a", "1b" and "2". The ordering is defined by "uiOrderNumber" and matching uiOrderNumbers should be 1, 2, 3. 1a The first item --> Topic code: 1a, UI order number: 1 1b The second item --> Topic code: 1b, UI order number: 2 2 The third item --> Topic code: 2, UI order number: 3 This is eventually replacing "orderNumber" property, so prefer to use this in your API. |
string |
uiOrderNumber |
UI order number for measurement topic. For more details see "orderNumber" property Users don’t see UI order number but only the "orderNumber". |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspections/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.14. DELETE /inspections/{id}
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/inspections/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.15. GET /lists
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
isCombinedMeasurement |
Fetch items that are combined of multiple measurements. Filter can be used to fetch all measurements that created by combining multiple measurements. If set to true (1), filter returns all measurements that are created by combining multiple measurements. |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
workSectionId |
Fetch all items related to a given work section |
string |
Query |
workActivityId |
Fetch all items related to a given work activity |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
matrixCellId |
Fetch all items related to a given matrix cell |
string |
Query |
measurementCategoryId |
Fetch all items with a given measurement category |
string |
Query |
objectTypeId |
Fetch all items with a given object type |
string |
Query |
listTypeId |
Fetch all items with a given list type |
string |
Query |
measurementTypeId |
Fetch all items with a given measurement type |
string |
Query |
inspectionTypeId |
Fetch all items with a given inspection type |
string |
Query |
statusId |
Fetch all items with a given status |
string |
Query |
languageIds |
Fetch all items that match with all given language tags (one or more) |
string |
Query |
isCompleteMeasurement |
Fetch items that are complete measurements. Either complete by itself or complete combination of multiple partial measurements. Filter can be used to fetch all measurements that are only part of a combined measurements. If set false (0), filter returns only measurements that are sub-set of a combined measurements. All complete measurements are excluded. If set to true (1), filter returns all measurements that are complete measurements. I.e all partial measurements are excluded. If set to true also all measurements that are formed by combining sub-measurements are included. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
displayId |
Visible ID for the measurement. Each object has always system level unique ID. In addition measurements have ID that is visible for the user. That is id called "display ID". |
string |
displayName |
Name for the object. Display name is auto-generated from object data and is read-only. You can change other object properties that affect "display name", but you cannot set it directly. |
string |
id |
Unique ID for the object given by backend server. |
string |
matrixDisplayName |
Example : |
string |
matrixId |
Example : |
string |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
name |
Name of the object. |
string |
projectId |
Example : |
string |
workActivityDisplayName |
Example : |
string |
workActivityId |
Example : |
string |
workSectionDisplayName |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/lists
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.16. POST /lists
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
POST creates or imports a new measurement to Congrid system. The API expects the imported measurements to be final ones and hence those are automatically completed. Additionally all the negative notes that are automatically generated from the minusCount
value are marked as "Accepted".
To create a new measurement in Congrid the API user needs to know the relevant templateId
values for both the measurement and the measurement topics. A company usually has multiple templates and those can be further customised per project if needed. Hence the API cannot make the decision to which template to map the new measurement but this needs to be done by the API user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
displayId |
Visible ID for the measurement. Each object has always system level unique ID. In addition measurements have ID that is visible for the user. That is id called "display ID". |
string |
id |
Unique ID for the object given by backend server. |
string |
matrixDisplayName |
Example : |
string |
matrixId |
Example : |
string |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
name |
Name of the object. |
string |
projectId |
Example : |
string |
workActivityDisplayName |
Example : |
string |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
displayId |
Visible ID for the measurement. Each object has always system level unique ID. In addition measurements have ID that is visible for the user. That is id called "display ID". |
string |
displayName |
Name for the object. Display name is auto-generated from object data and is read-only. You can change other object properties that affect "display name", but you cannot set it directly. |
string |
id |
Unique ID for the object given by backend server. |
string |
matrixDisplayName |
Example : |
string |
matrixId |
Example : |
string |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
name |
Name of the object. |
string |
projectId |
Example : |
string |
workActivityDisplayName |
Example : |
string |
workActivityId |
Example : |
string |
workSectionDisplayName |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/lists
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.17. GET /lists/{id}
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Returns one single measurement by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
displayId |
Visible ID for the measurement. Each object has always system level unique ID. In addition measurements have ID that is visible for the user. That is id called "display ID". |
string |
displayName |
Name for the object. Display name is auto-generated from object data and is read-only. You can change other object properties that affect "display name", but you cannot set it directly. |
string |
id |
Unique ID for the object given by backend server. |
string |
matrixDisplayName |
Example : |
string |
matrixId |
Example : |
string |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
name |
Name of the object. |
string |
projectId |
Example : |
string |
workActivityDisplayName |
Example : |
string |
workActivityId |
Example : |
string |
workSectionDisplayName |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/lists/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.18. PUT /lists/{id}
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
displayId |
Visible ID for the measurement. Each object has always system level unique ID. In addition measurements have ID that is visible for the user. That is id called "display ID". |
string |
id |
Unique ID for the object given by backend server. |
string |
matrixDisplayName |
Example : |
string |
matrixId |
Example : |
string |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
name |
Name of the object. |
string |
projectId |
Example : |
string |
workActivityDisplayName |
Example : |
string |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
displayId |
Visible ID for the measurement. Each object has always system level unique ID. In addition measurements have ID that is visible for the user. That is id called "display ID". |
string |
displayName |
Name for the object. Display name is auto-generated from object data and is read-only. You can change other object properties that affect "display name", but you cannot set it directly. |
string |
id |
Unique ID for the object given by backend server. |
string |
matrixDisplayName |
Example : |
string |
matrixId |
Example : |
string |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
modifiedByDisplayName |
Object’s last modifier’s full name. |
string |
modifiedByFullName |
Object’s last modifier’s full name. |
string |
name |
Name of the object. |
string |
projectId |
Example : |
string |
workActivityDisplayName |
Example : |
string |
workActivityId |
Example : |
string |
workSectionDisplayName |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/lists/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"modifiedByDisplayName" : "First name Last name",
"modifiedByFullName" : "First name Last name"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.19. DELETE /lists/{id}
Description
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/lists/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.20. GET /measurementTopics
Description
This endpoint accesses all measurement topics from all projects and measurements.
Measurement topic describes a topic which is part of a measurement.
GET retrieves all measurement topics related to a measurement.
Use the optional measurementId
query parameter to get all the measurement topics related to a particular measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
inspectionId |
Fetch all items related to a given inspection |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopics
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.21. POST /measurementTopics
Description
This endpoint accesses all measurement topics from all projects and measurements.
Measurement topic describes a topic which is part of a measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopics
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.22. GET /measurementTopics/{id}
Description
This endpoint accesses all measurement topics from all projects and measurements.
Measurement topic describes a topic which is part of a measurement.
GET returns one single measurement topic by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopics/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.23. PUT /measurementTopics/{id}
Description
This endpoint accesses all measurement topics from all projects and measurements.
Measurement topic describes a topic which is part of a measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopics/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.24. DELETE /measurementTopics/{id}
Description
This endpoint accesses all measurement topics from all projects and measurements.
Measurement topic describes a topic which is part of a measurement.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopics/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.25. GET /measurements
Description
This endpoint accesses all measurements from all projects.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
isCombinedMeasurement |
Fetch items that are combined of multiple measurements. Filter can be used to fetch all measurements that created by combining multiple measurements. If set to true (1), filter returns all measurements that are created by combining multiple measurements. |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
workSectionId |
Fetch all items related to a given work section |
string |
Query |
workActivityId |
Fetch all items related to a given work activity |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
matrixCellId |
Fetch all items related to a given matrix cell |
string |
Query |
measurementCategoryId |
Fetch all items with a given measurement category |
string |
Query |
objectTypeId |
Fetch all items with a given object type |
string |
Query |
listTypeId |
Fetch all items with a given list type |
string |
Query |
measurementTypeId |
Fetch all items with a given measurement type |
string |
Query |
inspectionTypeId |
Fetch all items with a given inspection type |
string |
Query |
statusId |
Fetch all items with a given status |
string |
Query |
languageIds |
Fetch all items that match with all given language tags (one or more) |
string |
Query |
isCompleteMeasurement |
Fetch items that are complete measurements. Either complete by itself or complete combination of multiple partial measurements. Filter can be used to fetch all measurements that are only part of a combined measurements. If set false (0), filter returns only measurements that are sub-set of a combined measurements. All complete measurements are excluded. If set to true (1), filter returns all measurements that are complete measurements. I.e all partial measurements are excluded. If set to true also all measurements that are formed by combining sub-measurements are included. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/measurements
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.26. POST /measurements
Description
This endpoint accesses all measurements from all projects.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
POST creates or imports a new measurement to Congrid system. The API expects the imported measurements to be final ones and hence those are automatically completed. Additionally all the negative notes that are automatically generated from the minusCount
value are marked as "Accepted".
To create a new measurement in Congrid the API user needs to know the relevant templateId
values for both the measurement and the measurement topics. A company usually has multiple templates and those can be further customised per project if needed. Hence the API cannot make the decision to which template to map the new measurement but this needs to be done by the API user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/measurements
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.27. GET /measurements/{id}
Description
This endpoint accesses all measurements from all projects.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Returns one single measurement by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/measurements/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.28. PUT /measurements/{id}
Description
This endpoint accesses all measurements from all projects.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/measurements/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.29. DELETE /measurements/{id}
Description
This endpoint accesses all measurements from all projects.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/measurements/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.30. GET /projects/{projectId}/measurements
Description
This endpoint accesses all the measurements from a project given as part of URL.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
isCombinedMeasurement |
Fetch items that are combined of multiple measurements. Filter can be used to fetch all measurements that created by combining multiple measurements. If set to true (1), filter returns all measurements that are created by combining multiple measurements. |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
workSectionId |
Fetch all items related to a given work section |
string |
Query |
workActivityId |
Fetch all items related to a given work activity |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
matrixCellId |
Fetch all items related to a given matrix cell |
string |
Query |
measurementCategoryId |
Fetch all items with a given measurement category |
string |
Query |
objectTypeId |
Fetch all items with a given object type |
string |
Query |
listTypeId |
Fetch all items with a given list type |
string |
Query |
measurementTypeId |
Fetch all items with a given measurement type |
string |
Query |
inspectionTypeId |
Fetch all items with a given inspection type |
string |
Query |
statusId |
Fetch all items with a given status |
string |
Query |
languageIds |
Fetch all items that match with all given language tags (one or more) |
string |
Query |
isCompleteMeasurement |
Fetch items that are complete measurements. Either complete by itself or complete combination of multiple partial measurements. Filter can be used to fetch all measurements that are only part of a combined measurements. If set false (0), filter returns only measurements that are sub-set of a combined measurements. All complete measurements are excluded. If set to true (1), filter returns all measurements that are complete measurements. I.e all partial measurements are excluded. If set to true also all measurements that are formed by combining sub-measurements are included. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/measurements
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.31. POST /projects/{projectId}/measurements
Description
This endpoint accesses all the measurements from a project given as part of URL.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
POST creates or imports a new measurement to Congrid system. The API expects the imported measurements to be final ones and hence those are automatically completed. Additionally all the negative notes that are automatically generated from the minusCount
value are marked as "Accepted".
To create a new measurement in Congrid the API user needs to know the relevant templateId
values for both the measurement and the measurement topics. A company usually has multiple templates and those can be further customised per project if needed. Hence the API cannot make the decision to which template to map the new measurement but this needs to be done by the API user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/measurements
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.32. GET /projects/{projectId}/measurements/{id}
Description
This endpoint accesses all the measurements from a project given as part of URL.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Returns one single measurement by its unique id.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/measurements/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.33. PUT /projects/{projectId}/measurements/{id}
Description
This endpoint accesses all the measurements from a project given as part of URL.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
acceptors |
Example : |
< acceptors > array |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByApp |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
events |
Example : |
< events > array |
id |
Unique ID for the object given by backend server. |
string |
isCombinedMeasurement |
Boolean defines if measurement object is a combination of multiple measurements. |
boolean |
measurementCategoryId |
Measurement category for the object. Measurement / inspection category is used to separate internal and external measurements. Also other categories, like "competition", exists. External measurements are often calibration measurements and they are handled differently in analytics. |
enum (COMPETITION, INTERNAL, EXTERNAL) |
measurementId |
Example : |
string |
measurementTypeId |
Type of the object. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the object. |
string |
parentMeasurementId |
Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination. |
string |
participants |
Example : |
< participants > array |
projectCode |
Example : |
string |
projectId |
Example : |
string |
projectName |
Example : |
string |
result |
Result (percentage) of the measurement. Measurement result is calculated from all measurement topics. The complete number of plus and minus points is calculated from all topics. Multipliers are taken into account. |
number |
statusId |
Status of the object. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
Example : |
string |
templateId |
Example : |
string |
topics |
Example : |
< topics > array |
weekNumber |
Week number when the measurement was done as set by user. Value is set automatically and user can change it if needed. Value defines what week the measurement belongs to. The actual time when measurement was made is in "createdAt" property. |
integer |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
year |
Year when measurement was done. The complete create timestamp can be found from "createdAt" property. |
integer |
acceptors
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
eventTypeId |
Event type ID for the event. |
enum (CHANGED_GROUP, CHANGED_COMMENTS, ENTRY_MARKED_LOCKED, UNDELETED, MAINTENANCE_RECORD_MARKED_PENDING, CHANGED_RESULT, CHANGED_IS_STATUS_MANDATORY, CHANGED_DESCRIPTION, CHANGED_IS_CONTACTS_ENABLED, CHANGED_ACCEPTORS, CREATED_REPORT, CHANGED_PARENT, MAINTENANCE_RECORD_INVITE_TRIGGER, CHANGED_POSITIVE_MULTIPLIER, CHANGED_PLUS_COUNT, CHANGED_WORK_SECTION, CHANGED_IS_NOTES_ENABLED, CHANGED_IS_STATUS_ENABLED, MARKED_REJECTED, MAINTENANCE_MESSAGE, CHANGED_IS_COMBINED, CHANGED_ENABLED_STATUS_VALUES, CHANGED_REQUIRED_ACTION, CHANGED_GROUP_TEMPLATE, ENTRY_CREATED, CHANGED_RESPONSIBLE, CHANGED_IS_COMMENTS_ENABLED, CHANGED_ORDER_STRING, MARKED_COMPLETE, CHANGED_SPECIAL_REMARK, MARKED_PENDING, CHANGED_NAME, MAINTENANCE_CUSTOMER_CONTACT, EMAIL_SENT, ENTRY_MARKED_UNLOCKED, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_ENABLED_NOTE_CLASSES, CHANGED_TEMPLATE, MARKED_WIP, CHANGED_IS_FILES_ENABLED, CHANGED_OBSERVED_AT, CHANGED_NEGATIVE_MULTIPLIER, CHANGED_AVAILABLE_FOR_COMPANY, CHANGED_TARGET_DESCRIPTION, MARKED_VERIFIED, MAINTENANCE_RECORD_MARKED_ACCEPTED, CHANGED_TARGET, CHANGED_PARTICIPANTS, MAINTENANCE_RECORD_REPORT, CHANGED_AVAILABLE_FOR_ALL, CHANGED_TYPE, CHANGED_MEASUREMENT, MARKED_CANNOT_MEASURE, CHANGED_TOPIC_CODE, ENTRY_MARKED_ACCEPTED, MARKED_RECEIVED, CHANGED_NOTE_DYNAMIC_DATA, MARKED_NOT_APPLICABLE, CHANGED_ASSIGNED_TO_USER, MARKED_ACCEPTED, CHANGED_UI_ORDER_STRING, CHANGED_COMPLETED, DELETED, SEND_REPORT, MARKED_INCOMPLETE, CHANGED_STATUS, MAINTENANCE_RECORD_INVITE_PROCESSED, CHANGED_REQUIRED_ACTION_LEVEL) |
id |
Unique ID for the object given by backend server. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (False, RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, TRUE, WIP, True, FALSE, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
participants
Name | Description | Schema |
---|---|---|
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementId |
Measurement ID of owner measurement object. |
string |
name |
Name for the object. |
string |
topics
Name | Description | Schema |
---|---|---|
comments |
Comments for the measurement topic. |
string |
correlationId |
Correlation-Id of UUID4-format that can be given by client side to in data syncing situations. Difference to "Id" is that id is given by backend server. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isCommentsEnabled |
Flag for defining if measurement topic comments are enabled when making the measurement. |
boolean |
measurementId |
Measurement ID of parent measurement. |
string |
minusCount |
Minus count is used for measurement result calculation. Minus count is calculated from amount of notes that are linked to measurement topic. |
integer |
minusCountWeighted |
Minus count weighted is used for measurement result calculation. Minus count is weighted is taking all multipliers into account where as plain "minusCount" value is not including weighted multipliers. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic. |
string |
negativeMultiplier |
Negative multiplier for measurement topic. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topics when rendering measurement. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
plusCount |
Plus count is used for measurement result calculation. |
integer |
plusCountWeighted |
Plus count weighted is used for measurement result calculation. Plus count is weighted is taking all multipliers into account where as plain "plusCount" value is not including weighted multipliers. |
integer |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
result |
Final result for the measurement topic. |
number |
templateId |
Topic template ID of parent topic template that was used as a base for the object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/measurements/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.8.34. DELETE /projects/{projectId}/measurements/{id}
Description
This endpoint accesses all the measurements from a project given as part of URL.
Measurement object describes a safety measurement in Congrid system. After a measurement has been conducted it is marked as completed and a result for the measurement can be calculted. The measurement object contains this result with some additional meta data that is useful for post-processing.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/measurements/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9. Notes
2.9.1. GET /impacts
Description
Note can have Impact to project in form of gained/lost money and delays in schedules.
Positive values are negative impacts, eg impact of "currencyValue=1000000" = +1000EUR = project costs grew 1000 EUR. Negative values are positive impacts, eg impact of "durationMs=-86400000" = -1 day = project duration shrank 1 day.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
noteId |
Filter by note that is subject to relation of given type (blocked, parent, related). |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
Produces
-
application/json
Example HTTP request
Request path
/impacts
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"durationMs" : 86400000,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"moneyCurrencyId" : "EUR",
"moneyCurrencyValue" : 1235000
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.2. POST /impacts
Description
Note can have Impact to project in form of gained/lost money and delays in schedules.
Positive values are negative impacts, eg impact of "currencyValue=1000000" = +1000EUR = project costs grew 1000 EUR. Negative values are positive impacts, eg impact of "durationMs=-86400000" = -1 day = project duration shrank 1 day.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
Produces
-
application/json
Example HTTP request
Request path
/impacts
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"durationMs" : 86400000,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"moneyCurrencyId" : "EUR",
"moneyCurrencyValue" : 1235000
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"durationMs" : 86400000,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"moneyCurrencyId" : "EUR",
"moneyCurrencyValue" : 1235000
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.3. GET /impacts/{id}
Description
Note can have Impact to project in form of gained/lost money and delays in schedules.
Positive values are negative impacts, eg impact of "currencyValue=1000000" = +1000EUR = project costs grew 1000 EUR. Negative values are positive impacts, eg impact of "durationMs=-86400000" = -1 day = project duration shrank 1 day.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
Produces
-
application/json
Example HTTP request
Request path
/impacts/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"durationMs" : 86400000,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"moneyCurrencyId" : "EUR",
"moneyCurrencyValue" : 1235000
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.4. PUT /impacts/{id}
Description
Note can have Impact to project in form of gained/lost money and delays in schedules.
Positive values are negative impacts, eg impact of "currencyValue=1000000" = +1000EUR = project costs grew 1000 EUR. Negative values are positive impacts, eg impact of "durationMs=-86400000" = -1 day = project duration shrank 1 day.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
Produces
-
application/json
Example HTTP request
Request path
/impacts/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"durationMs" : 86400000,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"moneyCurrencyId" : "EUR",
"moneyCurrencyValue" : 1235000
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"durationMs" : 86400000,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"moneyCurrencyId" : "EUR",
"moneyCurrencyValue" : 1235000
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.5. DELETE /impacts/{id}
Description
Note can have Impact to project in form of gained/lost money and delays in schedules.
Positive values are negative impacts, eg impact of "currencyValue=1000000" = +1000EUR = project costs grew 1000 EUR. Negative values are positive impacts, eg impact of "durationMs=-86400000" = -1 day = project duration shrank 1 day.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/impacts/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.6. GET /noteTemplates
Description
Note templates (a.k.a. dynamic forms) are used to define what properties notes have.
Templates define what properties users can set for the note. They define what properties are shown. All notes have all properties in API and in system database, but template limits which of those field are usable.
To put it simply, templates make note properties dynamic.
Note templates are defines on three levels: system level, company level and system level. System level templates are visible for all projects in the system. Company level templates are usable in projects that are owned by particular company. And, project level templates are usable in owner company only.
Template types and classes follow note types and classes. Each type and note pair can have own templates. When creating new note, type and class of the note defines what template is used.
Each note object refers to one note template. It’s the template that was used to create the note. Related note template can be found from the note property formId
. Further, dynamic attributes defined by note template are stored in note property formAttributes
.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
level |
Level of the note template. Note templates are defines on three levels: system level, company level and system level. System level templates are visible for all projects in the system. Company level templates are usable in projects that are owned by particular company. And, project level templates are usable in owner company only. |
string |
Query |
availableForProjectId |
Boolean that defines if note template is available for given project ID. Availability of the note template is defined by note template level. |
string |
Query |
availableForCompanyId |
Boolean that defines if note template is available for given company ID. Availability of the note template is defined by note template level. |
string |
Query |
noteTypeId |
Get all note templates with a given note type. |
string |
Query |
noteClassId |
Get all note templates with a given note class. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyId |
Company ID for the company that owns the template. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isActiveForCurrentProject |
Boolean to define if template is enabled for the project that is used as a context for the request. |
string |
isEnabled |
Boolean to define if template is enabled. Disabled templates are returned from API, but they are not available for users to create new notes. Property can be used e.g. when creating a new template and we don’t want template to be used yet. |
boolean |
language |
Template lanugage. |
string |
level |
Template UI schema. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for the template. Name is visible for the end-user. |
string |
noteClassId |
Template note class. Note class refers to note class as defined for notes. Template note class sets the note class when a note is created using template. Together with 'objectType' note class defines the base type of created note. |
enum (TASK, DOCUMENTATION, NOTIFICATION, POSITIVE) |
objectType |
Template note type. Type refers to note types. Template type sets the note type when a note is created using template. Together with 'noteClassId' note class defines the base type of created note. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
originalProjectId |
Project ID for the project that owns the template. |
string |
projectId |
Project ID for the context where the template is used. |
string |
schemaData |
Template data schema. |
string |
schemaUi |
Template UI schema. |
string |
translations |
Translations for other fields in this object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/noteTemplates
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.7. GET /noteTemplates/{id}
Description
Note templates (a.k.a. dynamic forms) are used to define what properties notes have.
Templates define what properties users can set for the note. They define what properties are shown. All notes have all properties in API and in system database, but template limits which of those field are usable.
To put it simply, templates make note properties dynamic.
Note templates are defines on three levels: system level, company level and system level. System level templates are visible for all projects in the system. Company level templates are usable in projects that are owned by particular company. And, project level templates are usable in owner company only.
Template types and classes follow note types and classes. Each type and note pair can have own templates. When creating new note, type and class of the note defines what template is used.
Each note object refers to one note template. It’s the template that was used to create the note. Related note template can be found from the note property formId
. Further, dynamic attributes defined by note template are stored in note property formAttributes
.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Company ID for the company that owns the template. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isActiveForCurrentProject |
Boolean to define if template is enabled for the project that is used as a context for the request. |
string |
isEnabled |
Boolean to define if template is enabled. Disabled templates are returned from API, but they are not available for users to create new notes. Property can be used e.g. when creating a new template and we don’t want template to be used yet. |
boolean |
language |
Template lanugage. |
string |
level |
Template UI schema. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for the template. Name is visible for the end-user. |
string |
noteClassId |
Template note class. Note class refers to note class as defined for notes. Template note class sets the note class when a note is created using template. Together with 'objectType' note class defines the base type of created note. |
enum (TASK, DOCUMENTATION, NOTIFICATION, POSITIVE) |
objectType |
Template note type. Type refers to note types. Template type sets the note type when a note is created using template. Together with 'noteClassId' note class defines the base type of created note. |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
originalProjectId |
Project ID for the project that owns the template. |
string |
projectId |
Project ID for the context where the template is used. |
string |
schemaData |
Template data schema. |
string |
schemaUi |
Template UI schema. |
string |
translations |
Translations for other fields in this object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/noteTemplates/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.8. GET /notes
Description
Notes can be attached to different types of entites in Congrid system. Depending on the type of the note the listId
, measurementId
, measurementTopicId
, inspectionId
and inspectionTopicId
(and other) properties in the response are populated. To receive detailed data, refer to their own endpoints.
For more details for note properties, see field specific descriptions.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
objectType |
Fetch all items that are given type |
string |
Query |
noteTypeId |
Fetch all items that are the given note type |
string |
Query |
noteClassId |
Fetch all items that are the given note class |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCid |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
projectOwnerCid |
Fetch all items related a project owned by a given company |
string |
Query |
targetId |
Fetch all items related to a given target |
string |
Query |
targetCid |
Fetch all items related to a given target |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
companyCid |
Fetch all items related to a given company |
string |
Query |
workSectionId |
Fetch all items related to a given work section |
string |
Query |
workSectionCid |
Fetch all items related to a given work section |
string |
Query |
activityId |
Fetch all items related to a given work activity |
string |
Query |
activityCid |
Fetch all items related to a given work activity |
string |
Query |
targetRecordId |
Fetch all items related to a given target record |
string |
Query |
targetRecordCid |
Fetch all items related to a given target record |
string |
Query |
maintenanceCycleId |
Fetch all items related to a given maintenance cycle |
string |
Query |
maintenanceCycleCid |
Fetch all items related to a given maintenance cycle |
string |
Query |
containerId |
Fetch all items related to a given measurement |
string |
Query |
containerCid |
Fetch all items related to a given measurement |
string |
Query |
topicId |
Fetch all items related to given a measurement topic |
string |
Query |
topicCid |
Fetch all items related to given a measurement topic |
string |
Query |
listId |
Fetch all items related to a given list |
string |
Query |
listCid |
Fetch all items related to a given list |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
measurementCid |
Fetch all items related to a given measurement topic |
string |
Query |
measurementTopicId |
Fetch all items related to a given measurement topic |
string |
Query |
measurementTopicCid |
Fetch all items related to a given measurement topic |
string |
Query |
inspectionId |
Fetch all items related to a given inspection |
string |
Query |
inspectionCid |
Fetch all items related to a given inspection |
string |
Query |
inspectionTopicId |
Fetch all items related to a given inspection topic |
string |
Query |
inspectionTopicCid |
Fetch all items related to a given inspection topic |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
assignedToUserId |
ID of the user who this note is assigned to. Assigned to field is not visible for all projects, but it can be set to all notes. Assigned to field should be used only for notes and projects that support assigned to field. |
string |
categoryTagRelations |
List of tag relations. |
< categoryTagRelations > array |
comments |
List of note comments. |
< comments > array |
companyId |
ID of the related contractor company object. |
string |
containerId |
ID of the related measurement, task list, inspection or other note container object. |
string |
containerOptionId |
ID of the related measurement or other container topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Textual description for the note. Description is text field that user can use to write description of the note with his or her own words. There are no predefined values to use. Description is not required value. Some notes doesn’t need description, but just log e.g. positive safety note. In those cases other note properties describe note well enough that description is not needed. |
string |
descriptionExtended |
Extended textual description for the note. Extended description is used when user needs to give longer than one-line description of the note. Extended description is not enabled in the note template by default but can be taken into use if needed. Extended description field supports limited set of markdown syntax. Field support lists, headers and some font styling, e.g. bold and italic. For more details on the field and to enable it to your note templates please contact Congrid support at support@congrid.com. |
string |
displayId |
Display ID number for the note. Display ID number is not unique, but is a project wide running number within one |
string |
events |
List of related event objects. |
< events > array |
formAttributes |
Note template specific data. |
string |
formId |
ID of the related note template (form) object. In addition to predefined note values, it’s possible to add new customer specific fields for the note. This is done via either project or company level templates. |
string |
id |
Unique ID for the object given by backend server. |
string |
impacts |
List of impacts associated with this Note. |
< impacts > array |
inspectionId |
ID of the related inspection object. |
string |
inspectionTopicId |
ID of the related inspection topic object. |
string |
listId |
ID of the related punch list object. |
string |
marker |
Related floor plan marker object. Single marker represents floor plan marker and geoOverlay markers are listed as a separate nested list. Single separate marker relation is deprecated relation used before new overlay types were introduced. Single TO BE DEPRECATED |
|
measurementId |
ID of the related measurement object. |
string |
measurementTopicId |
ID of the related measurement topic object. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
multiplier |
Multiplier field is used in different measurement to change weight of the note when calculating measurement results. As an example multiplier can be used in safety measurements to increase note weight by setting In practice note multiplier is used in safety measurements, when there is need to add e.g. 10 similar notes. In that case, it’s possible to add just one with |
integer |
noteClassId |
Note class defines category for the note within one Congrid system application module. Note class can be seen as a purpose of the note. Whereas Note classes can be used as a category for different analytics purposes. Often there’s need to separate notes that are positive and negative or are made just for documentation purposes. Within one Together with |
enum (TASK, DOCUMENTATION, NOTIFICATION, POSITIVE) |
noteTypeId |
Note type defines where note belongs to in Congrid system. Types follow Congrid application modules. Each application module, e.g. safety or quality, can be used to create notes. Those notes are all equal except by type. Note type can be used as a category for different analytics purposes. Often there’s need to separate notes from quality and safety applications and Within one By default all notes are |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
observedAt |
Timestamp for note observation time. |
string (date-time) |
photoIds |
List of IDs of related photo objects. |
< string > array |
priorityValue |
Priority value is a number that defines note priority. |
integer |
projectId |
ID of the related project. If note is shared |
string |
requiredAction |
Required actions is a text field used for user given description for different actions required to finish with the note. |
string |
requiredActionDueAt |
Required action due at is a timestamp value used to set time limit or deadline for when the required actions should be finished. |
string (date-time) |
statusId |
Status of the note. |
enum (RECEIVED, REJECTED, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
ID of the related area hierarchy tree object (target). |
string |
topicName |
Name for the related measurement or inspection topic. Name is derived from related inspection or measurement to avoid need for extra queries. Same information could be fetched from the measurement or inspection topic end-point as well. |
string |
validFromAt |
Validity window start timestamp. Validity window defines the time that the notification is valid. Notification could be showed even if we would not be within validity window. E.g. we might want to show the notification before the message is valid, like "warning for tomorrow". |
string (date-time) |
validToAt |
Validity window end timestamp. Validity window defines the time that the notification is valid. |
string (date-time) |
visibleFromAt |
Visibility window start timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
visibleToAt |
Visibility window end timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
workActivityId |
ID of the related work activity object. |
string |
workSectionId |
ID of the related work section object. |
string |
categoryTagRelations
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
dataSourceTagId |
General tag ID of the data source tag object. Field is optional and represents the value used in note template to set "beginning" of the tag tree when adding new tags. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. API allows deleting tag relations by setting the 'deletedAt' timestamp. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
tagId |
General tag ID of the related tag object. Field is required, because all tag relations must have a tag that relation belongs to. All other relations are optional and API user can use any of them - or none. |
string |
comments
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
ID of the related Note. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (MARKED_CANNOT_MEASURE, UNDELETED, MARKED_RECEIVED, MARKED_NOT_APPLICABLE, MARKED_WIP, MARKED_ACCEPTED, DELETED, MARKED_COMPLETE, MARKED_PENDING, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_REJECTED) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
impacts
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
marker
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
floorPlanId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
typeId |
Example : |
enum (SIGNATURE_OVERLAY, PHOTO_OVERLAY, FLOOR_PLAN_OVERLAY, FLOOR_PLAN_POINT_MARKER, GEO_OVERLAY) |
x |
Example : |
integer |
y |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/notes
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"description" : "Brief description of the note",
"descriptionExtended" : "Longer description of the note",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.9. POST /notes
Description
Notes can be attached to different types of entites in Congrid system. Depending on the type of the note the listId
, measurementId
, measurementTopicId
, inspectionId
and inspectionTopicId
(and other) properties in the response are populated. To receive detailed data, refer to their own endpoints.
For more details for note properties, see field specific descriptions.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
assignedToUserId |
ID of the user who this note is assigned to. Assigned to field is not visible for all projects, but it can be set to all notes. Assigned to field should be used only for notes and projects that support assigned to field. |
string |
categoryTagRelations |
List of tag relations. |
< categoryTagRelations > array |
comments |
List of note comments. |
< comments > array |
companyId |
ID of the related contractor company object. |
string |
containerId |
ID of the related measurement, task list, inspection or other note container object. |
string |
containerOptionId |
ID of the related measurement or other container topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Textual description for the note. Description is text field that user can use to write description of the note with his or her own words. There are no predefined values to use. Description is not required value. Some notes doesn’t need description, but just log e.g. positive safety note. In those cases other note properties describe note well enough that description is not needed. |
string |
descriptionExtended |
Extended textual description for the note. Extended description is used when user needs to give longer than one-line description of the note. Extended description is not enabled in the note template by default but can be taken into use if needed. Extended description field supports limited set of markdown syntax. Field support lists, headers and some font styling, e.g. bold and italic. For more details on the field and to enable it to your note templates please contact Congrid support at support@congrid.com. |
string |
displayId |
Display ID number for the note. Display ID number is not unique, but is a project wide running number within one |
string |
events |
List of related event objects. |
< events > array |
formAttributes |
Note template specific data. |
string |
formId |
ID of the related note template (form) object. In addition to predefined note values, it’s possible to add new customer specific fields for the note. This is done via either project or company level templates. |
string |
id |
Unique ID for the object given by backend server. |
string |
impacts |
List of impacts associated with this Note. |
< impacts > array |
inspectionId |
ID of the related inspection object. |
string |
inspectionTopicId |
ID of the related inspection topic object. |
string |
listId |
ID of the related punch list object. |
string |
marker |
Related floor plan marker object. Single marker represents floor plan marker and geoOverlay markers are listed as a separate nested list. Single separate marker relation is deprecated relation used before new overlay types were introduced. Single TO BE DEPRECATED |
|
measurementId |
ID of the related measurement object. |
string |
measurementTopicId |
ID of the related measurement topic object. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
multiplier |
Multiplier field is used in different measurement to change weight of the note when calculating measurement results. As an example multiplier can be used in safety measurements to increase note weight by setting In practice note multiplier is used in safety measurements, when there is need to add e.g. 10 similar notes. In that case, it’s possible to add just one with |
integer |
noteClassId |
Note class defines category for the note within one Congrid system application module. Note class can be seen as a purpose of the note. Whereas Note classes can be used as a category for different analytics purposes. Often there’s need to separate notes that are positive and negative or are made just for documentation purposes. Within one Together with |
enum (TASK, DOCUMENTATION, NOTIFICATION, POSITIVE) |
noteTypeId |
Note type defines where note belongs to in Congrid system. Types follow Congrid application modules. Each application module, e.g. safety or quality, can be used to create notes. Those notes are all equal except by type. Note type can be used as a category for different analytics purposes. Often there’s need to separate notes from quality and safety applications and Within one By default all notes are |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
observedAt |
Timestamp for note observation time. |
string (date-time) |
photoIds |
List of IDs of related photo objects. |
< string > array |
priorityValue |
Priority value is a number that defines note priority. |
integer |
projectId |
ID of the related project. If note is shared |
string |
requiredAction |
Required actions is a text field used for user given description for different actions required to finish with the note. |
string |
requiredActionDueAt |
Required action due at is a timestamp value used to set time limit or deadline for when the required actions should be finished. |
string (date-time) |
statusId |
Status of the note. |
enum (RECEIVED, REJECTED, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
ID of the related area hierarchy tree object (target). |
string |
validFromAt |
Validity window start timestamp. Validity window defines the time that the notification is valid. Notification could be showed even if we would not be within validity window. E.g. we might want to show the notification before the message is valid, like "warning for tomorrow". |
string (date-time) |
validToAt |
Validity window end timestamp. Validity window defines the time that the notification is valid. |
string (date-time) |
visibleFromAt |
Visibility window start timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
visibleToAt |
Visibility window end timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
workActivityId |
ID of the related work activity object. |
string |
workSectionId |
ID of the related work section object. |
string |
categoryTagRelations
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
dataSourceTagId |
General tag ID of the data source tag object. Field is optional and represents the value used in note template to set "beginning" of the tag tree when adding new tags. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. API allows deleting tag relations by setting the 'deletedAt' timestamp. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
tagId |
General tag ID of the related tag object. Field is required, because all tag relations must have a tag that relation belongs to. All other relations are optional and API user can use any of them - or none. |
string |
comments
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
noteId |
ID of the related Note. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (MARKED_CANNOT_MEASURE, UNDELETED, MARKED_RECEIVED, MARKED_NOT_APPLICABLE, MARKED_WIP, MARKED_ACCEPTED, DELETED, MARKED_COMPLETE, MARKED_PENDING, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_REJECTED) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
impacts
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
marker
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
floorPlanId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
typeId |
Example : |
enum (SIGNATURE_OVERLAY, PHOTO_OVERLAY, FLOOR_PLAN_OVERLAY, FLOOR_PLAN_POINT_MARKER, GEO_OVERLAY) |
x |
Example : |
integer |
y |
Example : |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
assignedToUserId |
ID of the user who this note is assigned to. Assigned to field is not visible for all projects, but it can be set to all notes. Assigned to field should be used only for notes and projects that support assigned to field. |
string |
categoryTagRelations |
List of tag relations. |
< categoryTagRelations > array |
comments |
List of note comments. |
< comments > array |
companyId |
ID of the related contractor company object. |
string |
containerId |
ID of the related measurement, task list, inspection or other note container object. |
string |
containerOptionId |
ID of the related measurement or other container topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Textual description for the note. Description is text field that user can use to write description of the note with his or her own words. There are no predefined values to use. Description is not required value. Some notes doesn’t need description, but just log e.g. positive safety note. In those cases other note properties describe note well enough that description is not needed. |
string |
descriptionExtended |
Extended textual description for the note. Extended description is used when user needs to give longer than one-line description of the note. Extended description is not enabled in the note template by default but can be taken into use if needed. Extended description field supports limited set of markdown syntax. Field support lists, headers and some font styling, e.g. bold and italic. For more details on the field and to enable it to your note templates please contact Congrid support at support@congrid.com. |
string |
displayId |
Display ID number for the note. Display ID number is not unique, but is a project wide running number within one |
string |
events |
List of related event objects. |
< events > array |
formAttributes |
Note template specific data. |
string |
formId |
ID of the related note template (form) object. In addition to predefined note values, it’s possible to add new customer specific fields for the note. This is done via either project or company level templates. |
string |
id |
Unique ID for the object given by backend server. |
string |
impacts |
List of impacts associated with this Note. |
< impacts > array |
inspectionId |
ID of the related inspection object. |
string |
inspectionTopicId |
ID of the related inspection topic object. |
string |
listId |
ID of the related punch list object. |
string |
marker |
Related floor plan marker object. Single marker represents floor plan marker and geoOverlay markers are listed as a separate nested list. Single separate marker relation is deprecated relation used before new overlay types were introduced. Single TO BE DEPRECATED |
|
measurementId |
ID of the related measurement object. |
string |
measurementTopicId |
ID of the related measurement topic object. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
multiplier |
Multiplier field is used in different measurement to change weight of the note when calculating measurement results. As an example multiplier can be used in safety measurements to increase note weight by setting In practice note multiplier is used in safety measurements, when there is need to add e.g. 10 similar notes. In that case, it’s possible to add just one with |
integer |
noteClassId |
Note class defines category for the note within one Congrid system application module. Note class can be seen as a purpose of the note. Whereas Note classes can be used as a category for different analytics purposes. Often there’s need to separate notes that are positive and negative or are made just for documentation purposes. Within one Together with |
enum (TASK, DOCUMENTATION, NOTIFICATION, POSITIVE) |
noteTypeId |
Note type defines where note belongs to in Congrid system. Types follow Congrid application modules. Each application module, e.g. safety or quality, can be used to create notes. Those notes are all equal except by type. Note type can be used as a category for different analytics purposes. Often there’s need to separate notes from quality and safety applications and Within one By default all notes are |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
observedAt |
Timestamp for note observation time. |
string (date-time) |
photoIds |
List of IDs of related photo objects. |
< string > array |
priorityValue |
Priority value is a number that defines note priority. |
integer |
projectId |
ID of the related project. If note is shared |
string |
requiredAction |
Required actions is a text field used for user given description for different actions required to finish with the note. |
string |
requiredActionDueAt |
Required action due at is a timestamp value used to set time limit or deadline for when the required actions should be finished. |
string (date-time) |
statusId |
Status of the note. |
enum (RECEIVED, REJECTED, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
ID of the related area hierarchy tree object (target). |
string |
topicName |
Name for the related measurement or inspection topic. Name is derived from related inspection or measurement to avoid need for extra queries. Same information could be fetched from the measurement or inspection topic end-point as well. |
string |
validFromAt |
Validity window start timestamp. Validity window defines the time that the notification is valid. Notification could be showed even if we would not be within validity window. E.g. we might want to show the notification before the message is valid, like "warning for tomorrow". |
string (date-time) |
validToAt |
Validity window end timestamp. Validity window defines the time that the notification is valid. |
string (date-time) |
visibleFromAt |
Visibility window start timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
visibleToAt |
Visibility window end timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
workActivityId |
ID of the related work activity object. |
string |
workSectionId |
ID of the related work section object. |
string |
categoryTagRelations
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
dataSourceTagId |
General tag ID of the data source tag object. Field is optional and represents the value used in note template to set "beginning" of the tag tree when adding new tags. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. API allows deleting tag relations by setting the 'deletedAt' timestamp. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
tagId |
General tag ID of the related tag object. Field is required, because all tag relations must have a tag that relation belongs to. All other relations are optional and API user can use any of them - or none. |
string |
comments
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
ID of the related Note. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (MARKED_CANNOT_MEASURE, UNDELETED, MARKED_RECEIVED, MARKED_NOT_APPLICABLE, MARKED_WIP, MARKED_ACCEPTED, DELETED, MARKED_COMPLETE, MARKED_PENDING, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_REJECTED) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
impacts
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
marker
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
floorPlanId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
typeId |
Example : |
enum (SIGNATURE_OVERLAY, PHOTO_OVERLAY, FLOOR_PLAN_OVERLAY, FLOOR_PLAN_POINT_MARKER, GEO_OVERLAY) |
x |
Example : |
integer |
y |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/notes
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"description" : "Brief description of the note",
"descriptionExtended" : "Longer description of the note",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"description" : "Brief description of the note",
"descriptionExtended" : "Longer description of the note",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.10. GET /notes/{id}
Description
Notes can be attached to different types of entites in Congrid system. Depending on the type of the note the listId
, measurementId
, measurementTopicId
, inspectionId
and inspectionTopicId
(and other) properties in the response are populated. To receive detailed data, refer to their own endpoints.
For more details for note properties, see field specific descriptions.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
assignedToUserId |
ID of the user who this note is assigned to. Assigned to field is not visible for all projects, but it can be set to all notes. Assigned to field should be used only for notes and projects that support assigned to field. |
string |
categoryTagRelations |
List of tag relations. |
< categoryTagRelations > array |
comments |
List of note comments. |
< comments > array |
companyId |
ID of the related contractor company object. |
string |
containerId |
ID of the related measurement, task list, inspection or other note container object. |
string |
containerOptionId |
ID of the related measurement or other container topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Textual description for the note. Description is text field that user can use to write description of the note with his or her own words. There are no predefined values to use. Description is not required value. Some notes doesn’t need description, but just log e.g. positive safety note. In those cases other note properties describe note well enough that description is not needed. |
string |
descriptionExtended |
Extended textual description for the note. Extended description is used when user needs to give longer than one-line description of the note. Extended description is not enabled in the note template by default but can be taken into use if needed. Extended description field supports limited set of markdown syntax. Field support lists, headers and some font styling, e.g. bold and italic. For more details on the field and to enable it to your note templates please contact Congrid support at support@congrid.com. |
string |
displayId |
Display ID number for the note. Display ID number is not unique, but is a project wide running number within one |
string |
events |
List of related event objects. |
< events > array |
formAttributes |
Note template specific data. |
string |
formId |
ID of the related note template (form) object. In addition to predefined note values, it’s possible to add new customer specific fields for the note. This is done via either project or company level templates. |
string |
id |
Unique ID for the object given by backend server. |
string |
impacts |
List of impacts associated with this Note. |
< impacts > array |
inspectionId |
ID of the related inspection object. |
string |
inspectionTopicId |
ID of the related inspection topic object. |
string |
listId |
ID of the related punch list object. |
string |
marker |
Related floor plan marker object. Single marker represents floor plan marker and geoOverlay markers are listed as a separate nested list. Single separate marker relation is deprecated relation used before new overlay types were introduced. Single TO BE DEPRECATED |
|
measurementId |
ID of the related measurement object. |
string |
measurementTopicId |
ID of the related measurement topic object. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
multiplier |
Multiplier field is used in different measurement to change weight of the note when calculating measurement results. As an example multiplier can be used in safety measurements to increase note weight by setting In practice note multiplier is used in safety measurements, when there is need to add e.g. 10 similar notes. In that case, it’s possible to add just one with |
integer |
noteClassId |
Note class defines category for the note within one Congrid system application module. Note class can be seen as a purpose of the note. Whereas Note classes can be used as a category for different analytics purposes. Often there’s need to separate notes that are positive and negative or are made just for documentation purposes. Within one Together with |
enum (TASK, DOCUMENTATION, NOTIFICATION, POSITIVE) |
noteTypeId |
Note type defines where note belongs to in Congrid system. Types follow Congrid application modules. Each application module, e.g. safety or quality, can be used to create notes. Those notes are all equal except by type. Note type can be used as a category for different analytics purposes. Often there’s need to separate notes from quality and safety applications and Within one By default all notes are |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
observedAt |
Timestamp for note observation time. |
string (date-time) |
photoIds |
List of IDs of related photo objects. |
< string > array |
priorityValue |
Priority value is a number that defines note priority. |
integer |
projectId |
ID of the related project. If note is shared |
string |
requiredAction |
Required actions is a text field used for user given description for different actions required to finish with the note. |
string |
requiredActionDueAt |
Required action due at is a timestamp value used to set time limit or deadline for when the required actions should be finished. |
string (date-time) |
statusId |
Status of the note. |
enum (RECEIVED, REJECTED, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
ID of the related area hierarchy tree object (target). |
string |
topicName |
Name for the related measurement or inspection topic. Name is derived from related inspection or measurement to avoid need for extra queries. Same information could be fetched from the measurement or inspection topic end-point as well. |
string |
validFromAt |
Validity window start timestamp. Validity window defines the time that the notification is valid. Notification could be showed even if we would not be within validity window. E.g. we might want to show the notification before the message is valid, like "warning for tomorrow". |
string (date-time) |
validToAt |
Validity window end timestamp. Validity window defines the time that the notification is valid. |
string (date-time) |
visibleFromAt |
Visibility window start timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
visibleToAt |
Visibility window end timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
workActivityId |
ID of the related work activity object. |
string |
workSectionId |
ID of the related work section object. |
string |
categoryTagRelations
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
dataSourceTagId |
General tag ID of the data source tag object. Field is optional and represents the value used in note template to set "beginning" of the tag tree when adding new tags. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. API allows deleting tag relations by setting the 'deletedAt' timestamp. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
tagId |
General tag ID of the related tag object. Field is required, because all tag relations must have a tag that relation belongs to. All other relations are optional and API user can use any of them - or none. |
string |
comments
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
ID of the related Note. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (MARKED_CANNOT_MEASURE, UNDELETED, MARKED_RECEIVED, MARKED_NOT_APPLICABLE, MARKED_WIP, MARKED_ACCEPTED, DELETED, MARKED_COMPLETE, MARKED_PENDING, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_REJECTED) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
impacts
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
marker
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
floorPlanId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
typeId |
Example : |
enum (SIGNATURE_OVERLAY, PHOTO_OVERLAY, FLOOR_PLAN_OVERLAY, FLOOR_PLAN_POINT_MARKER, GEO_OVERLAY) |
x |
Example : |
integer |
y |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/notes/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"description" : "Brief description of the note",
"descriptionExtended" : "Longer description of the note",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.11. PUT /notes/{id}
Description
Notes can be attached to different types of entites in Congrid system. Depending on the type of the note the listId
, measurementId
, measurementTopicId
, inspectionId
and inspectionTopicId
(and other) properties in the response are populated. To receive detailed data, refer to their own endpoints.
For more details for note properties, see field specific descriptions.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
assignedToUserId |
ID of the user who this note is assigned to. Assigned to field is not visible for all projects, but it can be set to all notes. Assigned to field should be used only for notes and projects that support assigned to field. |
string |
categoryTagRelations |
List of tag relations. |
< categoryTagRelations > array |
comments |
List of note comments. |
< comments > array |
companyId |
ID of the related contractor company object. |
string |
containerId |
ID of the related measurement, task list, inspection or other note container object. |
string |
containerOptionId |
ID of the related measurement or other container topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Textual description for the note. Description is text field that user can use to write description of the note with his or her own words. There are no predefined values to use. Description is not required value. Some notes doesn’t need description, but just log e.g. positive safety note. In those cases other note properties describe note well enough that description is not needed. |
string |
descriptionExtended |
Extended textual description for the note. Extended description is used when user needs to give longer than one-line description of the note. Extended description is not enabled in the note template by default but can be taken into use if needed. Extended description field supports limited set of markdown syntax. Field support lists, headers and some font styling, e.g. bold and italic. For more details on the field and to enable it to your note templates please contact Congrid support at support@congrid.com. |
string |
displayId |
Display ID number for the note. Display ID number is not unique, but is a project wide running number within one |
string |
events |
List of related event objects. |
< events > array |
formAttributes |
Note template specific data. |
string |
formId |
ID of the related note template (form) object. In addition to predefined note values, it’s possible to add new customer specific fields for the note. This is done via either project or company level templates. |
string |
id |
Unique ID for the object given by backend server. |
string |
impacts |
List of impacts associated with this Note. |
< impacts > array |
inspectionId |
ID of the related inspection object. |
string |
inspectionTopicId |
ID of the related inspection topic object. |
string |
listId |
ID of the related punch list object. |
string |
marker |
Related floor plan marker object. Single marker represents floor plan marker and geoOverlay markers are listed as a separate nested list. Single separate marker relation is deprecated relation used before new overlay types were introduced. Single TO BE DEPRECATED |
|
measurementId |
ID of the related measurement object. |
string |
measurementTopicId |
ID of the related measurement topic object. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
multiplier |
Multiplier field is used in different measurement to change weight of the note when calculating measurement results. As an example multiplier can be used in safety measurements to increase note weight by setting In practice note multiplier is used in safety measurements, when there is need to add e.g. 10 similar notes. In that case, it’s possible to add just one with |
integer |
noteClassId |
Note class defines category for the note within one Congrid system application module. Note class can be seen as a purpose of the note. Whereas Note classes can be used as a category for different analytics purposes. Often there’s need to separate notes that are positive and negative or are made just for documentation purposes. Within one Together with |
enum (TASK, DOCUMENTATION, NOTIFICATION, POSITIVE) |
noteTypeId |
Note type defines where note belongs to in Congrid system. Types follow Congrid application modules. Each application module, e.g. safety or quality, can be used to create notes. Those notes are all equal except by type. Note type can be used as a category for different analytics purposes. Often there’s need to separate notes from quality and safety applications and Within one By default all notes are |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
observedAt |
Timestamp for note observation time. |
string (date-time) |
photoIds |
List of IDs of related photo objects. |
< string > array |
priorityValue |
Priority value is a number that defines note priority. |
integer |
projectId |
ID of the related project. If note is shared |
string |
requiredAction |
Required actions is a text field used for user given description for different actions required to finish with the note. |
string |
requiredActionDueAt |
Required action due at is a timestamp value used to set time limit or deadline for when the required actions should be finished. |
string (date-time) |
statusId |
Status of the note. |
enum (RECEIVED, REJECTED, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
ID of the related area hierarchy tree object (target). |
string |
validFromAt |
Validity window start timestamp. Validity window defines the time that the notification is valid. Notification could be showed even if we would not be within validity window. E.g. we might want to show the notification before the message is valid, like "warning for tomorrow". |
string (date-time) |
validToAt |
Validity window end timestamp. Validity window defines the time that the notification is valid. |
string (date-time) |
visibleFromAt |
Visibility window start timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
visibleToAt |
Visibility window end timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
workActivityId |
ID of the related work activity object. |
string |
workSectionId |
ID of the related work section object. |
string |
categoryTagRelations
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
dataSourceTagId |
General tag ID of the data source tag object. Field is optional and represents the value used in note template to set "beginning" of the tag tree when adding new tags. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. API allows deleting tag relations by setting the 'deletedAt' timestamp. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
tagId |
General tag ID of the related tag object. Field is required, because all tag relations must have a tag that relation belongs to. All other relations are optional and API user can use any of them - or none. |
string |
comments
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
noteId |
ID of the related Note. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (MARKED_CANNOT_MEASURE, UNDELETED, MARKED_RECEIVED, MARKED_NOT_APPLICABLE, MARKED_WIP, MARKED_ACCEPTED, DELETED, MARKED_COMPLETE, MARKED_PENDING, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_REJECTED) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
impacts
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
marker
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
floorPlanId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
typeId |
Example : |
enum (SIGNATURE_OVERLAY, PHOTO_OVERLAY, FLOOR_PLAN_OVERLAY, FLOOR_PLAN_POINT_MARKER, GEO_OVERLAY) |
x |
Example : |
integer |
y |
Example : |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
assignedToUserId |
ID of the user who this note is assigned to. Assigned to field is not visible for all projects, but it can be set to all notes. Assigned to field should be used only for notes and projects that support assigned to field. |
string |
categoryTagRelations |
List of tag relations. |
< categoryTagRelations > array |
comments |
List of note comments. |
< comments > array |
companyId |
ID of the related contractor company object. |
string |
containerId |
ID of the related measurement, task list, inspection or other note container object. |
string |
containerOptionId |
ID of the related measurement or other container topic. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Textual description for the note. Description is text field that user can use to write description of the note with his or her own words. There are no predefined values to use. Description is not required value. Some notes doesn’t need description, but just log e.g. positive safety note. In those cases other note properties describe note well enough that description is not needed. |
string |
descriptionExtended |
Extended textual description for the note. Extended description is used when user needs to give longer than one-line description of the note. Extended description is not enabled in the note template by default but can be taken into use if needed. Extended description field supports limited set of markdown syntax. Field support lists, headers and some font styling, e.g. bold and italic. For more details on the field and to enable it to your note templates please contact Congrid support at support@congrid.com. |
string |
displayId |
Display ID number for the note. Display ID number is not unique, but is a project wide running number within one |
string |
events |
List of related event objects. |
< events > array |
formAttributes |
Note template specific data. |
string |
formId |
ID of the related note template (form) object. In addition to predefined note values, it’s possible to add new customer specific fields for the note. This is done via either project or company level templates. |
string |
id |
Unique ID for the object given by backend server. |
string |
impacts |
List of impacts associated with this Note. |
< impacts > array |
inspectionId |
ID of the related inspection object. |
string |
inspectionTopicId |
ID of the related inspection topic object. |
string |
listId |
ID of the related punch list object. |
string |
marker |
Related floor plan marker object. Single marker represents floor plan marker and geoOverlay markers are listed as a separate nested list. Single separate marker relation is deprecated relation used before new overlay types were introduced. Single TO BE DEPRECATED |
|
measurementId |
ID of the related measurement object. |
string |
measurementTopicId |
ID of the related measurement topic object. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
multiplier |
Multiplier field is used in different measurement to change weight of the note when calculating measurement results. As an example multiplier can be used in safety measurements to increase note weight by setting In practice note multiplier is used in safety measurements, when there is need to add e.g. 10 similar notes. In that case, it’s possible to add just one with |
integer |
noteClassId |
Note class defines category for the note within one Congrid system application module. Note class can be seen as a purpose of the note. Whereas Note classes can be used as a category for different analytics purposes. Often there’s need to separate notes that are positive and negative or are made just for documentation purposes. Within one Together with |
enum (TASK, DOCUMENTATION, NOTIFICATION, POSITIVE) |
noteTypeId |
Note type defines where note belongs to in Congrid system. Types follow Congrid application modules. Each application module, e.g. safety or quality, can be used to create notes. Those notes are all equal except by type. Note type can be used as a category for different analytics purposes. Often there’s need to separate notes from quality and safety applications and Within one By default all notes are |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
observedAt |
Timestamp for note observation time. |
string (date-time) |
photoIds |
List of IDs of related photo objects. |
< string > array |
priorityValue |
Priority value is a number that defines note priority. |
integer |
projectId |
ID of the related project. If note is shared |
string |
requiredAction |
Required actions is a text field used for user given description for different actions required to finish with the note. |
string |
requiredActionDueAt |
Required action due at is a timestamp value used to set time limit or deadline for when the required actions should be finished. |
string (date-time) |
statusId |
Status of the note. |
enum (RECEIVED, REJECTED, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
targetId |
ID of the related area hierarchy tree object (target). |
string |
topicName |
Name for the related measurement or inspection topic. Name is derived from related inspection or measurement to avoid need for extra queries. Same information could be fetched from the measurement or inspection topic end-point as well. |
string |
validFromAt |
Validity window start timestamp. Validity window defines the time that the notification is valid. Notification could be showed even if we would not be within validity window. E.g. we might want to show the notification before the message is valid, like "warning for tomorrow". |
string (date-time) |
validToAt |
Validity window end timestamp. Validity window defines the time that the notification is valid. |
string (date-time) |
visibleFromAt |
Visibility window start timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
visibleToAt |
Visibility window end timestamp. Visibility window defines the time that the notification is showed for user. |
string (date-time) |
workActivityId |
ID of the related work activity object. |
string |
workSectionId |
ID of the related work section object. |
string |
categoryTagRelations
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
dataSourceTagId |
General tag ID of the data source tag object. Field is optional and represents the value used in note template to set "beginning" of the tag tree when adding new tags. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. API allows deleting tag relations by setting the 'deletedAt' timestamp. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
tagId |
General tag ID of the related tag object. Field is required, because all tag relations must have a tag that relation belongs to. All other relations are optional and API user can use any of them - or none. |
string |
comments
Name | Description | Schema |
---|---|---|
createdAt |
Comment ID in Congrid system. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
message |
The comment message. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
ID of the related Note. |
string |
events
Name | Description | Schema |
---|---|---|
comment |
Event comment. |
string |
createdAt |
Timestamp for creation time of the event. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
diaryId |
Related diary ID value. |
string |
eventTypeId |
Event type ID for the event. |
enum (MARKED_CANNOT_MEASURE, UNDELETED, MARKED_RECEIVED, MARKED_NOT_APPLICABLE, MARKED_WIP, MARKED_ACCEPTED, DELETED, MARKED_COMPLETE, MARKED_PENDING, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_REJECTED) |
id |
Unique ID for the object given by backend server. |
string |
measurementIds |
List of related measurement ID values. |
< string > array |
measurementTopicIds |
List of related measurement topic ID values. |
< string > array |
noteId |
Related note ID value. |
string |
originalProjectId |
Project ID for the owner project of the event. It’s possible that event is owned by different project than what is used to query event. |
string |
projectId |
Related project ID value. |
string |
sourceId |
Source defines where the event originates. Internal events are created by Congrid system. For all external events, e.g. those created via public API, the source is automatically set as external. |
enum (INTERNAL, EXTERNAL) |
statusIdFrom |
Status ID value before the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusIdTo |
Status ID value after the status change event. |
enum (FOLLOW, RECEIVED, REJECTED, COMPLETED, PENDING, FIX, WAIT, WIP, NO_ACTIONS, ACCEPTED, VERIFIED, INCOMPLETE) |
statusUpdatedAt |
Timestamp for status change action. |
string (date-time) |
statusUpdatedBy |
User ID for user who have made the status update event. |
string |
statusUpdatedByFullName |
User full name for user who have made the status update event. |
string |
impacts
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description about details of impact, explanation of money and working hours etc. |
string |
durationMs |
Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day. |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moneyCurrencyId |
Currency unit of money impact. If not given, uses project’s default currency unit. |
enum (<missing info>) |
moneyCurrencyValue |
Amount of money impact. Integer value without decimal and 4 digits. Value can be "null" indicating non-applied value. For example: 1235000 = 123.5000 euros ie. 123 euros and 50 cents. |
integer |
noteId |
ID of the related Note. |
string |
marker
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
floorPlanId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
typeId |
Example : |
enum (SIGNATURE_OVERLAY, PHOTO_OVERLAY, FLOOR_PLAN_OVERLAY, FLOOR_PLAN_POINT_MARKER, GEO_OVERLAY) |
x |
Example : |
integer |
y |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/notes/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"description" : "Brief description of the note",
"descriptionExtended" : "Longer description of the note",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"description" : "Brief description of the note",
"descriptionExtended" : "Longer description of the note",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.9.12. DELETE /notes/{id}
Description
Notes can be attached to different types of entites in Congrid system. Depending on the type of the note the listId
, measurementId
, measurementTopicId
, inspectionId
and inspectionTopicId
(and other) properties in the response are populated. To receive detailed data, refer to their own endpoints.
For more details for note properties, see field specific descriptions.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/notes/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.10. Photos
2.10.1. GET /photos
Description
Through this end-point you can retrieve meta data about photos in Congrid system.
To download a photo file use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each photo file you want to download. URL is valid for 24 hours after being generated by this call.
Proper process of creating a new photo object is following:
-
POST
/photos
withavailable
field set to false. As response you receive fieldsignedUploadUrl
. -
PUT your file to the address listed in
signedUploadUrl
. -
PUT to
/photos/<photo id>
, wherephoto id
is your created photo object, but now fieldavailable
set to true. This informs the system that the photo file is available in the system, and it can be shown to users, and that generating thumbnail pictures can be started.
You can after that receive the photo file and thumbnail files simply performing GET to /photos/<photo id>
, or just collecting a list of photos with GET to /photos
and then downloading files from URLs listed in responses fields downloadUrl
, thumbnailUrl256
, thumbnailUrl512
and thumbnailUrl768
.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
concreteRecordId |
Fetch all items related to a given Concrete Record |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
noteId |
Fetch all items related to a given note |
string |
Query |
noteTypeId |
Fetch all items that are the given note type |
string |
Query |
noteClassId |
Fetch all items that are the given note class |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
available |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
height |
Example : |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
Example : |
string |
orientation |
Example : |
string |
projectId |
Example : |
string |
size |
File size if known. If no file size is not given, it could be that file size is just not yet determined. |
integer |
thumbnailUrl256 |
Example : |
string |
thumbnailUrl512 |
Example : |
string |
thumbnailUrl768 |
Example : |
string |
width |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/photos
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.10.2. POST /photos
Description
Through this end-point you can retrieve meta data about photos in Congrid system.
To download a photo file use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each photo file you want to download. URL is valid for 24 hours after being generated by this call.
Proper process of creating a new photo object is following:
-
POST
/photos
withavailable
field set to false. As response you receive fieldsignedUploadUrl
. -
PUT your file to the address listed in
signedUploadUrl
. -
PUT to
/photos/<photo id>
, wherephoto id
is your created photo object, but now fieldavailable
set to true. This informs the system that the photo file is available in the system, and it can be shown to users, and that generating thumbnail pictures can be started.
You can after that receive the photo file and thumbnail files simply performing GET to /photos/<photo id>
, or just collecting a list of photos with GET to /photos
and then downloading files from URLs listed in responses fields downloadUrl
, thumbnailUrl256
, thumbnailUrl512
and thumbnailUrl768
.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
available |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
height |
Example : |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
noteId |
Example : |
string |
orientation |
Example : |
string |
projectId |
Example : |
string |
size |
File size if known. If no file size is not given, it could be that file size is just not yet determined. |
integer |
width |
Example : |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
available |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
height |
Example : |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
Example : |
string |
orientation |
Example : |
string |
projectId |
Example : |
string |
size |
File size if known. If no file size is not given, it could be that file size is just not yet determined. |
integer |
thumbnailUrl256 |
Example : |
string |
thumbnailUrl512 |
Example : |
string |
thumbnailUrl768 |
Example : |
string |
width |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/photos
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.10.3. GET /photos/{id}
Description
Todo: Add missing documentation, CON-6287
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
available |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
height |
Example : |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
Example : |
string |
orientation |
Example : |
string |
projectId |
Example : |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
size |
File size if known. If no file size is not given, it could be that file size is just not yet determined. |
integer |
thumbnailUrl256 |
Example : |
string |
thumbnailUrl512 |
Example : |
string |
thumbnailUrl768 |
Example : |
string |
width |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/photos/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.10.4. PUT /photos/{id}
Description
Todo: Add missing documentation, CON-6287
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
available |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
height |
Example : |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
noteId |
Example : |
string |
orientation |
Example : |
string |
projectId |
Example : |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
size |
File size if known. If no file size is not given, it could be that file size is just not yet determined. |
integer |
width |
Example : |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
available |
Example : |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
createdByDisplayName |
Object creator’s full name. |
string |
createdByFullName |
Object creator’s full name. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
height |
Example : |
integer |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
noteId |
Example : |
string |
orientation |
Example : |
string |
projectId |
Example : |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
size |
File size if known. If no file size is not given, it could be that file size is just not yet determined. |
integer |
thumbnailUrl256 |
Example : |
string |
thumbnailUrl512 |
Example : |
string |
thumbnailUrl768 |
Example : |
string |
width |
Example : |
integer |
Produces
-
application/json
Example HTTP request
Request path
/photos/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"createdByDisplayName" : "First name Last name",
"createdByFullName" : "First name Last name",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.10.5. DELETE /photos/{id}
Description
Todo: Add missing documentation, CON-6287
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/photos/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.11. Projects
2.11.1. GET /projects
Description
Project is one of the main objects in the system. All data associated with a project can be roughly split in two categories: the mostly static base data configured at start of the project and user generated data created on a day-to-day basis.
We strongly encourage you to properly configure the base data at start of the project to make the day to day user experience as fluent as possible. This is however not mandatory or enforced by any means and you can always update the base data at any time during the project.
The project base data consists of the following:
-
Companies or subcontractors participating in the project.
-
Floor plans of the construction site.
-
Targets that specify the hierarchical structure of the physical buildings and areas of the construction site.
-
Users that are allowed to access the project data.
-
AD configuration for role management through AD (see POST request to endpoint for more details).
GET returns all the projects for the user. Use the optional projectCode
query parameter to only retrieve projects with a certain projectCode. E.g. `&projectCode=P-123` Returns all the projects where projectCode is P-123. NOTE: projectCode is not quaranteed to be unique so there can be multiple projects with the same projectCode.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
startedAtGt |
Fetch all items that have been started after a time (exclusively) |
string |
Query |
startedAtGte |
Fetch all items that have been started after a time (inclusively) |
string |
Query |
startedAtLt |
Fetch all items that have been started before a time (exclusively) |
string |
Query |
startedAtLte |
Fetch all items that have been started before a time (inclusively) |
string |
Query |
finishedAtGt |
Fetch all items that have been finished after a time (exclusively) |
string |
Query |
finishedAtGte |
Fetch all items that have been finished after a time (inclusively) |
string |
Query |
finishedAtLt |
Fetch all items that have been finished before a time (exclusively) |
string |
Query |
finishedAtLte |
Fetch all items that have been finished before a time (inclusively) |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
projectCode |
Fetch all projects that have given project code |
string |
Query |
ownerId |
Fetch all projects that are owned by given company |
string |
Query |
ownerCid |
Fetch all projects that are owned by given company |
string |
Query |
projectOwnerId |
Fetch all projects that are owned by given company |
string |
Query |
projectOwnerCid |
Fetch all projects that are owned by given company |
string |
Query |
projectId |
Fetch a project with given id |
string |
Query |
projectCid |
Fetch a project with given id |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
adConfiguration |
Project AD configurations. For more details about how project AD configuration is done and for help in adding configuration, please contact Congrid support at support@congrid.com or your designated support person. |
enum (projectLiveAdmin, projectClientAdmin, projectLiveView, projectLiveEdit) |
addressId |
Project address ID. |
string |
companyUnitId |
Related company unit. |
string |
constructionManagerText |
Construction manager text. Text formatted alternative that can be used to set construction manager for project information. It’s recommended to use similar field 'constructionManagerUserIds' that link project to user ID. |
string |
constructionManagerUserIds |
Construction manager user IDs. List user IDs for users who are set as construction managers. |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
defaultCurrencyId |
Currency that is used in project’s accounting by default. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
finishedAt |
Timestamp for date and time when project is finished. |
string (date) |
headOfUnitText |
Head of unit text. Text formatted alternative that can be used to set head of unit for project information. It’s recommended to use similar field 'headOfUnitUserIds' that link project to user ID. |
string |
headOfUnitUserIds |
Head of unit user IDs. List user IDs for users who are set as head of unit. |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moduleIds |
An array of module ids that are enabled for the project. Application modules are used select which parts of the system are enabled for each project. Modules are project specific. For more details about each module and how they should be used please contact our support at support@congrid.com. The following module ids are available: PUNCH_LISTS - Enable punch list module SAFETY_NOTES - Public safety notes module SAFETY_MEASUREMENTS - Safety measurements TR/MVR in Finland SAFETY_WALK - Safety walk / safety inspections module ENVIRONMENT_NOTES - Environment notes module ASPHALT - Asphalt measurements QUALITY - The quality module QUALITY_LITE - The quality module to enable Lite usage for quality inspections. Usage of QUALITY_LITE module requires also usage of normal QUALITY module. QUALITY_MEASUREMENTS - Quality measurements e.g 'Tervetalo' in Finland TASK_PLANNING - Task planning for quality module PHOTO_NOTES - Photo notes module LITE - The lite module for subcontractor usage FIELD - The field module for having documents in the field FIELD_LITE - The field module for adding normal FIELD module actions for Lite users. Usage of FIELD_LITE requires using also normal FIELD module. MAPS - Module for enabling maps for notes SIGNATURES - Module for enabling signatures for measurements. Usage of signatures requires also changes for other project information. For more details on how to enable signatures, please contact our support at support@congrid.com. GEO_MODELS - Module for enabling GEO models for notes and project use. BIM_MODELS - Module for enabling BIM models. SITE_DIARY - A site diary module for construction sites MEMO - The Memo module used to taking minutes of meetings and doing site visits without predefined template. CONCRETE - The Concrete record module used to record and log concrete delivery information. |
< string > array |
name |
Project name. |
string |
ownerId |
ID for the project owner company. |
string |
processingStatus |
When triggered copying with "copyFromProjectId", this indicates new project’s progress in copying. Values: QUEUED - New project is waiting for its contents start to be copied. Project should not be used yet. PROCESSING - Project’s contents are under copy. Project should not be used yet. READY - Project copy is finished. Project is available for use. FAILED - Project copy failed for some reason. Contact Congrid support. |
enum (PROCESSING, DELETING, PENDING, DELETE_FAILED, READY, QUEUED, FAILED) |
projectCode |
Project code. |
string |
projectTypeId |
Project type value. Project type is used to distinguish projects between different construction business sectors and separate demo and test projects from official production projects. HOUSING - Projects related to building new housing and building infrastructure. MAINTENANCE - Projects related to maintaining existing building infrastructure. INFRA - Projects related to building roads and other infrastructure except buildings. DEMO - Demo and test projects. TEMPLATE - Template project that can be copied to be base for other project types. |
enum (DEMO, INFRA, MAINTENANCE, TEMPLATE, HOUSING) |
siteManagerText |
Site manager text. Text formatted alternative that can be used to set site manager for project information. It’s recommended to use similar field 'siteManagerUserIds' that link project to user ID. |
string |
siteManagerUserIds |
Site manager user IDs. List user IDs for users who are set as site managers. |
< string > array |
startedAt |
Timestamp for date and time when project is started. |
string (date) |
statusId |
Project status value. |
enum (CLOSED, PAUSED, MAINTENANCE, NOT_STARTED, WARRANTY_REPAIR, ACTIVE) |
Produces
-
application/json
Example HTTP request
Request path
/projects
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"moduleIds" : [ "PUNCH_LISTS", "SAFETY_MEASUREMENTS" ],
"name" : "Example project name",
"ownerId" : "ABC",
"projectCode" : "ABC-1",
"projectTypeId" : "HOUSING"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.11.2. POST /projects
Description
Project is one of the main objects in the system. All data associated with a project can be roughly split in two categories: the mostly static base data configured at start of the project and user generated data created on a day-to-day basis.
We strongly encourage you to properly configure the base data at start of the project to make the day to day user experience as fluent as possible. This is however not mandatory or enforced by any means and you can always update the base data at any time during the project.
The project base data consists of the following:
-
Companies or subcontractors participating in the project.
-
Floor plans of the construction site.
-
Targets that specify the hierarchical structure of the physical buildings and areas of the construction site.
-
Users that are allowed to access the project data.
-
AD configuration for role management through AD (see POST request to endpoint for more details).
POST creates a new project to the system and returns a project object with unique project id
set. Use this id in all the future API requests related to this project.
The available modules for the project are defined when the project is created. The modules can later be changed through the Congrid UI.
As the project is created the system will automatically add one company to the project. This is the company specified by the ownerId
response property and is the company id of the API account user. Performing a GET to the companies endpoint should return that company.
AD-GROUPS (access right management)
The project can have AD groups associated with it to streamline the user access right management. The roles for the project can be configured with AD groups. In practise this means that each of the roles listed below can have multiple AD groups associated with them. All users of those AD groups will then automatically get the corresponding project roles when they login through AD.
For example:
The project is configured with the following roles:
adConfiguration: { projectLiveAdmin: ["PROJ_A_USERS", "CONGRID_ADMINS"], projectLiveView: ["MANAGERS", "ACCOUNTANTS"], projectClientAdmin: ["PROJ_A_USERS"] }
This configuration would map users from the following AD groups to Congrid roles in the following way:
-
PROJ_A_USERS - users in this AD group have access to Live as Admin and can use the mobile application.
-
CONGRID_ADMINS - users in this AD group have access to Live as Admins.
-
MANAGERS - users in this AD group have access to Live as View only users.
-
ACCOUNTANTS - users in this AD group have access to Live as View only users.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
adConfiguration |
Project AD configurations. For more details about how project AD configuration is done and for help in adding configuration, please contact Congrid support at support@congrid.com or your designated support person. |
enum (projectLiveAdmin, projectClientAdmin, projectLiveView, projectLiveEdit) |
companyUnitId |
Related company unit. |
string |
constructionManagerText |
Construction manager text. Text formatted alternative that can be used to set construction manager for project information. It’s recommended to use similar field 'constructionManagerUserIds' that link project to user ID. |
string |
constructionManagerUserIds |
Construction manager user IDs. List user IDs for users who are set as construction managers. |
< string > array |
copyFromProjectId |
At POST, you can create copy from existing project writing source project’s ID to this field. As response you will receive the new project. Observe that project’s field "processingStatus" to see when backend has finished copying the source project. Notice that copying might take several hours depending on size of the source project. Currently only Template-type projects can be copied. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
defaultCurrencyId |
Currency that is used in project’s accounting by default. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
finishedAt |
Timestamp for date and time when project is finished. |
string (date) |
headOfUnitText |
Head of unit text. Text formatted alternative that can be used to set head of unit for project information. It’s recommended to use similar field 'headOfUnitUserIds' that link project to user ID. |
string |
headOfUnitUserIds |
Head of unit user IDs. List user IDs for users who are set as head of unit. |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
moduleIds |
An array of module ids that are enabled for the project. Application modules are used select which parts of the system are enabled for each project. Modules are project specific. For more details about each module and how they should be used please contact our support at support@congrid.com. The following module ids are available: PUNCH_LISTS - Enable punch list module SAFETY_NOTES - Public safety notes module SAFETY_MEASUREMENTS - Safety measurements TR/MVR in Finland SAFETY_WALK - Safety walk / safety inspections module ENVIRONMENT_NOTES - Environment notes module ASPHALT - Asphalt measurements QUALITY - The quality module QUALITY_LITE - The quality module to enable Lite usage for quality inspections. Usage of QUALITY_LITE module requires also usage of normal QUALITY module. QUALITY_MEASUREMENTS - Quality measurements e.g 'Tervetalo' in Finland TASK_PLANNING - Task planning for quality module PHOTO_NOTES - Photo notes module LITE - The lite module for subcontractor usage FIELD - The field module for having documents in the field FIELD_LITE - The field module for adding normal FIELD module actions for Lite users. Usage of FIELD_LITE requires using also normal FIELD module. MAPS - Module for enabling maps for notes SIGNATURES - Module for enabling signatures for measurements. Usage of signatures requires also changes for other project information. For more details on how to enable signatures, please contact our support at support@congrid.com. GEO_MODELS - Module for enabling GEO models for notes and project use. BIM_MODELS - Module for enabling BIM models. SITE_DIARY - A site diary module for construction sites MEMO - The Memo module used to taking minutes of meetings and doing site visits without predefined template. CONCRETE - The Concrete record module used to record and log concrete delivery information. |
< string > array |
name |
Project name. |
string |
ownerId |
ID for the project owner company. |
string |
processingStatus |
When triggered copying with "copyFromProjectId", this indicates new project’s progress in copying. Values: QUEUED - New project is waiting for its contents start to be copied. Project should not be used yet. PROCESSING - Project’s contents are under copy. Project should not be used yet. READY - Project copy is finished. Project is available for use. FAILED - Project copy failed for some reason. Contact Congrid support. |
enum (PROCESSING, DELETING, PENDING, DELETE_FAILED, READY, QUEUED, FAILED) |
projectCode |
Project code. |
string |
projectTypeId |
Project type value. Project type is used to distinguish projects between different construction business sectors and separate demo and test projects from official production projects. HOUSING - Projects related to building new housing and building infrastructure. MAINTENANCE - Projects related to maintaining existing building infrastructure. INFRA - Projects related to building roads and other infrastructure except buildings. DEMO - Demo and test projects. TEMPLATE - Template project that can be copied to be base for other project types. |
enum (DEMO, INFRA, MAINTENANCE, TEMPLATE, HOUSING) |
siteManagerText |
Site manager text. Text formatted alternative that can be used to set site manager for project information. It’s recommended to use similar field 'siteManagerUserIds' that link project to user ID. |
string |
siteManagerUserIds |
Site manager user IDs. List user IDs for users who are set as site managers. |
< string > array |
startedAt |
Timestamp for date and time when project is started. |
string (date) |
statusId |
Project status value. |
enum (CLOSED, PAUSED, MAINTENANCE, NOT_STARTED, WARRANTY_REPAIR, ACTIVE) |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
adConfiguration |
Project AD configurations. For more details about how project AD configuration is done and for help in adding configuration, please contact Congrid support at support@congrid.com or your designated support person. |
enum (projectLiveAdmin, projectClientAdmin, projectLiveView, projectLiveEdit) |
addressId |
Project address ID. |
string |
companyUnitId |
Related company unit. |
string |
constructionManagerText |
Construction manager text. Text formatted alternative that can be used to set construction manager for project information. It’s recommended to use similar field 'constructionManagerUserIds' that link project to user ID. |
string |
constructionManagerUserIds |
Construction manager user IDs. List user IDs for users who are set as construction managers. |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
defaultCurrencyId |
Currency that is used in project’s accounting by default. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
finishedAt |
Timestamp for date and time when project is finished. |
string (date) |
headOfUnitText |
Head of unit text. Text formatted alternative that can be used to set head of unit for project information. It’s recommended to use similar field 'headOfUnitUserIds' that link project to user ID. |
string |
headOfUnitUserIds |
Head of unit user IDs. List user IDs for users who are set as head of unit. |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moduleIds |
An array of module ids that are enabled for the project. Application modules are used select which parts of the system are enabled for each project. Modules are project specific. For more details about each module and how they should be used please contact our support at support@congrid.com. The following module ids are available: PUNCH_LISTS - Enable punch list module SAFETY_NOTES - Public safety notes module SAFETY_MEASUREMENTS - Safety measurements TR/MVR in Finland SAFETY_WALK - Safety walk / safety inspections module ENVIRONMENT_NOTES - Environment notes module ASPHALT - Asphalt measurements QUALITY - The quality module QUALITY_LITE - The quality module to enable Lite usage for quality inspections. Usage of QUALITY_LITE module requires also usage of normal QUALITY module. QUALITY_MEASUREMENTS - Quality measurements e.g 'Tervetalo' in Finland TASK_PLANNING - Task planning for quality module PHOTO_NOTES - Photo notes module LITE - The lite module for subcontractor usage FIELD - The field module for having documents in the field FIELD_LITE - The field module for adding normal FIELD module actions for Lite users. Usage of FIELD_LITE requires using also normal FIELD module. MAPS - Module for enabling maps for notes SIGNATURES - Module for enabling signatures for measurements. Usage of signatures requires also changes for other project information. For more details on how to enable signatures, please contact our support at support@congrid.com. GEO_MODELS - Module for enabling GEO models for notes and project use. BIM_MODELS - Module for enabling BIM models. SITE_DIARY - A site diary module for construction sites MEMO - The Memo module used to taking minutes of meetings and doing site visits without predefined template. CONCRETE - The Concrete record module used to record and log concrete delivery information. |
< string > array |
name |
Project name. |
string |
ownerId |
ID for the project owner company. |
string |
processingStatus |
When triggered copying with "copyFromProjectId", this indicates new project’s progress in copying. Values: QUEUED - New project is waiting for its contents start to be copied. Project should not be used yet. PROCESSING - Project’s contents are under copy. Project should not be used yet. READY - Project copy is finished. Project is available for use. FAILED - Project copy failed for some reason. Contact Congrid support. |
enum (PROCESSING, DELETING, PENDING, DELETE_FAILED, READY, QUEUED, FAILED) |
projectCode |
Project code. |
string |
projectTypeId |
Project type value. Project type is used to distinguish projects between different construction business sectors and separate demo and test projects from official production projects. HOUSING - Projects related to building new housing and building infrastructure. MAINTENANCE - Projects related to maintaining existing building infrastructure. INFRA - Projects related to building roads and other infrastructure except buildings. DEMO - Demo and test projects. TEMPLATE - Template project that can be copied to be base for other project types. |
enum (DEMO, INFRA, MAINTENANCE, TEMPLATE, HOUSING) |
siteManagerText |
Site manager text. Text formatted alternative that can be used to set site manager for project information. It’s recommended to use similar field 'siteManagerUserIds' that link project to user ID. |
string |
siteManagerUserIds |
Site manager user IDs. List user IDs for users who are set as site managers. |
< string > array |
startedAt |
Timestamp for date and time when project is started. |
string (date) |
statusId |
Project status value. |
enum (CLOSED, PAUSED, MAINTENANCE, NOT_STARTED, WARRANTY_REPAIR, ACTIVE) |
Produces
-
application/json
Example HTTP request
Request path
/projects
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"moduleIds" : [ "PUNCH_LISTS", "SAFETY_MEASUREMENTS" ],
"name" : "Example project name",
"ownerId" : "ABC",
"projectCode" : "ABC-1",
"projectTypeId" : "HOUSING"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"moduleIds" : [ "PUNCH_LISTS", "SAFETY_MEASUREMENTS" ],
"name" : "Example project name",
"ownerId" : "ABC",
"projectCode" : "ABC-1",
"projectTypeId" : "HOUSING"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.11.3. GET /projects/{id}
Description
Project is one of the main objects in the system. All data associated with a project can be roughly split in two categories: the mostly static base data configured at start of the project and user generated data created on a day-to-day basis.
We strongly encourage you to properly configure the base data at start of the project to make the day to day user experience as fluent as possible. This is however not mandatory or enforced by any means and you can always update the base data at any time during the project.
The project base data consists of the following:
-
Companies or subcontractors participating in the project.
-
Floor plans of the construction site.
-
Targets that specify the hierarchical structure of the physical buildings and areas of the construction site.
-
Users that are allowed to access the project data.
-
AD configuration for role management through AD (see POST request to endpoint for more details).
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
adConfiguration |
Project AD configurations. For more details about how project AD configuration is done and for help in adding configuration, please contact Congrid support at support@congrid.com or your designated support person. |
enum (projectLiveAdmin, projectClientAdmin, projectLiveView, projectLiveEdit) |
addressId |
Project address ID. |
string |
companyUnitId |
Related company unit. |
string |
constructionManagerText |
Construction manager text. Text formatted alternative that can be used to set construction manager for project information. It’s recommended to use similar field 'constructionManagerUserIds' that link project to user ID. |
string |
constructionManagerUserIds |
Construction manager user IDs. List user IDs for users who are set as construction managers. |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
defaultCurrencyId |
Currency that is used in project’s accounting by default. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
finishedAt |
Timestamp for date and time when project is finished. |
string (date) |
headOfUnitText |
Head of unit text. Text formatted alternative that can be used to set head of unit for project information. It’s recommended to use similar field 'headOfUnitUserIds' that link project to user ID. |
string |
headOfUnitUserIds |
Head of unit user IDs. List user IDs for users who are set as head of unit. |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moduleIds |
An array of module ids that are enabled for the project. Application modules are used select which parts of the system are enabled for each project. Modules are project specific. For more details about each module and how they should be used please contact our support at support@congrid.com. The following module ids are available: PUNCH_LISTS - Enable punch list module SAFETY_NOTES - Public safety notes module SAFETY_MEASUREMENTS - Safety measurements TR/MVR in Finland SAFETY_WALK - Safety walk / safety inspections module ENVIRONMENT_NOTES - Environment notes module ASPHALT - Asphalt measurements QUALITY - The quality module QUALITY_LITE - The quality module to enable Lite usage for quality inspections. Usage of QUALITY_LITE module requires also usage of normal QUALITY module. QUALITY_MEASUREMENTS - Quality measurements e.g 'Tervetalo' in Finland TASK_PLANNING - Task planning for quality module PHOTO_NOTES - Photo notes module LITE - The lite module for subcontractor usage FIELD - The field module for having documents in the field FIELD_LITE - The field module for adding normal FIELD module actions for Lite users. Usage of FIELD_LITE requires using also normal FIELD module. MAPS - Module for enabling maps for notes SIGNATURES - Module for enabling signatures for measurements. Usage of signatures requires also changes for other project information. For more details on how to enable signatures, please contact our support at support@congrid.com. GEO_MODELS - Module for enabling GEO models for notes and project use. BIM_MODELS - Module for enabling BIM models. SITE_DIARY - A site diary module for construction sites MEMO - The Memo module used to taking minutes of meetings and doing site visits without predefined template. CONCRETE - The Concrete record module used to record and log concrete delivery information. |
< string > array |
name |
Project name. |
string |
ownerId |
ID for the project owner company. |
string |
processingStatus |
When triggered copying with "copyFromProjectId", this indicates new project’s progress in copying. Values: QUEUED - New project is waiting for its contents start to be copied. Project should not be used yet. PROCESSING - Project’s contents are under copy. Project should not be used yet. READY - Project copy is finished. Project is available for use. FAILED - Project copy failed for some reason. Contact Congrid support. |
enum (PROCESSING, DELETING, PENDING, DELETE_FAILED, READY, QUEUED, FAILED) |
projectCode |
Project code. |
string |
projectTypeId |
Project type value. Project type is used to distinguish projects between different construction business sectors and separate demo and test projects from official production projects. HOUSING - Projects related to building new housing and building infrastructure. MAINTENANCE - Projects related to maintaining existing building infrastructure. INFRA - Projects related to building roads and other infrastructure except buildings. DEMO - Demo and test projects. TEMPLATE - Template project that can be copied to be base for other project types. |
enum (DEMO, INFRA, MAINTENANCE, TEMPLATE, HOUSING) |
siteManagerText |
Site manager text. Text formatted alternative that can be used to set site manager for project information. It’s recommended to use similar field 'siteManagerUserIds' that link project to user ID. |
string |
siteManagerUserIds |
Site manager user IDs. List user IDs for users who are set as site managers. |
< string > array |
startedAt |
Timestamp for date and time when project is started. |
string (date) |
statusId |
Project status value. |
enum (CLOSED, PAUSED, MAINTENANCE, NOT_STARTED, WARRANTY_REPAIR, ACTIVE) |
Produces
-
application/json
Example HTTP request
Request path
/projects/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"moduleIds" : [ "PUNCH_LISTS", "SAFETY_MEASUREMENTS" ],
"name" : "Example project name",
"ownerId" : "ABC",
"projectCode" : "ABC-1",
"projectTypeId" : "HOUSING"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.11.4. PUT /projects/{id}
Description
Project is one of the main objects in the system. All data associated with a project can be roughly split in two categories: the mostly static base data configured at start of the project and user generated data created on a day-to-day basis.
We strongly encourage you to properly configure the base data at start of the project to make the day to day user experience as fluent as possible. This is however not mandatory or enforced by any means and you can always update the base data at any time during the project.
The project base data consists of the following:
-
Companies or subcontractors participating in the project.
-
Floor plans of the construction site.
-
Targets that specify the hierarchical structure of the physical buildings and areas of the construction site.
-
Users that are allowed to access the project data.
-
AD configuration for role management through AD (see POST request to endpoint for more details).
PUT updates project data. Please note that if you update the AD groups associated with the project you will have to update all the groups in the adConfiguration
property. Every group that is not given or given an empty array is reset. Please refer to the POST to project endpoint for more details how the access rights are configured.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
adConfiguration |
Project AD configurations. For more details about how project AD configuration is done and for help in adding configuration, please contact Congrid support at support@congrid.com or your designated support person. |
enum (projectLiveAdmin, projectClientAdmin, projectLiveView, projectLiveEdit) |
companyUnitId |
Related company unit. |
string |
constructionManagerText |
Construction manager text. Text formatted alternative that can be used to set construction manager for project information. It’s recommended to use similar field 'constructionManagerUserIds' that link project to user ID. |
string |
constructionManagerUserIds |
Construction manager user IDs. List user IDs for users who are set as construction managers. |
< string > array |
copyFromProjectId |
At POST, you can create copy from existing project writing source project’s ID to this field. As response you will receive the new project. Observe that project’s field "processingStatus" to see when backend has finished copying the source project. Notice that copying might take several hours depending on size of the source project. Currently only Template-type projects can be copied. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
defaultCurrencyId |
Currency that is used in project’s accounting by default. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
finishedAt |
Timestamp for date and time when project is finished. |
string (date) |
headOfUnitText |
Head of unit text. Text formatted alternative that can be used to set head of unit for project information. It’s recommended to use similar field 'headOfUnitUserIds' that link project to user ID. |
string |
headOfUnitUserIds |
Head of unit user IDs. List user IDs for users who are set as head of unit. |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
moduleIds |
An array of module ids that are enabled for the project. Application modules are used select which parts of the system are enabled for each project. Modules are project specific. For more details about each module and how they should be used please contact our support at support@congrid.com. The following module ids are available: PUNCH_LISTS - Enable punch list module SAFETY_NOTES - Public safety notes module SAFETY_MEASUREMENTS - Safety measurements TR/MVR in Finland SAFETY_WALK - Safety walk / safety inspections module ENVIRONMENT_NOTES - Environment notes module ASPHALT - Asphalt measurements QUALITY - The quality module QUALITY_LITE - The quality module to enable Lite usage for quality inspections. Usage of QUALITY_LITE module requires also usage of normal QUALITY module. QUALITY_MEASUREMENTS - Quality measurements e.g 'Tervetalo' in Finland TASK_PLANNING - Task planning for quality module PHOTO_NOTES - Photo notes module LITE - The lite module for subcontractor usage FIELD - The field module for having documents in the field FIELD_LITE - The field module for adding normal FIELD module actions for Lite users. Usage of FIELD_LITE requires using also normal FIELD module. MAPS - Module for enabling maps for notes SIGNATURES - Module for enabling signatures for measurements. Usage of signatures requires also changes for other project information. For more details on how to enable signatures, please contact our support at support@congrid.com. GEO_MODELS - Module for enabling GEO models for notes and project use. BIM_MODELS - Module for enabling BIM models. SITE_DIARY - A site diary module for construction sites MEMO - The Memo module used to taking minutes of meetings and doing site visits without predefined template. CONCRETE - The Concrete record module used to record and log concrete delivery information. |
< string > array |
name |
Project name. |
string |
ownerId |
ID for the project owner company. |
string |
processingStatus |
When triggered copying with "copyFromProjectId", this indicates new project’s progress in copying. Values: QUEUED - New project is waiting for its contents start to be copied. Project should not be used yet. PROCESSING - Project’s contents are under copy. Project should not be used yet. READY - Project copy is finished. Project is available for use. FAILED - Project copy failed for some reason. Contact Congrid support. |
enum (PROCESSING, DELETING, PENDING, DELETE_FAILED, READY, QUEUED, FAILED) |
projectCode |
Project code. |
string |
projectTypeId |
Project type value. Project type is used to distinguish projects between different construction business sectors and separate demo and test projects from official production projects. HOUSING - Projects related to building new housing and building infrastructure. MAINTENANCE - Projects related to maintaining existing building infrastructure. INFRA - Projects related to building roads and other infrastructure except buildings. DEMO - Demo and test projects. TEMPLATE - Template project that can be copied to be base for other project types. |
enum (DEMO, INFRA, MAINTENANCE, TEMPLATE, HOUSING) |
siteManagerText |
Site manager text. Text formatted alternative that can be used to set site manager for project information. It’s recommended to use similar field 'siteManagerUserIds' that link project to user ID. |
string |
siteManagerUserIds |
Site manager user IDs. List user IDs for users who are set as site managers. |
< string > array |
startedAt |
Timestamp for date and time when project is started. |
string (date) |
statusId |
Project status value. |
enum (CLOSED, PAUSED, MAINTENANCE, NOT_STARTED, WARRANTY_REPAIR, ACTIVE) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
adConfiguration |
Project AD configurations. For more details about how project AD configuration is done and for help in adding configuration, please contact Congrid support at support@congrid.com or your designated support person. |
enum (projectLiveAdmin, projectClientAdmin, projectLiveView, projectLiveEdit) |
addressId |
Project address ID. |
string |
companyUnitId |
Related company unit. |
string |
constructionManagerText |
Construction manager text. Text formatted alternative that can be used to set construction manager for project information. It’s recommended to use similar field 'constructionManagerUserIds' that link project to user ID. |
string |
constructionManagerUserIds |
Construction manager user IDs. List user IDs for users who are set as construction managers. |
< string > array |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
defaultCurrencyId |
Currency that is used in project’s accounting by default. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
finishedAt |
Timestamp for date and time when project is finished. |
string (date) |
headOfUnitText |
Head of unit text. Text formatted alternative that can be used to set head of unit for project information. It’s recommended to use similar field 'headOfUnitUserIds' that link project to user ID. |
string |
headOfUnitUserIds |
Head of unit user IDs. List user IDs for users who are set as head of unit. |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
moduleIds |
An array of module ids that are enabled for the project. Application modules are used select which parts of the system are enabled for each project. Modules are project specific. For more details about each module and how they should be used please contact our support at support@congrid.com. The following module ids are available: PUNCH_LISTS - Enable punch list module SAFETY_NOTES - Public safety notes module SAFETY_MEASUREMENTS - Safety measurements TR/MVR in Finland SAFETY_WALK - Safety walk / safety inspections module ENVIRONMENT_NOTES - Environment notes module ASPHALT - Asphalt measurements QUALITY - The quality module QUALITY_LITE - The quality module to enable Lite usage for quality inspections. Usage of QUALITY_LITE module requires also usage of normal QUALITY module. QUALITY_MEASUREMENTS - Quality measurements e.g 'Tervetalo' in Finland TASK_PLANNING - Task planning for quality module PHOTO_NOTES - Photo notes module LITE - The lite module for subcontractor usage FIELD - The field module for having documents in the field FIELD_LITE - The field module for adding normal FIELD module actions for Lite users. Usage of FIELD_LITE requires using also normal FIELD module. MAPS - Module for enabling maps for notes SIGNATURES - Module for enabling signatures for measurements. Usage of signatures requires also changes for other project information. For more details on how to enable signatures, please contact our support at support@congrid.com. GEO_MODELS - Module for enabling GEO models for notes and project use. BIM_MODELS - Module for enabling BIM models. SITE_DIARY - A site diary module for construction sites MEMO - The Memo module used to taking minutes of meetings and doing site visits without predefined template. CONCRETE - The Concrete record module used to record and log concrete delivery information. |
< string > array |
name |
Project name. |
string |
ownerId |
ID for the project owner company. |
string |
processingStatus |
When triggered copying with "copyFromProjectId", this indicates new project’s progress in copying. Values: QUEUED - New project is waiting for its contents start to be copied. Project should not be used yet. PROCESSING - Project’s contents are under copy. Project should not be used yet. READY - Project copy is finished. Project is available for use. FAILED - Project copy failed for some reason. Contact Congrid support. |
enum (PROCESSING, DELETING, PENDING, DELETE_FAILED, READY, QUEUED, FAILED) |
projectCode |
Project code. |
string |
projectTypeId |
Project type value. Project type is used to distinguish projects between different construction business sectors and separate demo and test projects from official production projects. HOUSING - Projects related to building new housing and building infrastructure. MAINTENANCE - Projects related to maintaining existing building infrastructure. INFRA - Projects related to building roads and other infrastructure except buildings. DEMO - Demo and test projects. TEMPLATE - Template project that can be copied to be base for other project types. |
enum (DEMO, INFRA, MAINTENANCE, TEMPLATE, HOUSING) |
siteManagerText |
Site manager text. Text formatted alternative that can be used to set site manager for project information. It’s recommended to use similar field 'siteManagerUserIds' that link project to user ID. |
string |
siteManagerUserIds |
Site manager user IDs. List user IDs for users who are set as site managers. |
< string > array |
startedAt |
Timestamp for date and time when project is started. |
string (date) |
statusId |
Project status value. |
enum (CLOSED, PAUSED, MAINTENANCE, NOT_STARTED, WARRANTY_REPAIR, ACTIVE) |
Produces
-
application/json
Example HTTP request
Request path
/projects/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"moduleIds" : [ "PUNCH_LISTS", "SAFETY_MEASUREMENTS" ],
"name" : "Example project name",
"ownerId" : "ABC",
"projectCode" : "ABC-1",
"projectTypeId" : "HOUSING"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123,
"moduleIds" : [ "PUNCH_LISTS", "SAFETY_MEASUREMENTS" ],
"name" : "Example project name",
"ownerId" : "ABC",
"projectCode" : "ABC-1",
"projectTypeId" : "HOUSING"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.11.5. GET /projects/{projectId}/address
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
address1 |
Example : |
string |
address2 |
Example : |
string |
city |
Example : |
string |
countryCode |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
postalCode |
Example : |
string |
projectId |
Project id if this address is that project’s address. For other addresses (like Contacts), this is null. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/address
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.11.6. PUT /projects/{projectId}/address
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
address1 |
Example : |
string |
address2 |
Example : |
string |
city |
Example : |
string |
countryCode |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
postalCode |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
address1 |
Example : |
string |
address2 |
Example : |
string |
city |
Example : |
string |
countryCode |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
postalCode |
Example : |
string |
projectId |
Project id if this address is that project’s address. For other addresses (like Contacts), this is null. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/address
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.11.7. PATCH /projects/{projectId}/address
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
address1 |
Example : |
string |
address2 |
Example : |
string |
city |
Example : |
string |
countryCode |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
postalCode |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
address1 |
Example : |
string |
address2 |
Example : |
string |
city |
Example : |
string |
countryCode |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
postalCode |
Example : |
string |
projectId |
Project id if this address is that project’s address. For other addresses (like Contacts), this is null. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/address
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12. Quality Matrix
2.12.1. GET /inspectionDocuments
Description
This is old version of the endpoint accesses all work section documents visible for accessing user. Using endpoint qualityDocuments
instead of this is recommended. Difference is that this endpoint is limited to matrix cells, while qualityDocuments
supports wider choice of document connections.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
code |
Fetch all items whose code contains a given string |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionDocuments
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.2. POST /inspectionDocuments
Description
This is old version of the endpoint accesses all work section documents visible for accessing user. Using endpoint qualityDocuments
instead of this is recommended. Difference is that this endpoint is limited to matrix cells, while qualityDocuments
supports wider choice of document connections.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionDocuments
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.3. GET /inspectionDocuments/{id}
Description
This is old version of the endpoint accesses all work section documents visible for accessing user. Using endpoint qualityDocuments
instead of this is recommended. Difference is that this endpoint is limited to matrix cells, while qualityDocuments
supports wider choice of document connections.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionDocuments/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.4. PUT /inspectionDocuments/{id}
Description
This is old version of the endpoint accesses all work section documents visible for accessing user. Using endpoint qualityDocuments
instead of this is recommended. Difference is that this endpoint is limited to matrix cells, while qualityDocuments
supports wider choice of document connections.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionDocuments/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.5. DELETE /inspectionDocuments/{id}
Description
This is old version of the endpoint accesses all work section documents visible for accessing user. Using endpoint qualityDocuments
instead of this is recommended. Difference is that this endpoint is limited to matrix cells, while qualityDocuments
supports wider choice of document connections.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/inspectionDocuments/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.6. GET /matrices
Description
This endpoint accesses all matrices visible for accessing user.
Quality matrix is a collection of quality related data in matrix format.
Content of the quality matrix is all quality related inspection, documents and other data that project gathers during the project.
Matrix is always project specific. All projects are not similar and, therefore, also matrices are different between projects. Projects always start with similar matrix, but depending on the project scope and purpose matrix can be edit.
The base matrix that projects start with are either system matrices created by Congrid or company matrices. System matrices are always based on some best practices. For example, Finnish "Talo 80" is a set of quality inspection templates that can be used as a reference for inspections. Often companies have need to somehow modify the standard set of inspections. In that case, they’ll create own company specific base matrix to be used on company projects.
Company and system matrices are distinguished by companyId
value. Matrix that belongs to any company has that Congrid company ID set as matrix companyId
value. Further, property projectId
defines what project matrix belongs to.
All matrices belong to some project even if they are used as company or system matrix. Both system and company matrices are developed on some template project and, when matrix is built, it is shared to other company projects or to all system projects (can be don only by Congrid admins). Sharing of matrix is done with properties isAvailableForCompany
and isAvailableForAll
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
enabled |
Filter objects based on "enabled" field. Enabled boolean defines if matrix is usable for the project. True - matrix is enabled for the project and False - matrix is not in use. |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
availableForCompany |
Filter objects based on "availableForCompany" field. "Available for company" boolean field defines if matrix is available for other projects within company projects. |
string |
Query |
availableForAll |
Filter objects based on "availableForAll" field. "Available for all" boolean field defines if matrix is available for other projects within Congrid system. |
string |
Query |
copiedFromMatrixId |
Filter objects based on "copiedFromMatrixId" field. "Copied from matrix ID" is ID of the matrix that was used as a base for matrix. When matrix is copied the original matrix ID is set for this field as a backwards reference. Field cannot be changed once matrix is copied. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyId |
Company ID for company that owns the matrix. |
string |
copiedFromMatrixId |
Matrix ID for the matrix that was used to create / copy the matrix. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isAvailableForAll |
Defines if the matrix is shared on system level. Matrices shared on system level are visible for all projects and can be copied to use in all projects. Only very few special matrices are shared on system level. |
boolean |
isAvailableForCompany |
Defines if the matrix is shared on company level. Matrices shared on company level are visible for all company projects and can be copied to use in those projects. |
boolean |
isEnabled |
Defines if the matrix is enabled and available for use. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the matrix as set by user. Name can be null if user has not set any name. |
string |
projectId |
Project ID for project that owns the matrix. |
string |
Produces
-
application/json
Example HTTP request
Request path
/matrices
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.7. GET /matrices/{id}
Description
This endpoint accesses all matrices visible for accessing user.
Quality matrix is a collection of quality related data in matrix format.
Content of the quality matrix is all quality related inspection, documents and other data that project gathers during the project.
Matrix is always project specific. All projects are not similar and, therefore, also matrices are different between projects. Projects always start with similar matrix, but depending on the project scope and purpose matrix can be edit.
The base matrix that projects start with are either system matrices created by Congrid or company matrices. System matrices are always based on some best practices. For example, Finnish "Talo 80" is a set of quality inspection templates that can be used as a reference for inspections. Often companies have need to somehow modify the standard set of inspections. In that case, they’ll create own company specific base matrix to be used on company projects.
Company and system matrices are distinguished by companyId
value. Matrix that belongs to any company has that Congrid company ID set as matrix companyId
value. Further, property projectId
defines what project matrix belongs to.
All matrices belong to some project even if they are used as company or system matrix. Both system and company matrices are developed on some template project and, when matrix is built, it is shared to other company projects or to all system projects (can be don only by Congrid admins). Sharing of matrix is done with properties isAvailableForCompany
and isAvailableForAll
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Company ID for company that owns the matrix. |
string |
copiedFromMatrixId |
Matrix ID for the matrix that was used to create / copy the matrix. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isAvailableForAll |
Defines if the matrix is shared on system level. Matrices shared on system level are visible for all projects and can be copied to use in all projects. Only very few special matrices are shared on system level. |
boolean |
isAvailableForCompany |
Defines if the matrix is shared on company level. Matrices shared on company level are visible for all company projects and can be copied to use in those projects. |
boolean |
isEnabled |
Defines if the matrix is enabled and available for use. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the matrix as set by user. Name can be null if user has not set any name. |
string |
projectId |
Project ID for project that owns the matrix. |
string |
Produces
-
application/json
Example HTTP request
Request path
/matrices/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.8. PUT /matrices/{id}
Description
This endpoint accesses all matrices visible for accessing user.
Quality matrix is a collection of quality related data in matrix format.
Content of the quality matrix is all quality related inspection, documents and other data that project gathers during the project.
Matrix is always project specific. All projects are not similar and, therefore, also matrices are different between projects. Projects always start with similar matrix, but depending on the project scope and purpose matrix can be edit.
The base matrix that projects start with are either system matrices created by Congrid or company matrices. System matrices are always based on some best practices. For example, Finnish "Talo 80" is a set of quality inspection templates that can be used as a reference for inspections. Often companies have need to somehow modify the standard set of inspections. In that case, they’ll create own company specific base matrix to be used on company projects.
Company and system matrices are distinguished by companyId
value. Matrix that belongs to any company has that Congrid company ID set as matrix companyId
value. Further, property projectId
defines what project matrix belongs to.
All matrices belong to some project even if they are used as company or system matrix. Both system and company matrices are developed on some template project and, when matrix is built, it is shared to other company projects or to all system projects (can be don only by Congrid admins). Sharing of matrix is done with properties isAvailableForCompany
and isAvailableForAll
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isAvailableForAll |
Defines if the matrix is shared on system level. Matrices shared on system level are visible for all projects and can be copied to use in all projects. Only very few special matrices are shared on system level. |
boolean |
isAvailableForCompany |
Defines if the matrix is shared on company level. Matrices shared on company level are visible for all company projects and can be copied to use in those projects. |
boolean |
isEnabled |
Defines if the matrix is enabled and available for use. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name of the matrix as set by user. Name can be null if user has not set any name. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Company ID for company that owns the matrix. |
string |
copiedFromMatrixId |
Matrix ID for the matrix that was used to create / copy the matrix. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isAvailableForAll |
Defines if the matrix is shared on system level. Matrices shared on system level are visible for all projects and can be copied to use in all projects. Only very few special matrices are shared on system level. |
boolean |
isAvailableForCompany |
Defines if the matrix is shared on company level. Matrices shared on company level are visible for all company projects and can be copied to use in those projects. |
boolean |
isEnabled |
Defines if the matrix is enabled and available for use. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the matrix as set by user. Name can be null if user has not set any name. |
string |
projectId |
Project ID for project that owns the matrix. |
string |
Produces
-
application/json
Example HTTP request
Request path
/matrices/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.9. GET /matrixCells
Description
This endpoint accesses all matrix cells visible for accessing user.
Matrix cell represents a single cell in quality matrix.
GET returns all matrix cells.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
data |
Example : |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
enabled |
Defines if matrix cell is enabled. Only enabled cells are used when doing quality inspections or other quality related data is added. If cell is disabled all links in the matrix views are hidden and related inspection templates are not shown in the Congrid mobile application. Matrix cells are disabled to make user’s life easier. When user sees only relevant quality templates and other information, it’s easier to concentrate on performing better quality inspections. |
boolean |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
matrixId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/matrixCells
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.10. GET /matrixCells/{id}
Description
This endpoint accesses all matrix cells visible for accessing user.
Matrix cell represents a single cell in quality matrix.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
data |
Example : |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
enabled |
Defines if matrix cell is enabled. Only enabled cells are used when doing quality inspections or other quality related data is added. If cell is disabled all links in the matrix views are hidden and related inspection templates are not shown in the Congrid mobile application. Matrix cells are disabled to make user’s life easier. When user sees only relevant quality templates and other information, it’s easier to concentrate on performing better quality inspections. |
boolean |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
matrixId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/matrixCells/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.11. PUT /matrixCells/{id}
Description
This endpoint accesses all matrix cells visible for accessing user.
Matrix cell represents a single cell in quality matrix.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
enabled |
Defines if matrix cell is enabled. Only enabled cells are used when doing quality inspections or other quality related data is added. If cell is disabled all links in the matrix views are hidden and related inspection templates are not shown in the Congrid mobile application. Matrix cells are disabled to make user’s life easier. When user sees only relevant quality templates and other information, it’s easier to concentrate on performing better quality inspections. |
boolean |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
modifiedAt |
Object’s last modification date. |
string (date-time) |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
data |
Example : |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
enabled |
Defines if matrix cell is enabled. Only enabled cells are used when doing quality inspections or other quality related data is added. If cell is disabled all links in the matrix views are hidden and related inspection templates are not shown in the Congrid mobile application. Matrix cells are disabled to make user’s life easier. When user sees only relevant quality templates and other information, it’s easier to concentrate on performing better quality inspections. |
boolean |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
matrixId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/matrixCells/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.12. GET /projects/{projectId}/matrices
Description
This endpoint accesses all matrices from a project given as part of URL.
Quality matrix is a collection of quality related data in matrix format.
Content of the quality matrix is all quality related inspection, documents and other data that project gathers during the project.
Matrix is always project specific. All projects are not similar and, therefore, also matrices are different between projects. Projects always start with similar matrix, but depending on the project scope and purpose matrix can be edit.
The base matrix that projects start with are either system matrices created by Congrid or company matrices. System matrices are always based on some best practices. For example, Finnish "Talo 80" is a set of quality inspection templates that can be used as a reference for inspections. Often companies have need to somehow modify the standard set of inspections. In that case, they’ll create own company specific base matrix to be used on company projects.
Company and system matrices are distinguished by companyId
value. Matrix that belongs to any company has that Congrid company ID set as matrix companyId
value. Further, property projectId
defines what project matrix belongs to.
All matrices belong to some project even if they are used as company or system matrix. Both system and company matrices are developed on some template project and, when matrix is built, it is shared to other company projects or to all system projects (can be don only by Congrid admins). Sharing of matrix is done with properties isAvailableForCompany
and isAvailableForAll
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
enabled |
Filter objects based on "enabled" field. Enabled boolean defines if matrix is usable for the project. True - matrix is enabled for the project and False - matrix is not in use. |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
availableForCompany |
Filter objects based on "availableForCompany" field. "Available for company" boolean field defines if matrix is available for other projects within company projects. |
string |
Query |
availableForAll |
Filter objects based on "availableForAll" field. "Available for all" boolean field defines if matrix is available for other projects within Congrid system. |
string |
Query |
copiedFromMatrixId |
Filter objects based on "copiedFromMatrixId" field. "Copied from matrix ID" is ID of the matrix that was used as a base for matrix. When matrix is copied the original matrix ID is set for this field as a backwards reference. Field cannot be changed once matrix is copied. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyId |
Company ID for company that owns the matrix. |
string |
copiedFromMatrixId |
Matrix ID for the matrix that was used to create / copy the matrix. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isAvailableForAll |
Defines if the matrix is shared on system level. Matrices shared on system level are visible for all projects and can be copied to use in all projects. Only very few special matrices are shared on system level. |
boolean |
isAvailableForCompany |
Defines if the matrix is shared on company level. Matrices shared on company level are visible for all company projects and can be copied to use in those projects. |
boolean |
isEnabled |
Defines if the matrix is enabled and available for use. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the matrix as set by user. Name can be null if user has not set any name. |
string |
projectId |
Project ID for project that owns the matrix. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/matrices
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.13. GET /projects/{projectId}/matrices/{id}
Description
This endpoint accesses all matrices from a project given as part of URL.
Quality matrix is a collection of quality related data in matrix format.
Content of the quality matrix is all quality related inspection, documents and other data that project gathers during the project.
Matrix is always project specific. All projects are not similar and, therefore, also matrices are different between projects. Projects always start with similar matrix, but depending on the project scope and purpose matrix can be edit.
The base matrix that projects start with are either system matrices created by Congrid or company matrices. System matrices are always based on some best practices. For example, Finnish "Talo 80" is a set of quality inspection templates that can be used as a reference for inspections. Often companies have need to somehow modify the standard set of inspections. In that case, they’ll create own company specific base matrix to be used on company projects.
Company and system matrices are distinguished by companyId
value. Matrix that belongs to any company has that Congrid company ID set as matrix companyId
value. Further, property projectId
defines what project matrix belongs to.
All matrices belong to some project even if they are used as company or system matrix. Both system and company matrices are developed on some template project and, when matrix is built, it is shared to other company projects or to all system projects (can be don only by Congrid admins). Sharing of matrix is done with properties isAvailableForCompany
and isAvailableForAll
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Company ID for company that owns the matrix. |
string |
copiedFromMatrixId |
Matrix ID for the matrix that was used to create / copy the matrix. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isAvailableForAll |
Defines if the matrix is shared on system level. Matrices shared on system level are visible for all projects and can be copied to use in all projects. Only very few special matrices are shared on system level. |
boolean |
isAvailableForCompany |
Defines if the matrix is shared on company level. Matrices shared on company level are visible for all company projects and can be copied to use in those projects. |
boolean |
isEnabled |
Defines if the matrix is enabled and available for use. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the matrix as set by user. Name can be null if user has not set any name. |
string |
projectId |
Project ID for project that owns the matrix. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/matrices/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.14. PUT /projects/{projectId}/matrices/{id}
Description
This endpoint accesses all matrices from a project given as part of URL.
Quality matrix is a collection of quality related data in matrix format.
Content of the quality matrix is all quality related inspection, documents and other data that project gathers during the project.
Matrix is always project specific. All projects are not similar and, therefore, also matrices are different between projects. Projects always start with similar matrix, but depending on the project scope and purpose matrix can be edit.
The base matrix that projects start with are either system matrices created by Congrid or company matrices. System matrices are always based on some best practices. For example, Finnish "Talo 80" is a set of quality inspection templates that can be used as a reference for inspections. Often companies have need to somehow modify the standard set of inspections. In that case, they’ll create own company specific base matrix to be used on company projects.
Company and system matrices are distinguished by companyId
value. Matrix that belongs to any company has that Congrid company ID set as matrix companyId
value. Further, property projectId
defines what project matrix belongs to.
All matrices belong to some project even if they are used as company or system matrix. Both system and company matrices are developed on some template project and, when matrix is built, it is shared to other company projects or to all system projects (can be don only by Congrid admins). Sharing of matrix is done with properties isAvailableForCompany
and isAvailableForAll
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isAvailableForAll |
Defines if the matrix is shared on system level. Matrices shared on system level are visible for all projects and can be copied to use in all projects. Only very few special matrices are shared on system level. |
boolean |
isAvailableForCompany |
Defines if the matrix is shared on company level. Matrices shared on company level are visible for all company projects and can be copied to use in those projects. |
boolean |
isEnabled |
Defines if the matrix is enabled and available for use. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name of the matrix as set by user. Name can be null if user has not set any name. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Company ID for company that owns the matrix. |
string |
copiedFromMatrixId |
Matrix ID for the matrix that was used to create / copy the matrix. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isAvailableForAll |
Defines if the matrix is shared on system level. Matrices shared on system level are visible for all projects and can be copied to use in all projects. Only very few special matrices are shared on system level. |
boolean |
isAvailableForCompany |
Defines if the matrix is shared on company level. Matrices shared on company level are visible for all company projects and can be copied to use in those projects. |
boolean |
isEnabled |
Defines if the matrix is enabled and available for use. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name of the matrix as set by user. Name can be null if user has not set any name. |
string |
projectId |
Project ID for project that owns the matrix. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/matrices/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.15. GET /projects/{projectId}/matrixCells
Description
This endpoint accesses all matrix cells from a project given as part of URL.
Matrix cell represents a single cell in quality matrix.
GET returns all matrix cells.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
data |
Example : |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
enabled |
Defines if matrix cell is enabled. Only enabled cells are used when doing quality inspections or other quality related data is added. If cell is disabled all links in the matrix views are hidden and related inspection templates are not shown in the Congrid mobile application. Matrix cells are disabled to make user’s life easier. When user sees only relevant quality templates and other information, it’s easier to concentrate on performing better quality inspections. |
boolean |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
matrixId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/matrixCells
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.16. GET /projects/{projectId}/matrixCells/{id}
Description
This endpoint accesses all matrix cells from a project given as part of URL.
Matrix cell represents a single cell in quality matrix.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
data |
Example : |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
enabled |
Defines if matrix cell is enabled. Only enabled cells are used when doing quality inspections or other quality related data is added. If cell is disabled all links in the matrix views are hidden and related inspection templates are not shown in the Congrid mobile application. Matrix cells are disabled to make user’s life easier. When user sees only relevant quality templates and other information, it’s easier to concentrate on performing better quality inspections. |
boolean |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
matrixId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/matrixCells/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.17. PUT /projects/{projectId}/matrixCells/{id}
Description
This endpoint accesses all matrix cells from a project given as part of URL.
Matrix cell represents a single cell in quality matrix.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
enabled |
Defines if matrix cell is enabled. Only enabled cells are used when doing quality inspections or other quality related data is added. If cell is disabled all links in the matrix views are hidden and related inspection templates are not shown in the Congrid mobile application. Matrix cells are disabled to make user’s life easier. When user sees only relevant quality templates and other information, it’s easier to concentrate on performing better quality inspections. |
boolean |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
modifiedAt |
Object’s last modification date. |
string (date-time) |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
data |
Example : |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
enabled |
Defines if matrix cell is enabled. Only enabled cells are used when doing quality inspections or other quality related data is added. If cell is disabled all links in the matrix views are hidden and related inspection templates are not shown in the Congrid mobile application. Matrix cells are disabled to make user’s life easier. When user sees only relevant quality templates and other information, it’s easier to concentrate on performing better quality inspections. |
boolean |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
matrixId |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
workActivityId |
Example : |
string |
workSectionId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/matrixCells/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.18. GET /projects/{projectId}/workActivities
Description
This endpoint accesses all work activities from a project given as part of URL.
Work activity identifies one column in the quality matrix.
Work activity together with work section represent a cell in the quality matrix.
GET returns all the work activities.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
activityTypeId |
Work activity type. |
enum (TEXT, FILE, INDUCTION, ACTIVITY, REVIEW, PLAN) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work activity ID. |
string |
orderNumber |
Work activity order number. Order number defines the order of the work activity columns in the matrix presentation. |
integer |
projectId |
Related project ID. Related project owns the work activity object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/workActivities
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.19. GET /projects/{projectId}/workActivities/{id}
Description
This endpoint accesses all work activities from a project given as part of URL.
Work activity identifies one column in the quality matrix.
Work activity together with work section represent a cell in the quality matrix.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
activityTypeId |
Work activity type. |
enum (TEXT, FILE, INDUCTION, ACTIVITY, REVIEW, PLAN) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work activity ID. |
string |
orderNumber |
Work activity order number. Order number defines the order of the work activity columns in the matrix presentation. |
integer |
projectId |
Related project ID. Related project owns the work activity object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/workActivities/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.20. PUT /projects/{projectId}/workActivities/{id}
Description
This endpoint accesses all work activities from a project given as part of URL.
Work activity identifies one column in the quality matrix.
Work activity together with work section represent a cell in the quality matrix.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
activityTypeId |
Work activity type. |
enum (TEXT, FILE, INDUCTION, ACTIVITY, REVIEW, PLAN) |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Work activity ID. |
string |
orderNumber |
Work activity order number. Order number defines the order of the work activity columns in the matrix presentation. |
integer |
projectId |
Related project ID. Related project owns the work activity object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
activityTypeId |
Work activity type. |
enum (TEXT, FILE, INDUCTION, ACTIVITY, REVIEW, PLAN) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work activity ID. |
string |
orderNumber |
Work activity order number. Order number defines the order of the work activity columns in the matrix presentation. |
integer |
projectId |
Related project ID. Related project owns the work activity object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/workActivities/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.21. GET /projects/{projectId}/workSections
Description
This endpoint accesses all work sections from a project given as part of URL.
Work section identifies one row in the quality matrix.
Work sections represents different steps of construction project. They are used to categorize work and quality inspection to smaller sections. Similar categorization is used for other project activities, e.g. monetary categorization and planning.
Work sections are always based on either generally acknowledged set of work sections, e.g. in Finland "Talo 80" is very popular, or the can be defined by company itself.
Used sections always depend on the project type. Infrastructure projects have different set of work sections compared to building new housing. That is self evident because different types of project require different work phases and sections; different work.
As an example work sections could be:
- D Groundwork - D20 Excavating and filling - D21 Ground gas collection and venting systems - G Structural / carcassing metal / timber - G10 Structural steel framing - G12 Isolated structural metal members - J Waterproofing - J10 Cementitious mortar tanking / damp proofing - J20 Mastic asphalt tanking / damp proofing - J21 Mastic asphalt roofing / insulation / finishes - J30 Liquid applied tanking / damp proofing
Work section name is formed from two parts. First is the code e.g. D
above and the second is the actual name Groundwork
. Together they form the full name, e.g. D Groundwork
.
The work sections can form a hierarchy with simple parent child relationships. Each work section object has a parentId
property that is either null
or refers to another work section instance. For example, work section D20 Excavating and filling
is a child of D Groundwork
in the example and it would imply that parentId
of D20 Excavating and filling
points to the ID of D Groundwork
.
A work section together with a work activity represent a cell in the quality matrix.
GET returns all the work sections.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
code |
Fetch all items whose code contains a given string |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
code |
Work section code / identifier number. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work section description. |
string |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work section ID. |
string |
parentId |
Parent work section object ID. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
projectId |
Project ID for the project that owns the work section instance. |
string |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/workSections
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.22. GET /projects/{projectId}/workSections/{id}
Description
This endpoint accesses all work sections from a project given as part of URL.
Work section identifies one row in the quality matrix.
Work sections represents different steps of construction project. They are used to categorize work and quality inspection to smaller sections. Similar categorization is used for other project activities, e.g. monetary categorization and planning.
Work sections are always based on either generally acknowledged set of work sections, e.g. in Finland "Talo 80" is very popular, or the can be defined by company itself.
Used sections always depend on the project type. Infrastructure projects have different set of work sections compared to building new housing. That is self evident because different types of project require different work phases and sections; different work.
As an example work sections could be:
- D Groundwork - D20 Excavating and filling - D21 Ground gas collection and venting systems - G Structural / carcassing metal / timber - G10 Structural steel framing - G12 Isolated structural metal members - J Waterproofing - J10 Cementitious mortar tanking / damp proofing - J20 Mastic asphalt tanking / damp proofing - J21 Mastic asphalt roofing / insulation / finishes - J30 Liquid applied tanking / damp proofing
Work section name is formed from two parts. First is the code e.g. D
above and the second is the actual name Groundwork
. Together they form the full name, e.g. D Groundwork
.
The work sections can form a hierarchy with simple parent child relationships. Each work section object has a parentId
property that is either null
or refers to another work section instance. For example, work section D20 Excavating and filling
is a child of D Groundwork
in the example and it would imply that parentId
of D20 Excavating and filling
points to the ID of D Groundwork
.
A work section together with a work activity represent a cell in the quality matrix.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
code |
Work section code / identifier number. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work section description. |
string |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work section ID. |
string |
parentId |
Parent work section object ID. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
projectId |
Project ID for the project that owns the work section instance. |
string |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/workSections/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.23. PUT /projects/{projectId}/workSections/{id}
Description
This endpoint accesses all work sections from a project given as part of URL.
Work section identifies one row in the quality matrix.
Work sections represents different steps of construction project. They are used to categorize work and quality inspection to smaller sections. Similar categorization is used for other project activities, e.g. monetary categorization and planning.
Work sections are always based on either generally acknowledged set of work sections, e.g. in Finland "Talo 80" is very popular, or the can be defined by company itself.
Used sections always depend on the project type. Infrastructure projects have different set of work sections compared to building new housing. That is self evident because different types of project require different work phases and sections; different work.
As an example work sections could be:
- D Groundwork - D20 Excavating and filling - D21 Ground gas collection and venting systems - G Structural / carcassing metal / timber - G10 Structural steel framing - G12 Isolated structural metal members - J Waterproofing - J10 Cementitious mortar tanking / damp proofing - J20 Mastic asphalt tanking / damp proofing - J21 Mastic asphalt roofing / insulation / finishes - J30 Liquid applied tanking / damp proofing
Work section name is formed from two parts. First is the code e.g. D
above and the second is the actual name Groundwork
. Together they form the full name, e.g. D Groundwork
.
The work sections can form a hierarchy with simple parent child relationships. Each work section object has a parentId
property that is either null
or refers to another work section instance. For example, work section D20 Excavating and filling
is a child of D Groundwork
in the example and it would imply that parentId
of D20 Excavating and filling
points to the ID of D Groundwork
.
A work section together with a work activity represent a cell in the quality matrix.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
code |
Work section code / identifier number. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work section description. |
string |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Work section ID. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
projectId |
Project ID for the project that owns the work section instance. |
string |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
code |
Work section code / identifier number. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work section description. |
string |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work section ID. |
string |
parentId |
Parent work section object ID. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
projectId |
Project ID for the project that owns the work section instance. |
string |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/workSections/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.24. GET /qualityDocuments
Description
This endpoint accesses all work section documents visible for accessing user. This is enhanced version of endpoint inspectionDocuments
and should be used instead.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
code |
Fetch all items whose code contains a given string |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
availableForMatrix |
Availability boolean defines if the WorkSectionDocument object is available for other projects. If it’s set to True then when copying matrix also the WorkSectionDocument is copied. If it’s set to false document is not copied. It means that setting boolean to false limits the use of the object to the owner project only. Note: 'available' boolean is different from 'visible' boolean. The first is about permissions and the second is about visibility. |
boolean |
contentType |
Example : |
string |
contentTypeName |
File content type. If content type is not given, it could be that file content type is just not yet determined. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
visibleForLiteUsers |
Visibility boolean defines whether item is included to list received by Lite-client users. |
boolean |
visibleInDocsAndPlans |
Visibility boolean defines whether WorkSectionDocument is shown in Documents & Plans module in Congrid client. It’s false by default because we don’t want to show too much files in Documents & Plans application. |
boolean |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Produces
-
application/json
Example HTTP request
Request path
/qualityDocuments
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.25. POST /qualityDocuments
Description
This endpoint accesses all work section documents visible for accessing user. This is enhanced version of endpoint inspectionDocuments
and should be used instead.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
availableForMatrix |
Availability boolean defines if the WorkSectionDocument object is available for other projects. If it’s set to True then when copying matrix also the WorkSectionDocument is copied. If it’s set to false document is not copied. It means that setting boolean to false limits the use of the object to the owner project only. Note: 'available' boolean is different from 'visible' boolean. The first is about permissions and the second is about visibility. |
boolean |
contentType |
Example : |
string |
contentTypeName |
File content type. If content type is not given, it could be that file content type is just not yet determined. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
visibleForLiteUsers |
Visibility boolean defines whether item is included to list received by Lite-client users. |
boolean |
visibleInDocsAndPlans |
Visibility boolean defines whether WorkSectionDocument is shown in Documents & Plans module in Congrid client. It’s false by default because we don’t want to show too much files in Documents & Plans application. |
boolean |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
availableForMatrix |
Availability boolean defines if the WorkSectionDocument object is available for other projects. If it’s set to True then when copying matrix also the WorkSectionDocument is copied. If it’s set to false document is not copied. It means that setting boolean to false limits the use of the object to the owner project only. Note: 'available' boolean is different from 'visible' boolean. The first is about permissions and the second is about visibility. |
boolean |
contentType |
Example : |
string |
contentTypeName |
File content type. If content type is not given, it could be that file content type is just not yet determined. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
visibleForLiteUsers |
Visibility boolean defines whether item is included to list received by Lite-client users. |
boolean |
visibleInDocsAndPlans |
Visibility boolean defines whether WorkSectionDocument is shown in Documents & Plans module in Congrid client. It’s false by default because we don’t want to show too much files in Documents & Plans application. |
boolean |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Produces
-
application/json
Example HTTP request
Request path
/qualityDocuments
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.26. GET /qualityDocuments/{id}
Description
This endpoint accesses all work section documents visible for accessing user. This is enhanced version of endpoint inspectionDocuments
and should be used instead.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
availableForMatrix |
Availability boolean defines if the WorkSectionDocument object is available for other projects. If it’s set to True then when copying matrix also the WorkSectionDocument is copied. If it’s set to false document is not copied. It means that setting boolean to false limits the use of the object to the owner project only. Note: 'available' boolean is different from 'visible' boolean. The first is about permissions and the second is about visibility. |
boolean |
contentType |
Example : |
string |
contentTypeName |
File content type. If content type is not given, it could be that file content type is just not yet determined. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
visibleForLiteUsers |
Visibility boolean defines whether item is included to list received by Lite-client users. |
boolean |
visibleInDocsAndPlans |
Visibility boolean defines whether WorkSectionDocument is shown in Documents & Plans module in Congrid client. It’s false by default because we don’t want to show too much files in Documents & Plans application. |
boolean |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Produces
-
application/json
Example HTTP request
Request path
/qualityDocuments/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.27. PUT /qualityDocuments/{id}
Description
This endpoint accesses all work section documents visible for accessing user. This is enhanced version of endpoint inspectionDocuments
and should be used instead.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
availableForMatrix |
Availability boolean defines if the WorkSectionDocument object is available for other projects. If it’s set to True then when copying matrix also the WorkSectionDocument is copied. If it’s set to false document is not copied. It means that setting boolean to false limits the use of the object to the owner project only. Note: 'available' boolean is different from 'visible' boolean. The first is about permissions and the second is about visibility. |
boolean |
contentType |
Example : |
string |
contentTypeName |
File content type. If content type is not given, it could be that file content type is just not yet determined. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
visibleForLiteUsers |
Visibility boolean defines whether item is included to list received by Lite-client users. |
boolean |
visibleInDocsAndPlans |
Visibility boolean defines whether WorkSectionDocument is shown in Documents & Plans module in Congrid client. It’s false by default because we don’t want to show too much files in Documents & Plans application. |
boolean |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
available |
Is file uploaded to S3-storage properly. Set to True when upload to "signedUploadUrl" has been done. |
boolean |
availableForMatrix |
Availability boolean defines if the WorkSectionDocument object is available for other projects. If it’s set to True then when copying matrix also the WorkSectionDocument is copied. If it’s set to false document is not copied. It means that setting boolean to false limits the use of the object to the owner project only. Note: 'available' boolean is different from 'visible' boolean. The first is about permissions and the second is about visibility. |
boolean |
contentType |
Example : |
string |
contentTypeName |
File content type. If content type is not given, it could be that file content type is just not yet determined. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
downloadUrl |
Pre-signed document download URL. Download URL is valid on for some time. |
string |
filename |
File name for the document. |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Document name. |
string |
originalFilename |
Original file name of document before creating hashed name for storage system. |
string |
projectId |
Related project ID. |
string |
signedUploadPost |
Example : |
string |
signedUploadUrl |
Example : |
string |
statusId |
Status for the work section document. If document is attached to matrix cell, status is followed similarly as for measurements and inspections. |
enum (RECEIVED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE, COMPLETED, PENDING, WIP, ACCEPTED, VERIFIED, INCOMPLETE) |
visibleForLiteUsers |
Visibility boolean defines whether item is included to list received by Lite-client users. |
boolean |
visibleInDocsAndPlans |
Visibility boolean defines whether WorkSectionDocument is shown in Documents & Plans module in Congrid client. It’s false by default because we don’t want to show too much files in Documents & Plans application. |
boolean |
workActivityId |
Related work activity ID. |
string |
workSectionId |
Related work section ID. |
string |
Produces
-
application/json
Example HTTP request
Request path
/qualityDocuments/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.28. DELETE /qualityDocuments/{id}
Description
This endpoint accesses all work section documents visible for accessing user. This is enhanced version of endpoint inspectionDocuments
and should be used instead.
Documents related to matrix.
To download a document use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl
for each document you want to download. URL is valid for 24 hours after being generated by this call.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/qualityDocuments/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.29. GET /workActivities
Description
This endpoint accesses all work activities visible for accessing user.
Work activity identifies one column in the quality matrix.
Work activity together with work section represent a cell in the quality matrix.
GET returns all the work activities.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
activityTypeId |
Work activity type. |
enum (TEXT, FILE, INDUCTION, ACTIVITY, REVIEW, PLAN) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work activity ID. |
string |
orderNumber |
Work activity order number. Order number defines the order of the work activity columns in the matrix presentation. |
integer |
projectId |
Related project ID. Related project owns the work activity object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/workActivities
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.30. GET /workActivities/{id}
Description
This endpoint accesses all work activities visible for accessing user.
Work activity identifies one column in the quality matrix.
Work activity together with work section represent a cell in the quality matrix.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
activityTypeId |
Work activity type. |
enum (TEXT, FILE, INDUCTION, ACTIVITY, REVIEW, PLAN) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work activity ID. |
string |
orderNumber |
Work activity order number. Order number defines the order of the work activity columns in the matrix presentation. |
integer |
projectId |
Related project ID. Related project owns the work activity object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/workActivities/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.31. PUT /workActivities/{id}
Description
This endpoint accesses all work activities visible for accessing user.
Work activity identifies one column in the quality matrix.
Work activity together with work section represent a cell in the quality matrix.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
activityTypeId |
Work activity type. |
enum (TEXT, FILE, INDUCTION, ACTIVITY, REVIEW, PLAN) |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Work activity ID. |
string |
orderNumber |
Work activity order number. Order number defines the order of the work activity columns in the matrix presentation. |
integer |
projectId |
Related project ID. Related project owns the work activity object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
activityTypeId |
Work activity type. |
enum (TEXT, FILE, INDUCTION, ACTIVITY, REVIEW, PLAN) |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work activity ID. |
string |
orderNumber |
Work activity order number. Order number defines the order of the work activity columns in the matrix presentation. |
integer |
projectId |
Related project ID. Related project owns the work activity object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/workActivities/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.32. GET /workSections
Description
This endpoint accesses all work sections visible for accessing user.
Work section identifies one row in the quality matrix.
Work sections represents different steps of construction project. They are used to categorize work and quality inspection to smaller sections. Similar categorization is used for other project activities, e.g. monetary categorization and planning.
Work sections are always based on either generally acknowledged set of work sections, e.g. in Finland "Talo 80" is very popular, or the can be defined by company itself.
Used sections always depend on the project type. Infrastructure projects have different set of work sections compared to building new housing. That is self evident because different types of project require different work phases and sections; different work.
As an example work sections could be:
- D Groundwork - D20 Excavating and filling - D21 Ground gas collection and venting systems - G Structural / carcassing metal / timber - G10 Structural steel framing - G12 Isolated structural metal members - J Waterproofing - J10 Cementitious mortar tanking / damp proofing - J20 Mastic asphalt tanking / damp proofing - J21 Mastic asphalt roofing / insulation / finishes - J30 Liquid applied tanking / damp proofing
Work section name is formed from two parts. First is the code e.g. D
above and the second is the actual name Groundwork
. Together they form the full name, e.g. D Groundwork
.
The work sections can form a hierarchy with simple parent child relationships. Each work section object has a parentId
property that is either null
or refers to another work section instance. For example, work section D20 Excavating and filling
is a child of D Groundwork
in the example and it would imply that parentId
of D20 Excavating and filling
points to the ID of D Groundwork
.
A work section together with a work activity represent a cell in the quality matrix.
GET returns all the work sections.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
matrixId |
Fetch all items related to a given matrix |
string |
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
code |
Fetch all items whose code contains a given string |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
code |
Work section code / identifier number. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work section description. |
string |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work section ID. |
string |
parentId |
Parent work section object ID. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
projectId |
Project ID for the project that owns the work section instance. |
string |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Produces
-
application/json
Example HTTP request
Request path
/workSections
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.33. GET /workSections/{id}
Description
This endpoint accesses all work sections visible for accessing user.
Work section identifies one row in the quality matrix.
Work sections represents different steps of construction project. They are used to categorize work and quality inspection to smaller sections. Similar categorization is used for other project activities, e.g. monetary categorization and planning.
Work sections are always based on either generally acknowledged set of work sections, e.g. in Finland "Talo 80" is very popular, or the can be defined by company itself.
Used sections always depend on the project type. Infrastructure projects have different set of work sections compared to building new housing. That is self evident because different types of project require different work phases and sections; different work.
As an example work sections could be:
- D Groundwork - D20 Excavating and filling - D21 Ground gas collection and venting systems - G Structural / carcassing metal / timber - G10 Structural steel framing - G12 Isolated structural metal members - J Waterproofing - J10 Cementitious mortar tanking / damp proofing - J20 Mastic asphalt tanking / damp proofing - J21 Mastic asphalt roofing / insulation / finishes - J30 Liquid applied tanking / damp proofing
Work section name is formed from two parts. First is the code e.g. D
above and the second is the actual name Groundwork
. Together they form the full name, e.g. D Groundwork
.
The work sections can form a hierarchy with simple parent child relationships. Each work section object has a parentId
property that is either null
or refers to another work section instance. For example, work section D20 Excavating and filling
is a child of D Groundwork
in the example and it would imply that parentId
of D20 Excavating and filling
points to the ID of D Groundwork
.
A work section together with a work activity represent a cell in the quality matrix.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
code |
Work section code / identifier number. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work section description. |
string |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work section ID. |
string |
parentId |
Parent work section object ID. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
projectId |
Project ID for the project that owns the work section instance. |
string |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Produces
-
application/json
Example HTTP request
Request path
/workSections/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.12.34. PUT /workSections/{id}
Description
This endpoint accesses all work sections visible for accessing user.
Work section identifies one row in the quality matrix.
Work sections represents different steps of construction project. They are used to categorize work and quality inspection to smaller sections. Similar categorization is used for other project activities, e.g. monetary categorization and planning.
Work sections are always based on either generally acknowledged set of work sections, e.g. in Finland "Talo 80" is very popular, or the can be defined by company itself.
Used sections always depend on the project type. Infrastructure projects have different set of work sections compared to building new housing. That is self evident because different types of project require different work phases and sections; different work.
As an example work sections could be:
- D Groundwork - D20 Excavating and filling - D21 Ground gas collection and venting systems - G Structural / carcassing metal / timber - G10 Structural steel framing - G12 Isolated structural metal members - J Waterproofing - J10 Cementitious mortar tanking / damp proofing - J20 Mastic asphalt tanking / damp proofing - J21 Mastic asphalt roofing / insulation / finishes - J30 Liquid applied tanking / damp proofing
Work section name is formed from two parts. First is the code e.g. D
above and the second is the actual name Groundwork
. Together they form the full name, e.g. D Groundwork
.
The work sections can form a hierarchy with simple parent child relationships. Each work section object has a parentId
property that is either null
or refers to another work section instance. For example, work section D20 Excavating and filling
is a child of D Groundwork
in the example and it would imply that parentId
of D20 Excavating and filling
points to the ID of D Groundwork
.
A work section together with a work activity represent a cell in the quality matrix.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
code |
Work section code / identifier number. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work section description. |
string |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Work section ID. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
projectId |
Project ID for the project that owns the work section instance. |
string |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
code |
Work section code / identifier number. |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Work section description. |
string |
finishedAt |
Date when work has been actually finished. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
inspectorUserIds |
List of users that are marked as inspector users for the work section. Property is a list of User ids. |
< string > array |
isEnabled |
Property defines if object is enabled in the matrix view. |
boolean |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Work section ID. |
string |
parentId |
Parent work section object ID. |
string |
participantsUserIds |
List of users that are marked as participant users for the work section. Property is a list of User ids. |
< string > array |
projectId |
Project ID for the project that owns the work section instance. |
string |
responsibleUserIds |
List of users that are marked as responsible users for the work section. Property is a list of User ids. |
< string > array |
scheduledFinishAt |
Scheduled date when work is going to be finished. |
string (date-time) |
scheduledStartAt |
Scheduled date when work is going to be started. |
string (date-time) |
startedAt |
Date when work has been actually started. |
string (date-time) |
Produces
-
application/json
Example HTTP request
Request path
/workSections/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.13. Tags
2.13.1. GET /tags
Description
Tags are used to categorize objects in Congrid system.
Tags are defined both on system level and on company level. System level tags are defined by Congrid and company level tags can be defined by companies themselves.
Tags are defined in a tree structure via a parent relation. The root level tags don’t have any parent defined "parentId": null
and all child tags point to their parent tag ID with "parentId"
field.
As an example end-point could return these two tag objects.
{ "id": "1", "levelId": "SYSTEM", "parentId": null, "slug": "tag-1", "name": "Tag 1" }, { "id": "2", "levelId": "SYSTEM", "parentId": "1", "slug": "tag-1-1", "name": "Tag 1.1" }
The first is root level tag "parentId": null
and the other is a child for the first one. Hierarchical structure would be as follows.
- Tag 1 - Tag 1.1
Both of example tags are SYSTEM
level tags. It means they are visible for all system users.
In the tag tree there could be multiple tags with same slug. It’s possible to combine tags using same slug for them. When system objects are tagged the link between tag and object is always directly to one particular tag. For example, if one note is linked to example Tag ID 2, the note will have tag relation to Tag ID 2. When that information is then later used in analytics, it’s possible to categorize objects both with related tag ID (2) and related tag slug ("tag-1-1") depending which case is more relevant.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
slug |
Fetch all items whose slug contains a given string |
string |
Query |
levelId |
Fetch all items that are the given level |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
Name | Description | Schema |
---|---|---|
companyId |
Company ID for the company that owns the tag. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description for the tag. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Is tag enabled. Only enabled tags can be used in Live. |
boolean |
levelId |
Tag level. There are three levels of tags: 'PROJECT', 'COMPANY' and 'SYSTEM'. Only the last two are currently used, but system supports also project level tags. |
enum (COMPANY, SYSTEM, PROJECT) |
name |
Name for the tag. |
string |
parentId |
Parent tag ID. |
string |
projectId |
Project ID for the project that owns the tag. |
string |
slug |
Slug / key for the tag. |
string |
translations |
Translations for other fields in this object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/tags
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"deletedAt" : "2020-01-01T00:00:00.000000Z"
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.13.2. POST /tags
Description
Tags are used to categorize objects in Congrid system.
Tags are defined both on system level and on company level. System level tags are defined by Congrid and company level tags can be defined by companies themselves.
Tags are defined in a tree structure via a parent relation. The root level tags don’t have any parent defined "parentId": null
and all child tags point to their parent tag ID with "parentId"
field.
As an example end-point could return these two tag objects.
{ "id": "1", "levelId": "SYSTEM", "parentId": null, "slug": "tag-1", "name": "Tag 1" }, { "id": "2", "levelId": "SYSTEM", "parentId": "1", "slug": "tag-1-1", "name": "Tag 1.1" }
The first is root level tag "parentId": null
and the other is a child for the first one. Hierarchical structure would be as follows.
- Tag 1 - Tag 1.1
Both of example tags are SYSTEM
level tags. It means they are visible for all system users.
In the tag tree there could be multiple tags with same slug. It’s possible to combine tags using same slug for them. When system objects are tagged the link between tag and object is always directly to one particular tag. For example, if one note is linked to example Tag ID 2, the note will have tag relation to Tag ID 2. When that information is then later used in analytics, it’s possible to categorize objects both with related tag ID (2) and related tag slug ("tag-1-1") depending which case is more relevant.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Name | Description | Schema |
---|---|---|
companyId |
Company ID for the company that owns the tag. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description for the tag. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Is tag enabled. Only enabled tags can be used in Live. |
boolean |
name |
Name for the tag. |
string |
parentId |
Parent tag ID. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Name | Description | Schema |
---|---|---|
companyId |
Company ID for the company that owns the tag. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description for the tag. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Is tag enabled. Only enabled tags can be used in Live. |
boolean |
levelId |
Tag level. There are three levels of tags: 'PROJECT', 'COMPANY' and 'SYSTEM'. Only the last two are currently used, but system supports also project level tags. |
enum (COMPANY, SYSTEM, PROJECT) |
name |
Name for the tag. |
string |
parentId |
Parent tag ID. |
string |
projectId |
Project ID for the project that owns the tag. |
string |
slug |
Slug / key for the tag. |
string |
translations |
Translations for other fields in this object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/tags
Request body
{
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.13.3. GET /tags/{id}
Description
Tags are used to categorize objects in Congrid system.
Tags are defined both on system level and on company level. System level tags are defined by Congrid and company level tags can be defined by companies themselves.
Tags are defined in a tree structure via a parent relation. The root level tags don’t have any parent defined "parentId": null
and all child tags point to their parent tag ID with "parentId"
field.
As an example end-point could return these two tag objects.
{ "id": "1", "levelId": "SYSTEM", "parentId": null, "slug": "tag-1", "name": "Tag 1" }, { "id": "2", "levelId": "SYSTEM", "parentId": "1", "slug": "tag-1-1", "name": "Tag 1.1" }
The first is root level tag "parentId": null
and the other is a child for the first one. Hierarchical structure would be as follows.
- Tag 1 - Tag 1.1
Both of example tags are SYSTEM
level tags. It means they are visible for all system users.
In the tag tree there could be multiple tags with same slug. It’s possible to combine tags using same slug for them. When system objects are tagged the link between tag and object is always directly to one particular tag. For example, if one note is linked to example Tag ID 2, the note will have tag relation to Tag ID 2. When that information is then later used in analytics, it’s possible to categorize objects both with related tag ID (2) and related tag slug ("tag-1-1") depending which case is more relevant.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Name | Description | Schema |
---|---|---|
companyId |
Company ID for the company that owns the tag. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description for the tag. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Is tag enabled. Only enabled tags can be used in Live. |
boolean |
levelId |
Tag level. There are three levels of tags: 'PROJECT', 'COMPANY' and 'SYSTEM'. Only the last two are currently used, but system supports also project level tags. |
enum (COMPANY, SYSTEM, PROJECT) |
name |
Name for the tag. |
string |
parentId |
Parent tag ID. |
string |
projectId |
Project ID for the project that owns the tag. |
string |
slug |
Slug / key for the tag. |
string |
translations |
Translations for other fields in this object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/tags/string
Example HTTP response
Response 200
{
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.13.4. PUT /tags/{id}
Description
Tags are used to categorize objects in Congrid system.
Tags are defined both on system level and on company level. System level tags are defined by Congrid and company level tags can be defined by companies themselves.
Tags are defined in a tree structure via a parent relation. The root level tags don’t have any parent defined "parentId": null
and all child tags point to their parent tag ID with "parentId"
field.
As an example end-point could return these two tag objects.
{ "id": "1", "levelId": "SYSTEM", "parentId": null, "slug": "tag-1", "name": "Tag 1" }, { "id": "2", "levelId": "SYSTEM", "parentId": "1", "slug": "tag-1-1", "name": "Tag 1.1" }
The first is root level tag "parentId": null
and the other is a child for the first one. Hierarchical structure would be as follows.
- Tag 1 - Tag 1.1
Both of example tags are SYSTEM
level tags. It means they are visible for all system users.
In the tag tree there could be multiple tags with same slug. It’s possible to combine tags using same slug for them. When system objects are tagged the link between tag and object is always directly to one particular tag. For example, if one note is linked to example Tag ID 2, the note will have tag relation to Tag ID 2. When that information is then later used in analytics, it’s possible to categorize objects both with related tag ID (2) and related tag slug ("tag-1-1") depending which case is more relevant.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Name | Description | Schema |
---|---|---|
companyId |
Company ID for the company that owns the tag. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description for the tag. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Is tag enabled. Only enabled tags can be used in Live. |
boolean |
name |
Name for the tag. |
string |
parentId |
Parent tag ID. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Name | Description | Schema |
---|---|---|
companyId |
Company ID for the company that owns the tag. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Description for the tag. |
string |
id |
Unique ID for the object given by backend server. |
string |
isEnabled |
Is tag enabled. Only enabled tags can be used in Live. |
boolean |
levelId |
Tag level. There are three levels of tags: 'PROJECT', 'COMPANY' and 'SYSTEM'. Only the last two are currently used, but system supports also project level tags. |
enum (COMPANY, SYSTEM, PROJECT) |
name |
Name for the tag. |
string |
parentId |
Parent tag ID. |
string |
projectId |
Project ID for the project that owns the tag. |
string |
slug |
Slug / key for the tag. |
string |
translations |
Translations for other fields in this object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/tags/string
Request body
{
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"deletedAt" : "2020-01-01T00:00:00.000000Z"
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.13.5. DELETE /tags/{id}
Description
Tags are used to categorize objects in Congrid system.
Tags are defined both on system level and on company level. System level tags are defined by Congrid and company level tags can be defined by companies themselves.
Tags are defined in a tree structure via a parent relation. The root level tags don’t have any parent defined "parentId": null
and all child tags point to their parent tag ID with "parentId"
field.
As an example end-point could return these two tag objects.
{ "id": "1", "levelId": "SYSTEM", "parentId": null, "slug": "tag-1", "name": "Tag 1" }, { "id": "2", "levelId": "SYSTEM", "parentId": "1", "slug": "tag-1-1", "name": "Tag 1.1" }
The first is root level tag "parentId": null
and the other is a child for the first one. Hierarchical structure would be as follows.
- Tag 1 - Tag 1.1
Both of example tags are SYSTEM
level tags. It means they are visible for all system users.
In the tag tree there could be multiple tags with same slug. It’s possible to combine tags using same slug for them. When system objects are tagged the link between tag and object is always directly to one particular tag. For example, if one note is linked to example Tag ID 2, the note will have tag relation to Tag ID 2. When that information is then later used in analytics, it’s possible to categorize objects both with related tag ID (2) and related tag slug ("tag-1-1") depending which case is more relevant.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/tags/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14. Targets
2.14.1. GET /projects/{projectId}/targets
Description
This endpoint accesses all targets from a project given as part of URL.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
GET returns all the targets.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
parentName |
Fetch all items whose parent name contains a given string |
string |
Query |
typeId |
Fetch all items with a given type |
string |
Query |
parentId |
Fetch all items related to a given parent |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targets
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.2. POST /projects/{projectId}/targets
Description
This endpoint accesses all targets from a project given as part of URL.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
POST adds a new target for the project. Targets can be used to describe the structure of different physical areas of the construction site through a parent child hierarchy. Targets can have multiple floor plans attached to them.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targets
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.3. GET /projects/{projectId}/targets/{id}
Description
This endpoint accesses all targets from a project given as part of URL.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targets/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.4. PUT /projects/{projectId}/targets/{id}
Description
This endpoint accesses all targets from a project given as part of URL.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
PUT updates the target metadata.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targets/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.5. DELETE /projects/{projectId}/targets/{id}
Description
This endpoint accesses all targets from a project given as part of URL.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
DELETE removes a target from the project. If the target has child targets, then those are also removed. Notes, photos and other objects attached to the target are not removed and they still have the information about the target available even after the target has been removed.
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/targets/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.6. GET /targetTypes
Description
Target types are static mappings from a human readable type to an id that is used when creating or updating target objects in the system.
GET returns all the target type mappings available in the system. These target type mappings are used when targets are created or updated. The targetTypeId
of a target is populated with one of the id
values returned by this end-point.
The mappings are static by nature and existing ones should not change over time. However new target types might be introduced later on.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
id |
Example : |
string |
name |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/targetTypes
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ "object" ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.7. GET /targets
Description
This endpoint accesses all targets from projects available for the user.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
GET returns all the targets.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
name |
Fetch all items whose name contains a given string |
string |
Query |
parentName |
Fetch all items whose parent name contains a given string |
string |
Query |
typeId |
Fetch all items with a given type |
string |
Query |
parentId |
Fetch all items related to a given parent |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all items related a project owned by a given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/targets
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.8. POST /targets
Description
This endpoint accesses all targets from projects available for the user.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
POST adds a new target for the project. Targets can be used to describe the structure of different physical areas of the construction site through a parent child hierarchy. Targets can have multiple floor plans attached to them.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/targets
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.9. GET /targets/{id}
Description
This endpoint accesses all targets from projects available for the user.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/targets/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.10. PUT /targets/{id}
Description
This endpoint accesses all targets from projects available for the user.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
PUT updates the target metadata.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
description |
Example : |
string |
displayName |
Example : |
string |
floorPlanIds |
Example : |
< string > array |
id |
Unique ID for the object given by backend server. |
string |
ifcDescription |
Example : |
string |
ifcGuid |
Example : |
string |
ifcLongName |
Example : |
string |
ifcName |
Example : |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
parentId |
Example : |
string |
parentName |
Example : |
string |
projectId |
Example : |
string |
targetTypeId |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/targets/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.14.11. DELETE /targets/{id}
Description
This endpoint accesses all targets from projects available for the user.
A construction site usually consists of different sections, buildings, floors, flats etc. The target objects are used to specify the hierarchy of the construction site and the above mentioned areas. The target object also associates floor plans to different areas.
The target objects form a tree with parent child relations. Floor plans are attached to targets and the granularity on which this is done can differ from construction site to construction site.
An example tree with floor plan mappings:
Section 1 (id: 's1', floorPlanIds: ['fp1'] ) -- Building 1 (id: 'b1', parentId: 's1') -- Floor A (id: 'fA', parentId: 'b1') -- Building 2 (id: 'b2', parentId: 's1', floorPlanIds: ['fp2'] ) -- Floor B (id: 'fB', parentId: 'b2')
The example above shows the structure of a simple construction site. It has one section and two buildings with one floor each. Two floor plans are attached to the targets and are shown to the end user with the following outcome.
-
Floor plan with floorplanId fp1 is shown when the user opens Section 1, Building 1 or Floor A in Building 1
-
Floor plan with floorplanId fp2 is shown when user opens Building 2 or Floor B
DELETE removes a target from the project. If the target has child targets, then those are also removed. Notes, photos and other objects attached to the target are not removed and they still have the information about the target available even after the target has been removed.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/targets/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15. Templates
2.15.1. GET /inspectionTemplates
Description
Returns all inspection templates that are available either to use, or to copy from one project to another.
Notice, that before template can be used with a inspection’s templateId
-field, it must belong to same project with the inspection.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
workSectionId |
Fetch all items that belong to given work section |
string |
Query |
activityId |
Fetch all items that belong to given work activity |
string |
Query |
matrixCellId |
Fetch all items that belong to given matrix cell |
string |
Query |
matrixId |
Fetch all items that belong to given matrix |
string |
Query |
objectTypeId |
Fetch all items with a given object type |
string |
Query |
listTypeId |
Fetch all items with a given list type |
string |
Query |
measurementTypeId |
Fetch all items with a given measurement type |
string |
Query |
inspectionTypeId |
Fetch all items with a given inspection type |
string |
Query |
languageIds |
Fetch all items that match with all given language tags (one or more) |
string |
Query |
availableForProjectId |
Boolean that defines if measurement template is available for given project ID. Availability of the template is defined by note template level. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
activityId |
Example : |
string |
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
languageIds |
Language tags that allow offering different measurements for different language searches. |
string |
matrixCellId |
Example : |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
projectId |
Example : |
string |
targetIds |
Example : |
< string > array |
topicIds |
Example : |
< string > array |
workSectionId |
ID of the related work section object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTemplates
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.2. POST /inspectionTemplates
Description
Returns all inspection templates that are available either to use, or to copy from one project to another.
Notice, that before template can be used with a inspection’s templateId
-field, it must belong to same project with the inspection.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
activityId |
Example : |
string |
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
languageIds |
Language tags that allow offering different measurements for different language searches. |
string |
matrixCellId |
Example : |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
projectId |
Example : |
string |
targetIds |
Example : |
< string > array |
topicIds |
Example : |
< string > array |
workSectionId |
ID of the related work section object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
activityId |
Example : |
string |
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
languageIds |
Language tags that allow offering different measurements for different language searches. |
string |
matrixCellId |
Example : |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
projectId |
Example : |
string |
targetIds |
Example : |
< string > array |
topicIds |
Example : |
< string > array |
workSectionId |
ID of the related work section object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTemplates
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.3. GET /inspectionTemplates/{id}
Description
Returns all inspection templates that are available either to use, or to copy from one project to another.
Notice, that before template can be used with a inspection’s templateId
-field, it must belong to same project with the inspection.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
activityId |
Example : |
string |
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
languageIds |
Language tags that allow offering different measurements for different language searches. |
string |
matrixCellId |
Example : |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
projectId |
Example : |
string |
targetIds |
Example : |
< string > array |
topicIds |
Example : |
< string > array |
workSectionId |
ID of the related work section object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTemplates/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.4. PUT /inspectionTemplates/{id}
Description
Returns all inspection templates that are available either to use, or to copy from one project to another.
Notice, that before template can be used with a inspection’s templateId
-field, it must belong to same project with the inspection.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
activityId |
Example : |
string |
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
languageIds |
Language tags that allow offering different measurements for different language searches. |
string |
matrixCellId |
Example : |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
projectId |
Example : |
string |
targetIds |
Example : |
< string > array |
topicIds |
Example : |
< string > array |
workSectionId |
ID of the related work section object. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
activityId |
Example : |
string |
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
languageIds |
Language tags that allow offering different measurements for different language searches. |
string |
matrixCellId |
Example : |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
projectId |
Example : |
string |
targetIds |
Example : |
< string > array |
topicIds |
Example : |
< string > array |
workSectionId |
ID of the related work section object. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTemplates/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.5. GET /inspectionTopicTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
objectTypeId |
Fetch all items with a given object type |
string |
Query |
measurementTypeId |
Fetch all items with a given measurement type |
string |
Query |
inspectionTypeId |
Fetch all items with a given inspection type |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
measurementTemplateId |
Fetch all items related to a given measurement template |
string |
Query |
inspectionId |
Fetch all items related to a given inspection |
string |
Query |
inspectionTemplateId |
Fetch all items related to a given inspection template |
string |
Query |
workSectionId |
Fetch all items that belong to given work section |
string |
Query |
activityId |
Fetch all items that belong to given work activity |
string |
Query |
matrixCellId |
Fetch all items that belong to given matrix cell |
string |
Query |
matrixId |
Fetch all items that belong to given matrix |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTemplateId |
Measurement template ID for parent measurement template. This is same as "measurementTemplateId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementTemplateId" and to be deprecated. Developers should use "measurementTemplateId" instead. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic template. |
string |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopicTemplates
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.6. POST /inspectionTopicTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic template. |
string |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTemplateId |
Measurement template ID for parent measurement template. This is same as "measurementTemplateId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementTemplateId" and to be deprecated. Developers should use "measurementTemplateId" instead. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic template. |
string |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopicTemplates
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.7. GET /inspectionTopicTemplates/{id}
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTemplateId |
Measurement template ID for parent measurement template. This is same as "measurementTemplateId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementTemplateId" and to be deprecated. Developers should use "measurementTemplateId" instead. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic template. |
string |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopicTemplates/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.8. PUT /inspectionTopicTemplates/{id}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic template. |
string |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
inspectionTemplateId |
Measurement template ID for parent measurement template. This is same as "measurementTemplateId" but with old name. TO BE DEPRECATED Field is duplicate with "measurementTemplateId" and to be deprecated. Developers should use "measurementTemplateId" instead. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic template. |
string |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
Produces
-
application/json
Example HTTP request
Request path
/inspectionTopicTemplates/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.9. GET /measurementTemplates
Description
Returns all measurement templates that are available either to use, or to copy from one project to another.
Notice, that before template can be used with a measurement’s templateId
-field, it must belong to same project with the measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
workSectionId |
Fetch all items that belong to given work section |
string |
Query |
activityId |
Fetch all items that belong to given work activity |
string |
Query |
matrixCellId |
Fetch all items that belong to given matrix cell |
string |
Query |
matrixId |
Fetch all items that belong to given matrix |
string |
Query |
objectTypeId |
Fetch all items with a given object type |
string |
Query |
listTypeId |
Fetch all items with a given list type |
string |
Query |
measurementTypeId |
Fetch all items with a given measurement type |
string |
Query |
inspectionTypeId |
Fetch all items with a given inspection type |
string |
Query |
languageIds |
Fetch all items that match with all given language tags (one or more) |
string |
Query |
availableForProjectId |
Boolean that defines if measurement template is available for given project ID. Availability of the template is defined by note template level. |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
measurementTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
projectId |
Example : |
string |
topicIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/measurementTemplates
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.10. POST /measurementTemplates
Description
Returns all measurement templates that are available either to use, or to copy from one project to another.
Notice, that before template can be used with a measurement’s templateId
-field, it must belong to same project with the measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
measurementTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
projectId |
Example : |
string |
topicIds |
Example : |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
measurementTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
projectId |
Example : |
string |
topicIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/measurementTemplates
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.11. GET /measurementTemplates/{id}
Description
Returns all measurement templates that are available either to use, or to copy from one project to another.
Notice, that before template can be used with a measurement’s templateId
-field, it must belong to same project with the measurement.
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
measurementTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
projectId |
Example : |
string |
topicIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/measurementTemplates/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.12. PUT /measurementTemplates/{id}
Description
Returns all measurement templates that are available either to use, or to copy from one project to another.
Notice, that before template can be used with a measurement’s templateId
-field, it must belong to same project with the measurement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
measurementTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
projectId |
Example : |
string |
topicIds |
Example : |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
availableForAll |
Example : |
boolean |
availableForCompany |
Example : |
boolean |
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementCountTarget |
Target number of required measurements or inspections. Same value is used for measurements and inspections, e.g. safety or quality. |
integer |
measurementTypeId |
Example : |
enum (QUALITY_INSPECTION, QUALITY_PUNCH, MVR, SAFETY_WALK, PHOTO, NOTIFICATION, INDUCTION, ASPHALT, TR, SAFETY, PUNCH, MAINTENANCE, QUALITY, ENVIRONMENT, MEMO) |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
projectId |
Example : |
string |
topicIds |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/measurementTemplates/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.13. GET /measurementTopicTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
objectTypeId |
Fetch all items with a given object type |
string |
Query |
measurementTypeId |
Fetch all items with a given measurement type |
string |
Query |
inspectionTypeId |
Fetch all items with a given inspection type |
string |
Query |
companyId |
Fetch all items related to a given company |
string |
Query |
projectId |
Fetch all items related to a given project |
string |
Query |
projectCode |
Fetch all items related to a given project (search by project code) |
string |
Query |
measurementId |
Fetch all items related to a given measurement |
string |
Query |
measurementTemplateId |
Fetch all items related to a given measurement template |
string |
Query |
inspectionId |
Fetch all items related to a given inspection |
string |
Query |
inspectionTemplateId |
Fetch all items related to a given inspection template |
string |
Query |
workSectionId |
Fetch all items that belong to given work section |
string |
Query |
activityId |
Fetch all items that belong to given work activity |
string |
Query |
matrixCellId |
Fetch all items that belong to given matrix cell |
string |
Query |
matrixId |
Fetch all items that belong to given matrix |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic template. |
string |
negativeMultiplier |
Negative multiplier for measurement topic template. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopicTemplates
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.14. POST /measurementTopicTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic template. |
string |
negativeMultiplier |
Negative multiplier for measurement topic template. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic template. |
string |
negativeMultiplier |
Negative multiplier for measurement topic template. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopicTemplates
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.15. GET /measurementTopicTemplates/{id}
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic template. |
string |
negativeMultiplier |
Negative multiplier for measurement topic template. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopicTemplates/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.15.16. PUT /measurementTopicTemplates/{id}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
string |
|
Body |
Put data |
Object’s update data |
Put data
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Name for measurement topic template. |
string |
negativeMultiplier |
Negative multiplier for measurement topic template. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
deletedAt |
Object’s deletion date. If null, object is not deleted but active and available. |
string |
id |
Unique ID for the object given by backend server. |
string |
measurementTemplateId |
Measurement template ID of parent measurement template. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Name for measurement topic template. |
string |
negativeMultiplier |
Negative multiplier for measurement topic template. Negative and positive multipliers are used when calculating percentage result for finished measurement topic. Final count of plus and minus values for calculated result is multiplied by negative and positive multipliers. |
number |
orderNumber |
Order number for measurement topic template. Order number is visible for user. Difference between UI order number and "plain" order number is that UI order number is used for sorting measurement topic templates when rendering measurement template. Whereas, order number is just extra information and showed for user. Order number will be replaced by "topicCode" property in future, so prefer to use "topicCode" instead "orderNumber" in your API. |
string |
positiveMultiplier |
Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property. |
number |
Produces
-
application/json
Example HTTP request
Request path
/measurementTopicTemplates/string
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"deletedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16. Users
2.16.1. GET /projects/{projectId}/roles
Description
This endpoint accesses all users from a project given as part of URL.
The role object contains information about a users roles regarding different projects, companies etc. The roles the user can have for the project are:
-
PROJECT_CLIENT_ADMIN - Admin role to allow client access for the user.
-
PROJECT_LIVE_VIEW - Live view role allow view accesss to Live.
-
PROJECT_LIVE_EDIT - Live edit role allows editing for data in Live.
-
PROJECT_LIVE_ADMIN - Live admin role allows admin access for the project.
-
PROJECT_LITE - Lite user role.
-
COMPANY_ADMIN - A company level administrator.
-
COMPANY_MANAGER - A company level manager.
Note
|
The PROJECT_LITE role is associated with a contact with the same email address. If such contact does not exist it will be created for the project. |
GET returns all the roles that are related to this project.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Query |
userId |
Fetch all roles related to a given user (search by id) |
string |
Query |
companyId |
Fetch all roles for a given company |
string |
Query |
email |
Fetch all roles related to a given user (search by e-mail) |
string |
Query |
externalId |
Fetch all roles related to a given user (search by unique external id) |
string |
Query |
projectId |
Fetch all roles for a given project (search by id) |
string |
Query |
projectCode |
Fetch all roles for a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all roles in projects of a given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nameAbbreviation |
Example : |
string |
projectId |
Example : |
string |
roles |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/roles
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.2. POST /projects/{projectId}/roles
Description
This endpoint accesses all users from a project given as part of URL.
The role object contains information about a users roles regarding different projects, companies etc. The roles the user can have for the project are:
-
PROJECT_CLIENT_ADMIN - Admin role to allow client access for the user.
-
PROJECT_LIVE_VIEW - Live view role allow view accesss to Live.
-
PROJECT_LIVE_EDIT - Live edit role allows editing for data in Live.
-
PROJECT_LIVE_ADMIN - Live admin role allows admin access for the project.
-
PROJECT_LITE - Lite user role.
-
COMPANY_ADMIN - A company level administrator.
-
COMPANY_MANAGER - A company level manager.
Note
|
The PROJECT_LITE role is associated with a contact with the same email address. If such contact does not exist it will be created for the project. |
POST adds a new role to the system. You create both:
-
Project roles by giving
projectId
or using project-specific endpointprojects/{project_id}/roles
. -
Roles that are not tied to any project, for example the
COMPANY_ADMIN
orCOMPANY_MANAGER
role, by using genericroles
-endpoint.
If the user is an existing Congrid user (based on email), then the role is added to the project. If the user is not an existing Congrid user, then the user is first created in Congrid system and then the role is added to the project.
The id
returned in the POST response can be used to remove the role.
To update per project roles of the user either:
-
Perform a new POST with the same email address and projectId. This will add new roles for the user and remove the old ones.
-
Use the per project endpoint
projects/{project_id}/roles
.
Note
|
If the user account is in "disabled" mode. The user is added to the project and is visible in project listing (however the user stays disabled and cannot log in to Congrid). |
Note
|
If a user with PROJECT_LITE role is created, the API automatically associates it with a contact. If such contact does not exist it will be created. |
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
string |
|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
nameAbbreviation |
Example : |
string |
projectId |
Example : |
string |
roles |
Example : |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nameAbbreviation |
Example : |
string |
projectId |
Example : |
string |
roles |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/roles
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.3. GET /projects/{projectId}/roles/{id}
Description
This endpoint accesses all users from a project given as part of URL.
The role object contains information about a users roles regarding different projects, companies etc. The roles the user can have for the project are:
-
PROJECT_CLIENT_ADMIN - Admin role to allow client access for the user.
-
PROJECT_LIVE_VIEW - Live view role allow view accesss to Live.
-
PROJECT_LIVE_EDIT - Live edit role allows editing for data in Live.
-
PROJECT_LIVE_ADMIN - Live admin role allows admin access for the project.
-
PROJECT_LITE - Lite user role.
-
COMPANY_ADMIN - A company level administrator.
-
COMPANY_MANAGER - A company level manager.
Note
|
The PROJECT_LITE role is associated with a contact with the same email address. If such contact does not exist it will be created for the project. |
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nameAbbreviation |
Example : |
string |
projectId |
Example : |
string |
roles |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/roles/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.4. DELETE /projects/{projectId}/roles/{id}
Description
This endpoint accesses all users from a project given as part of URL.
The role object contains information about a users roles regarding different projects, companies etc. The roles the user can have for the project are:
-
PROJECT_CLIENT_ADMIN - Admin role to allow client access for the user.
-
PROJECT_LIVE_VIEW - Live view role allow view accesss to Live.
-
PROJECT_LIVE_EDIT - Live edit role allows editing for data in Live.
-
PROJECT_LIVE_ADMIN - Live admin role allows admin access for the project.
-
PROJECT_LITE - Lite user role.
-
COMPANY_ADMIN - A company level administrator.
-
COMPANY_MANAGER - A company level manager.
Note
|
The PROJECT_LITE role is associated with a contact with the same email address. If such contact does not exist it will be created for the project. |
DELETE removes a role from the system and from any associated project. After this the user with the role does not have permissions to access the project or its data anymore.
Note
|
Removing a role from a project will not remove any data that was generated by the user during the project. |
Parameters
Type | Name | Schema |
---|---|---|
Path |
projectId |
string |
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/projects/string/roles/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.5. GET /roles
Description
This endpoint accesses all roles from all projects.
The role object contains information about a users roles regarding different projects, companies etc. The roles the user can have for the project are:
-
PROJECT_CLIENT_ADMIN - Admin role to allow client access for the user.
-
PROJECT_LIVE_VIEW - Live view role allow view accesss to Live.
-
PROJECT_LIVE_EDIT - Live edit role allows editing for data in Live.
-
PROJECT_LIVE_ADMIN - Live admin role allows admin access for the project.
-
PROJECT_LITE - Lite user role.
-
COMPANY_ADMIN - A company level administrator.
-
COMPANY_MANAGER - A company level manager.
Note
|
The PROJECT_LITE role is associated with a contact with the same email address. If such contact does not exist it will be created for the project. |
GET returns all the roles for all the projects of the company that are in the system.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
userId |
Fetch all roles related to a given user (search by id) |
string |
Query |
companyId |
Fetch all roles for a given company |
string |
Query |
email |
Fetch all roles related to a given user (search by e-mail) |
string |
Query |
externalId |
Fetch all roles related to a given user (search by unique external id) |
string |
Query |
projectId |
Fetch all roles for a given project (search by id) |
string |
Query |
projectCode |
Fetch all roles for a given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch all roles in projects of a given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nameAbbreviation |
Example : |
string |
projectId |
Example : |
string |
roles |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/roles
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ {
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
} ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.6. POST /roles
Description
This endpoint accesses all roles from all projects.
The role object contains information about a users roles regarding different projects, companies etc. The roles the user can have for the project are:
-
PROJECT_CLIENT_ADMIN - Admin role to allow client access for the user.
-
PROJECT_LIVE_VIEW - Live view role allow view accesss to Live.
-
PROJECT_LIVE_EDIT - Live edit role allows editing for data in Live.
-
PROJECT_LIVE_ADMIN - Live admin role allows admin access for the project.
-
PROJECT_LITE - Lite user role.
-
COMPANY_ADMIN - A company level administrator.
-
COMPANY_MANAGER - A company level manager.
Note
|
The PROJECT_LITE role is associated with a contact with the same email address. If such contact does not exist it will be created for the project. |
POST adds a new role to the system. You create both:
-
Project roles by giving
projectId
or using project-specific endpointprojects/{project_id}/roles
. -
Roles that are not tied to any project, for example the
COMPANY_ADMIN
orCOMPANY_MANAGER
role, by using genericroles
-endpoint.
If the user is an existing Congrid user (based on email), then the role is added to the project. If the user is not an existing Congrid user, then the user is first created in Congrid system and then the role is added to the project.
The id
returned in the POST response can be used to remove the role.
To update per project roles of the user either:
-
Perform a new POST with the same email address and projectId. This will add new roles for the user and remove the old ones.
-
Use the per project endpoint
projects/{project_id}/roles
.
Note
|
If the user account is in "disabled" mode. The user is added to the project and is visible in project listing (however the user stays disabled and cannot log in to Congrid). |
Note
|
If a user with PROJECT_LITE role is created, the API automatically associates it with a contact. If such contact does not exist it will be created. |
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
name |
Example : |
string |
nameAbbreviation |
Example : |
string |
projectId |
Example : |
string |
roles |
Example : |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nameAbbreviation |
Example : |
string |
projectId |
Example : |
string |
roles |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/roles
Request body
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"modifiedAt" : "2020-01-01T00:00:00.000000Z"
}
Example HTTP response
Response 201
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.7. GET /roles/{id}
Description
This endpoint accesses all roles from all projects.
The role object contains information about a users roles regarding different projects, companies etc. The roles the user can have for the project are:
-
PROJECT_CLIENT_ADMIN - Admin role to allow client access for the user.
-
PROJECT_LIVE_VIEW - Live view role allow view accesss to Live.
-
PROJECT_LIVE_EDIT - Live edit role allows editing for data in Live.
-
PROJECT_LIVE_ADMIN - Live admin role allows admin access for the project.
-
PROJECT_LITE - Lite user role.
-
COMPANY_ADMIN - A company level administrator.
-
COMPANY_MANAGER - A company level manager.
Note
|
The PROJECT_LITE role is associated with a contact with the same email address. If such contact does not exist it will be created for the project. |
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyId |
Example : |
string |
createdAt |
Object’s creating date. |
string (date-time) |
createdBy |
Object creator’s id. |
string |
email |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
modifiedAt |
Object’s last modification date. |
string (date-time) |
modifiedBy |
Object’s last modifier’s id. |
string |
name |
Example : |
string |
nameAbbreviation |
Example : |
string |
projectId |
Example : |
string |
roles |
Example : |
< string > array |
Produces
-
application/json
Example HTTP request
Request path
/roles/string
Example HTTP response
Response 200
{
"createdAt" : "2020-01-01T00:00:00.000000Z",
"createdBy" : 123,
"modifiedAt" : "2020-01-01T00:00:00.000000Z",
"modifiedBy" : 123
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.8. DELETE /roles/{id}
Description
This endpoint accesses all roles from all projects.
The role object contains information about a users roles regarding different projects, companies etc. The roles the user can have for the project are:
-
PROJECT_CLIENT_ADMIN - Admin role to allow client access for the user.
-
PROJECT_LIVE_VIEW - Live view role allow view accesss to Live.
-
PROJECT_LIVE_EDIT - Live edit role allows editing for data in Live.
-
PROJECT_LIVE_ADMIN - Live admin role allows admin access for the project.
-
PROJECT_LITE - Lite user role.
-
COMPANY_ADMIN - A company level administrator.
-
COMPANY_MANAGER - A company level manager.
Note
|
The PROJECT_LITE role is associated with a contact with the same email address. If such contact does not exist it will be created for the project. |
DELETE removes a role from the system and from any associated project. After this the user with the role does not have permissions to access the project or its data anymore.
Note
|
Removing a role from a project will not remove any data that was generated by the user during the project. |
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Object deleted |
No Content |
default |
Error |
Produces
-
application/json
Example HTTP request
Request path
/roles/string
Example HTTP response
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.9. GET /users
Description
This endpoint accesses all users available for company.
Todo: Add missing documentation, CON-6287
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
email |
Fetch users with a given e-mail |
string |
Query |
username |
Fetch user with given user name |
string |
Query |
firstName |
Fetch users whose first name contains given string |
string |
Query |
lastName |
Fetch users whose last name contains given string |
string |
Query |
statusId |
Fetch users whose account is disabled (statusId=DISABLED) or enabled (statusId=ENABLED) |
string |
Query |
externalId |
Fetch user with given unique external id |
string |
Query |
projectId |
Fetch users with roles in given project (search by id) |
string |
Query |
projectCode |
Fetch users with roles in given project (search by project code) |
string |
Query |
projectOwnerId |
Fetch users with roles in projects of given company |
string |
Query |
modifiedAtGt |
Fetch all items that have been modified after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtGte |
Fetch all items that have been modified after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLt |
Fetch all items that have been modified before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
modifiedAtLte |
Fetch all items that have been modified before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGt |
Fetch all items that have been created after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtGte |
Fetch all items that have been created after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLt |
Fetch all items that have been created before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
createdAtLte |
Fetch all items that have been created before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGt |
Fetch all items that have been deleted after a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtGte |
Fetch all items that have been deleted after a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLt |
Fetch all items that have been deleted before a time (exclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
deletedAtLte |
Fetch all items that have been deleted before a time (inclusively). Date must be ISO 8601 format. For example: 2016-06-13T00:00:00.000Z |
string |
Query |
isDeleted |
Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0) from the endpoint. For nested object lists and pk lists use "includeNestedDeleted", which shows only existing (includeNestedDeleted=0) or all objects (includeNestedDeleted=1). |
string |
Query |
backendModifiedAtGt |
Fetch all items that have been modified after a time (exclusively) |
string |
Query |
backendModifiedAtGte |
Fetch all items that have been modified after a time (inclusively) |
string |
Query |
backendModifiedAtLt |
Fetch all items that have been modified before a time (exclusively) |
string |
Query |
backendModifiedAtLte |
Fetch all items that have been modified before a time (inclusively) |
string |
Query |
backendDeletedAtGt |
Fetch all items that have been deleted after a time (exclusively) |
string |
Query |
backendDeletedAtGte |
Fetch all items that have been deleted after a time (inclusively) |
string |
Query |
backendDeletedAtLt |
Fetch all items that have been deleted before a time (exclusively) |
string |
Query |
backendDeletedAtLte |
Fetch all items that have been deleted before a time (inclusively) |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |
results |
Array of result objects |
< results > array |
results
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
email |
Example : |
string |
externalGroups |
Example : |
string |
externalId |
Example : |
string |
firstName |
Example : |
string |
fullName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
lastName |
Example : |
string |
statusId |
Example : |
enum (ENABLED, DISABLED) |
username |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/users
Example HTTP response
Response 200
{
"count" : 1,
"next" : "https://api.congrid.com/<end-point path>?page=3",
"pageSize" : 100,
"previous" : "https://api.congrid.com/<end-point path>?page=1",
"results" : [ "object" ]
}
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.10. POST /users
Description
This endpoint accesses all users available for company.
Todo: Add missing documentation, CON-6287
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Post data |
Object to create |
Post data
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
email |
Example : |
string |
externalGroups |
Example : |
string |
externalId |
Example : |
string |
firstName |
Example : |
string |
fullName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
lastName |
Example : |
string |
statusId |
Example : |
enum (ENABLED, DISABLED) |
username |
Example : |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Object response |
|
default |
Error |
Response 201
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
email |
Example : |
string |
externalGroups |
Example : |
string |
externalId |
Example : |
string |
firstName |
Example : |
string |
fullName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
lastName |
Example : |
string |
statusId |
Example : |
enum (ENABLED, DISABLED) |
username |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/users
Request body
{
"companyIds" : [ "string" ],
"email" : "string",
"externalGroups" : "string",
"externalId" : "string",
"firstName" : "string",
"fullName" : "string",
"id" : "string",
"lastName" : "string",
"statusId" : "string",
"username" : "string"
}
Example HTTP response
Response 201
"object"
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.16.11. GET /users/{id}
Description
This endpoint accesses all users available for company.
Todo: Add missing documentation, CON-6287
Parameters
Type | Name | Schema |
---|---|---|
Path |
id |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
companyIds |
Example : |
< string > array |
email |
Example : |
string |
externalGroups |
Example : |
string |
externalId |
Example : |
string |
firstName |
Example : |
string |
fullName |
Example : |
string |
id |
Unique ID for the object given by backend server. |
string |
lastName |
Example : |
string |
statusId |
Example : |
enum (ENABLED, DISABLED) |
username |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/users/string
Example HTTP response
Response 200
"object"
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
2.17. Version
2.17.1. GET /version
Description
Version information of API.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Object response |
|
default |
Error |
Response 200
Name | Description | Schema |
---|---|---|
message |
Example : |
string |
version |
Example : |
string |
Produces
-
application/json
Example HTTP request
Request path
/version
Example HTTP response
Response 200
"object"
Response default
{
"code" : 400,
"data" : {
"<field name>" : "This field is required."
},
"message" : "Missing data"
}
3. Definitions
3.1. ErrorModel
Regular HTTP-method errors:
-
400 - Given object has errors in itself or in its field
-
403 - User privileges are not suitable for attempted operation
-
404 - Given page or object is not found or it is not visible to requesting user
-
405 - Method is not allowed
Name | Description | Schema |
---|---|---|
code |
Error code |
integer |
data |
Details about error. For example, list of problems. |
object |
message |
Error message |
string |
3.2. PagingResponse
The paging response contains the total number of available items available for querying. The page size defines how many objects are returned per page / per query.
Name | Description | Schema |
---|---|---|
count |
Total number of objects that are available for retrieval |
integer |
next |
Path to next page of objects |
string |
pageSize |
Number of objects to return per page |
integer |
previous |
Path to previous page of objects |
string |