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 : HTTP

1.4. Tags

  • companies

  • concrete

  • contacts

  • events

  • files

  • floor plans

  • measurements

  • notes

  • 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
optional

Fetch all items whose name contains a given string

string

Query

vatCode
optional

Fetch by given VAT-code

string

Query

isRalaCertified
optional

Fetch by RALA information. For more details see https://www.rala.fi/

string

Query

isRalaQualified
optional

Fetch by RALA information. For more details see https://www.rala.fi/

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

isDeleted
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

projectOwnerId
optional

Fetch all items related a project owned by a given company

string

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Company ID.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Company name.
Example : "string"

string

projectIds
optional

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

Produces
  • application/json

Example HTTP request
Request path
/companies
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
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
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Company ID.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Company name.
Example : "string"

string

projectIds
optional

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

Produces
  • application/json

Example HTTP request
Request path
/companies/string
Example HTTP response
Response 200
"object"
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
optional

Fetch all items related to a given company

string

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

companyId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Example : "string"

string

displayName
optional

Example : "string"

string

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

parentId
optional

Example : "string"

string

parentName
optional

Example : "string"

string

typeId
optional

Example : "string"

enum (CORPORATION, COMPANY, UNIT, FOREMAN, PERSONNEL, SITE)

Produces
  • application/json

Example HTTP request
Request path
/companyUnits
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
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
required

Object to create

Post data

Name Description Schema

companyId
required

Example : "string"

string

description
optional

Example : "string"

string

name
required

Example : "string"

string

parentId
optional

Example : "string"

string

typeId
required

Example : "string"

enum (CORPORATION, COMPANY, UNIT, FOREMAN, PERSONNEL, SITE)

Responses
HTTP Code Description Schema

201

Object response

default

Error

Response 201

Name Description Schema

companyId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Example : "string"

string

displayName
optional

Example : "string"

string

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

parentId
optional

Example : "string"

string

parentName
optional

Example : "string"

string

typeId
optional

Example : "string"

enum (CORPORATION, COMPANY, UNIT, FOREMAN, PERSONNEL, SITE)

Produces
  • application/json

Example HTTP request
Request path
/companyUnits
Request body
{
  "companyId" : "string",
  "description" : "string",
  "name" : "string",
  "parentId" : "string",
  "typeId" : "string"
}
Example HTTP response
Response 201
"object"
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
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

companyId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Example : "string"

string

displayName
optional

Example : "string"

string

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

parentId
optional

Example : "string"

string

parentName
optional

Example : "string"

string

typeId
optional

Example : "string"

enum (CORPORATION, COMPANY, UNIT, FOREMAN, PERSONNEL, SITE)

Produces
  • application/json

Example HTTP request
Request path
/companyUnits/string
Example HTTP response
Response 200
"object"
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
required

string

Body

Put data
required

Object’s update data

Put data

Name Description Schema

companyId
required

Example : "string"

string

description
optional

Example : "string"

string

name
required

Example : "string"

string

parentId
optional

Example : "string"

string

typeId
required

Example : "string"

enum (CORPORATION, COMPANY, UNIT, FOREMAN, PERSONNEL, SITE)

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

companyId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Example : "string"

string

displayName
optional

Example : "string"

string

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

parentId
optional

Example : "string"

string

parentName
optional

Example : "string"

string

typeId
optional

Example : "string"

enum (CORPORATION, COMPANY, UNIT, FOREMAN, PERSONNEL, SITE)

Produces
  • application/json

Example HTTP request
Request path
/companyUnits/string
Request body
{
  "companyId" : "string",
  "description" : "string",
  "name" : "string",
  "parentId" : "string",
  "typeId" : "string"
}
Example HTTP response
Response 200
"object"
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
required

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
required

string

Query

name
optional

Fetch all items whose name contains a given string

string

Query

vatCode
optional

Fetch by given VAT-code

string

Query

isRalaCertified
optional

Fetch by RALA information. For more details see https://www.rala.fi/

string

Query

isRalaQualified
optional

Fetch by RALA information. For more details see https://www.rala.fi/

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

isDeleted
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

projectOwnerId
optional

Fetch all items related a project owned by a given company

string

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Company ID.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Company name.
Example : "string"

string

projectIds
optional

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

Produces
  • application/json

Example HTTP request
Request path
/projects/string/companies
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
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
required

string

Body

Post data
required

Object to create

Post data

Name Description Schema

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

name
required

Company name.
Example : "string"

string

projectIds
required

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

Responses
HTTP Code Description Schema

201

Object response

default

Error

Response 201

Name Description Schema

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Company ID.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Company name.
Example : "string"

string

projectIds
optional

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

Produces
  • application/json

Example HTTP request
Request path
/projects/string/companies
Request body
{
  "companyTypeId" : "string",
  "name" : "string",
  "projectIds" : [ "string" ],
  "specifier" : "string",
  "vatCode" : "string",
  "verifiedVatCodeRequired" : true
}
Example HTTP response
Response 201
"object"
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
required

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Company ID.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Company name.
Example : "string"

string

projectIds
optional

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

Produces
  • application/json

Example HTTP request
Request path
/projects/string/companies/string
Example HTTP response
Response 200
"object"
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
required

string

Path

id
required

string

Body

Put data
required

Object’s update data

Put data

Name Description Schema

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

name
required

Company name.
Example : "string"

string

projectIds
required

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Company ID.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Company name.
Example : "string"

string

projectIds
optional

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

Produces
  • application/json

Example HTTP request
Request path
/projects/string/companies/string
Request body
{
  "companyTypeId" : "string",
  "name" : "string",
  "projectIds" : [ "string" ],
  "specifier" : "string",
  "vatCode" : "string",
  "verifiedVatCodeRequired" : true
}
Example HTTP response
Response 200
"object"
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
required

string

Path

id
required

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.2. Concrete

2.2.1. POST /concreteData/{concreteFileFormatId}

Parameters
Type Name Description Schema

Path

concreteFileFormatId
required

string

Body

Post data
required

Object to create

Post data

Name Description Schema

file
required

Example : "string"

string

Responses
HTTP Code Description Schema

201

Object response

default

Error

Response 201

Name Description Schema

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

errors
optional

Example : [ "string" ]

< string > array

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

status
optional

Example : "string"

enum (PENDING, QUEUED, PARSING, FAILED, SUCCESS)

Produces
  • application/json

Example HTTP request
Request path
/concreteData/string
Request body
{
  "file" : "string"
}
Example HTTP response
Response 201
"object"
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
required

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

errors
optional

Example : [ "string" ]

< string > array

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

status
optional

Example : "string"

enum (PENDING, QUEUED, PARSING, FAILED, SUCCESS)

Produces
  • application/json

Example HTTP request
Request path
/concreteData/string/string
Example HTTP response
Response 200
"object"
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

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

email
optional

Fetch all contacts with given e-mail address

string

Query

companyId
optional

Fetch all items related to a given company

string

Query

projectId
optional

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
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

companyId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

email
optional

Example : "string"

string

id
optional

Example : "string"

string

isManager
optional

Example : true

boolean

isVisibleInMobileClient
optional

Example : true

boolean

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

phone
optional

Example : "string"

string

projectId
optional

Example : "string"

string

taxNumber
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/contacts
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.3.2. 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
required

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

email
optional

Fetch all contacts with given e-mail address

string

Query

companyId
optional

Fetch all items related to a given company

string

Query

projectId
optional

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
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

companyId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

email
optional

Example : "string"

string

id
optional

Example : "string"

string

isManager
optional

Example : true

boolean

isVisibleInMobileClient
optional

Example : true

boolean

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

phone
optional

Example : "string"

string

projectId
optional

Example : "string"

string

taxNumber
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/contacts
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.3.3. 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
required

string

Body

Post data
required

Object to create

Post data

Name Description Schema

companyId
required

Example : "string"

string

email
optional

Example : "string"

string

isManager
optional

Example : true

boolean

isVisibleInMobileClient
optional

Example : true

boolean

name
optional

Example : "string"

string

phone
optional

Example : "string"

string

projectId
optional

Example : "string"

string

taxNumber
optional

Example : "string"

string

Responses
HTTP Code Description Schema

201

Object response

default

Error

Response 201

Name Description Schema

companyId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

email
optional

Example : "string"

string

id
optional

Example : "string"

string

isManager
optional

Example : true

boolean

isVisibleInMobileClient
optional

Example : true

boolean

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

phone
optional

Example : "string"

string

projectId
optional

Example : "string"

string

taxNumber
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/contacts
Request body
{
  "companyId" : "string",
  "email" : "string",
  "isManager" : true,
  "isVisibleInMobileClient" : true,
  "name" : "string",
  "phone" : "string",
  "projectId" : "string",
  "taxNumber" : "string"
}
Example HTTP response
Response 201
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.3.4. 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
required

string

Path

id
required

string

Body

Put data
required

Object’s update data

Put data

Name Description Schema

companyId
required

Example : "string"

string

email
optional

Example : "string"

string

isManager
optional

Example : true

boolean

isVisibleInMobileClient
optional

Example : true

boolean

name
optional

Example : "string"

string

phone
optional

Example : "string"

string

projectId
optional

Example : "string"

string

taxNumber
optional

Example : "string"

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

companyId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

email
optional

Example : "string"

string

id
optional

Example : "string"

string

isManager
optional

Example : true

boolean

isVisibleInMobileClient
optional

Example : true

boolean

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

phone
optional

Example : "string"

string

projectId
optional

Example : "string"

string

taxNumber
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/contacts/string
Request body
{
  "companyId" : "string",
  "email" : "string",
  "isManager" : true,
  "isVisibleInMobileClient" : true,
  "name" : "string",
  "phone" : "string",
  "projectId" : "string",
  "taxNumber" : "string"
}
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.3.5. 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
required

string

Path

id
required

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. Events

2.4.1. GET /events

Parameters
Type Name Description Schema

Query

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

noteId
optional

Fetch all items related to a given note

string

Query

measurementId
optional

Fetch all items related to a given measurement

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

name
optional

Fetch all items whose name contains a given string

string

Query

tags
optional

Fetch all items that contain a given tag

string

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

comment
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

diaryId
optional

Example : "string"

string

eventTypeId
optional

Example : "string"

enum (EMAIL_SENT, CREATED_REPORT, SEND_REPORT, CHANGED_STATUS, CHANGED_RESPONSIBLE, CHANGED_DESCRIPTION, CHANGED_SPECIAL_REMARK, CHANGED_REQUIRED_ACTION, CHANGED_REQUIRED_ACTION_LEVEL, CHANGED_TARGET, CHANGED_TARGET_DESCRIPTION, CHANGED_WORK_SECTION, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_NAME, CHANGED_PARTICIPANTS, CHANGED_ACCEPTORS, TYPE_CHANGED_ASSIGNED_TO_USER, CHANGED_OBSERVED_AT, TYPE_CHANGED_NOTE_DYNAMIC_DATA, MARKED_PENDING, MARKED_RECEIVED, MARKED_WIP, MARKED_COMPLETE, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_ACCEPTED, MARKED_REJECTED, MARKED_NOT_APPLICABLE, MARKED_CANNOT_MEASURE, DELETED, UNDELETED, ENTRY_CREATED, ENTRY_MARKED_LOCKED, ENTRY_MARKED_UNLOCKED, ENTRY_MARKED_ACCEPTED, MAINTENANCE_MESSAGE, MAINTENANCE_CUSTOMER_CONTACT, MAINTENANCE_RECORD_INVITE_TRIGGER, MAINTENANCE_RECORD_INVITE_PROCESSED, MAINTENANCE_RECORD_REPORT, MAINTENANCE_RECORD_MARKED_PENDING, MAINTENANCE_RECORD_MARKED_ACCEPTED)

id
optional

Example : "string"

string

measurementIds
optional

Example : [ "string" ]

< string > array

measurementTopicIds
optional

Example : [ "string" ]

< string > array

noteId
optional

Example : "string"

string

originalProjectId
optional

Example : "string"

string

projectId
optional

Example : "string"

string

statusIdFrom
optional

Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, FIX, WAIT, FOLLOW, NO_ACTIONS)

statusIdTo
optional

Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, FIX, WAIT, FOLLOW, NO_ACTIONS)

statusUpdatedAt
optional

Example : "string"

string (date-time)

statusUpdatedBy
optional

Example : "string"

string

statusUpdatedByFullName
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/events
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.4.2. GET /files

Parameters
Type Name Description Schema

Query

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

noteId
optional

Fetch all items related to a given note

string

Query

measurementId
optional

Fetch all items related to a given measurement

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

name
optional

Fetch all items whose name contains a given string

string

Query

tags
optional

Fetch all items that contain a given tag

string

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

downloadUrl
optional

Example : "string"

string

filename
optional

Example : "string"

string

id
optional

Example : "string"

string

inspectionIds
optional

Example : [ "string" ]

< string > array

listIds
optional

Example : [ "string" ]

< string > array

measurementIds
optional

Example : [ "string" ]

< string > array

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

name
optional

Example : "string"

string

projectId
optional

Example : "string"

string

tags
optional

Example : [ "string" ]

< string > array

workActivityIds
optional

Example : [ "string" ]

< string > array

workSectionIds
optional

Example : [ "string" ]

< string > array

Produces
  • application/json

Example HTTP request
Request path
/files
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.4.3. GET /projects/{projectId}/files

Parameters
Type Name Description Schema

Path

projectId
required

string

Query

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

noteId
optional

Fetch all items related to a given note

string

Query

measurementId
optional

Fetch all items related to a given measurement

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

name
optional

Fetch all items whose name contains a given string

string

Query

tags
optional

Fetch all items that contain a given tag

string

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

downloadUrl
optional

Example : "string"

string

filename
optional

Example : "string"

string

id
optional

Example : "string"

string

inspectionIds
optional

Example : [ "string" ]

< string > array

listIds
optional

Example : [ "string" ]

< string > array

measurementIds
optional

Example : [ "string" ]

< string > array

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

name
optional

Example : "string"

string

projectId
optional

Example : "string"

string

tags
optional

Example : [ "string" ]

< string > array

workActivityIds
optional

Example : [ "string" ]

< string > array

workSectionIds
optional

Example : [ "string" ]

< string > array

Produces
  • application/json

Example HTTP request
Request path
/projects/string/files
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.5. Files

2.5.1. GET /photos

Description

Through this end-point you can retrieve meta data about files in Congrid system.

To download a file use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl for each file you want to download. URL is valid for 24 hours after being generated by this call.

Each file can be tagged with multiple tags. Tags can have arbitrary names but there are some static tags called system tags that Congrid system uses internally.

Below is a list of system tags and their descriptions:

  • TR_MEASUREMENT - A report from TR measurement

  • MVR_MEASUREMENT - A report from MVR measurement

  • ASPHALT_MEASUREMENT - A report from asphalt measurement

  • QUALITY_MEASUREMENT - A report from RT quality measurement

  • QUALITY_INSPECTION - A report from a quality inspection

  • NOTES - A report from notes

There are two additional tags which specify whether the report is generated automatically by the system or manually by the user. These tags are:

  • SYSTEM_GENERATED - report automatically generated by the system * USER_GENERATED - report manually generated by the user

SYSTEM_GENERATED reports are automatically generated with the following rules:

  • All measurement & inspection related reports once the measurement or inspection is marked as completed.

  • NOTES report is generated on the first day of the month for all changed notes in the previous month. This needs to be separately enabled for a company.

The automatically generated measurements follow this naming convention (timestamp being the timestamp of when the file was generated at Congrid system):

 <type>_<year>_week_<week_number>_<name>_<target name>_<timestamp>.pdf

For example: TR_2016_week_46_TR-measurement-project_area-1_20161218-142921.pdf

The automatically generated inspection files follow this naming convention (timestamp being the timestamp of when the file was generated at Congrid system):

 <type>_[<work section name>]_<timestamp>.pdf

For example: QUALITY_Ground-works_20161218-142921.pdf

The automatically generated notes reports follow this naming convention (timestamp being the timestamp of when the file was generated at Congrid system):

 <type>_<timestamp>_<report number>_of_<number of all generated reports>.pdf

For example: NOTES_20161218-142921_1_of_2.pdf

Parameters
Type Name Description Schema

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

projectOwnerId
optional

Fetch all items related a project owned by a given company

string

Query

concreteRecordId
optional

Fetch all items related to a given Concrete Record

string

Query

measurementId
optional

Fetch all items related to a given measurement

string

Query

noteId
optional

Fetch all items related to a given note

string

Query

noteTypeId
optional

Fetch all items that are the given note type

string

Query

noteClassId
optional

Fetch all items that are the given note class

string

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

downloadUrl
optional

Example : "string"

string

filename
optional

Example : "string"

string

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

projectId
optional

Example : "string"

string

thumbnailUrl256
optional

Example : "string"

string

thumbnailUrl512
optional

Example : "string"

string

thumbnailUrl768
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/photos
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.5.2. GET /photos/{id}

Description

Through this end-point you can retrieve meta data about files in Congrid system.

To download a file use the detailed end-point (this endpoint with id as last part of URL) to get a signed downloadUrl for each file you want to download. URL is valid for 24 hours after being generated by this call.

Each file can be tagged with multiple tags. Tags can have arbitrary names but there are some static tags called system tags that Congrid system uses internally.

Below is a list of system tags and their descriptions:

  • TR_MEASUREMENT - A report from TR measurement

  • MVR_MEASUREMENT - A report from MVR measurement

  • ASPHALT_MEASUREMENT - A report from asphalt measurement

  • QUALITY_MEASUREMENT - A report from RT quality measurement

  • QUALITY_INSPECTION - A report from a quality inspection

  • NOTES - A report from notes

There are two additional tags which specify whether the report is generated automatically by the system or manually by the user. These tags are:

  • SYSTEM_GENERATED - report automatically generated by the system * USER_GENERATED - report manually generated by the user

SYSTEM_GENERATED reports are automatically generated with the following rules:

  • All measurement & inspection related reports once the measurement or inspection is marked as completed.

  • NOTES report is generated on the first day of the month for all changed notes in the previous month. This needs to be separately enabled for a company.

The automatically generated measurements follow this naming convention (timestamp being the timestamp of when the file was generated at Congrid system):

 <type>_<year>_week_<week_number>_<name>_<target name>_<timestamp>.pdf

For example: TR_2016_week_46_TR-measurement-project_area-1_20161218-142921.pdf

The automatically generated inspection files follow this naming convention (timestamp being the timestamp of when the file was generated at Congrid system):

 <type>_[<work section name>]_<timestamp>.pdf

For example: QUALITY_Ground-works_20161218-142921.pdf

The automatically generated notes reports follow this naming convention (timestamp being the timestamp of when the file was generated at Congrid system):

 <type>_<timestamp>_<report number>_of_<number of all generated reports>.pdf

For example: NOTES_20161218-142921_1_of_2.pdf

Parameters
Type Name Schema

Path

id
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

downloadUrl
optional

Example : "string"

string

filename
optional

Example : "string"

string

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

projectId
optional

Example : "string"

string

thumbnailUrl256
optional

Example : "string"

string

thumbnailUrl512
optional

Example : "string"

string

thumbnailUrl768
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/photos/string
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6. Floor Plans

2.6.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
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Example : "string"

string

name
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/floorPlanTypes
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6.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
required

string

Path

id
required

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.6.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
required

string

Query

name
optional

Fetch all items whose name contains a given string

string

Query

slug
optional

Fetch all items whose slug contains a given string

string

Query

availableForTiling
optional

Fetch all items that are available for tiling (availableForTiling=1) or that are not available for tiling (availableForTiling=0)

string

Query

availableInApp
optional

Fetch all items that are available in application (availableInApp=1) or that are not available in application (availableInApp=0)

string

Query

invalidFloorPlan
optional

Fetch all items with invalid floor plan (invalidFloorPlan=1) or with valid floor plan (invalidFloorPlan=0)

string

Query

typeId
optional

Fetch all items with a given type

string

Query

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

projectOwnerId
optional

Fetch all items related a project owned by a given company

string

Query

targetRecordId
optional

Fetch all items related to a given target record

string

Query

maintenanceCycleId
optional

Fetch all items related to a given maintenance cycle

string

Query

updatedVersionId
optional

Fetch all items related to a given floor plan

string

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

availableForTiling
optional

Example : true

boolean

availableInApp
optional

Example : true

boolean

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Example : "string"

string

floorPlanTypeId
optional

Example : "string"

string

id
optional

Example : "string"

string

invalidFloorPlan
optional

Example : true

boolean

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

nextVersionId
optional

Example : "string"

string

projectId
optional

Example : "string"

string

slug
optional

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.
Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/floorPlans
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6.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 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 in form-data field file. An example curl reqeust for the PUT:

   curl -v --upload-file "file=@/tmp/123.pdf"
   "https://s3-eu-west-1.amazonaws.com/congrid/projects/abc/floorplans/123.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=1&X-Amz-Credential=Awest-1&X-Amz-SignedHeaders=host&X-Amz-Date=2016&X-Amz-Signature=5"

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.

Parameters
Type Name Description Schema

Path

projectId
required

string

Body

Post data
required

Object to create

Post data

Name Description Schema

availableForTiling
optional

Example : true

boolean

availableInApp
optional

Example : true

boolean

description
optional

Example : "string"

string

floorPlanTypeId
optional

Example : "string"

string

invalidFloorPlan
optional

Example : true

boolean

name
optional

Example : "string"

string

projectId
required

Example : "string"

string

slug
optional

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.
Example : "string"

string

Responses
HTTP Code Description Schema

201

Object response

default

Error

Response 201

Name Description Schema

availableForTiling
optional

Example : true

boolean

availableInApp
optional

Example : true

boolean

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Example : "string"

string

floorPlanTypeId
optional

Example : "string"

string

id
optional

Example : "string"

string

invalidFloorPlan
optional

Example : true

boolean

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

nextVersionId
optional

Example : "string"

string

projectId
optional

Example : "string"

string

slug
optional

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.
Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/floorPlans
Request body
{
  "availableForTiling" : true,
  "availableInApp" : true,
  "description" : "string",
  "floorPlanTypeId" : "string",
  "invalidFloorPlan" : true,
  "name" : "string",
  "projectId" : "string",
  "slug" : "string"
}
Example HTTP response
Response 201
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6.5. POST /projects/{projectId}/floorPlans/{floorPlanId}/uploaded

Parameters
Type Name Description Schema

Path

projectId
required

string

Path

floorPlanId
required

string

Body

Post data
required

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.6.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
required

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

availableForTiling
optional

Example : true

boolean

availableInApp
optional

Example : true

boolean

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Example : "string"

string

floorPlanTypeId
optional

Example : "string"

string

id
optional

Example : "string"

string

invalidFloorPlan
optional

Example : true

boolean

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

nextVersionId
optional

Example : "string"

string

projectId
optional

Example : "string"

string

signedUploadPost
optional

Example : "string"

string

slug
optional

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.
Example : "string"

string

uploadUrl
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/floorPlans/string
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6.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
required

string

Path

id
required

string

Body

Put data
required

Object’s update data

Put data

Name Description Schema

availableForTiling
optional

Example : true

boolean

availableInApp
optional

Example : true

boolean

description
optional

Example : "string"

string

floorPlanTypeId
optional

Example : "string"

string

invalidFloorPlan
optional

Example : true

boolean

name
optional

Example : "string"

string

projectId
required

Example : "string"

string

slug
optional

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.
Example : "string"

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

availableForTiling
optional

Example : true

boolean

availableInApp
optional

Example : true

boolean

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Example : "string"

string

floorPlanTypeId
optional

Example : "string"

string

id
optional

Example : "string"

string

invalidFloorPlan
optional

Example : true

boolean

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

nextVersionId
optional

Example : "string"

string

projectId
optional

Example : "string"

string

signedUploadPost
optional

Example : "string"

string

slug
optional

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.
Example : "string"

string

uploadUrl
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/floorPlans/string
Request body
{
  "availableForTiling" : true,
  "availableInApp" : true,
  "description" : "string",
  "floorPlanTypeId" : "string",
  "invalidFloorPlan" : true,
  "name" : "string",
  "projectId" : "string",
  "slug" : "string"
}
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6.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
required

string

Path

id
required

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.6.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
required

string

Query

floorPlanId
optional

Fetch all items related to a given floor plan

string

Query

targetId
optional

Fetch all items related to a given target

string

Query

projectId
optional

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
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

floorPlanId
optional

Example : "string"

string

id
optional

Example : "string"

string

targetId
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/targetFloorPlans
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6.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
required

string

Body

Post data
required

Object to create

Post data

Name Description Schema

floorPlanId
required

Example : "string"

string

targetId
required

Example : "string"

string

Responses
HTTP Code Description Schema

201

Object response

default

Error

Response 201

Name Description Schema

floorPlanId
optional

Example : "string"

string

id
optional

Example : "string"

string

targetId
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/targetFloorPlans
Request body
{
  "floorPlanId" : "string",
  "targetId" : "string"
}
Example HTTP response
Response 201
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6.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
required

string

Path

id
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

floorPlanId
optional

Example : "string"

string

id
optional

Example : "string"

string

targetId
optional

Example : "string"

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.6.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
required

string

Path

id
required

string

Body

Put data
required

Object’s update data

Put data

Name Description Schema

floorPlanId
required

Example : "string"

string

targetId
required

Example : "string"

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

floorPlanId
optional

Example : "string"

string

id
optional

Example : "string"

string

targetId
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/projects/string/targetFloorPlans/string
Request body
{
  "floorPlanId" : "string",
  "targetId" : "string"
}
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.6.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
required

string

Path

id
required

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.7. Measurements

2.7.1. 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

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

measurementId
optional

Fetch all items related to a given measurement

string

Query

inspectionId
optional

Fetch all items related to a given inspection

string

Query

isDeleted
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

deletedAtGt
optional

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
optional

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
optional

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
optional

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

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

comments
optional

Comments for the measurement topic.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID for measurement topic.
Example : "string"

string

inspectionId
optional

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.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name for measurement topic.
Example : "string"

string

orderNumber
optional

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.
Example : "string"

string

statusId
optional

Status value for the measurement topic.
Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE)

templateId
optional

Measurement tempalte ID of parent measurement template that was used as a base for the measurement object.
Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/inspectionTopics
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.7.2. 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
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

comments
optional

Comments for the measurement topic.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID for measurement topic.
Example : "string"

string

inspectionId
optional

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.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name for measurement topic.
Example : "string"

string

orderNumber
optional

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.
Example : "string"

string

statusId
optional

Status value for the measurement topic.
Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE)

templateId
optional

Measurement tempalte ID of parent measurement template that was used as a base for the measurement object.
Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/inspectionTopics/string
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.7.3. 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.

GET returns by default only the data of completed measurements. This means measurements having one of the following statusId values: COMPLETED, ACCEPTED, REJECTED, VERIFIED. Use the optional statusId query parameter to fetch data of measurements with a different statusId value.

Parameters
Type Name Description Schema

Query

isCombinedMeasurement
optional

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
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

projectOwnerId
optional

Fetch all items related a project owned by a given company

string

Query

workSectionId
optional

Fetch all items related to a given work section

string

Query

workActivityId
optional

Fetch all items related to a given work activity

string

Query

matrixId
optional

Fetch all items related to a given matrix

string

Query

matrixCellId
optional

Fetch all items related to a given matrix cell

string

Query

measurementCategoryId
optional

Fetch all items with a given measurement category

string

Query

measurementTypeId
optional

Fetch all items with a given measurement type

string

Query

inspectionTypeId
optional

Fetch all items with a given inspection type

string

Query

statusId
optional

Fetch all items with a given status

string

Query

languageIds
optional

Fetch all items that match with all given language tags (one or more)

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

isDeleted
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

deletedAtGt
optional

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
optional

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
optional

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
optional

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

isCompleteMeasurement
optional

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

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

correlationId
optional

Correlation ID of the object.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID of the object.
Example : "string"

string

inspectionCategoryId
optional

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.
Example : "string"

enum (INTERNAL, EXTERNAL, COMPETITION)

inspectionTypeId
optional

Type of the object.
Example : "string"

enum (PUNCH, TR, MVR, SAFETY_WALK, MEMO, QUALITY, ASPHALT, QUALITY_INSPECTION, SAFETY, PHOTO, MAINTENANCE, INDUCTION, NOTIFICATION)

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name of the object.
Example : "string"

string

projectCode
optional

Example : "string"

string

projectId
optional

Example : "string"

string

projectName
optional

Example : "string"

string

statusId
optional

Status of the object.
Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE)

targetId
optional

Example : "string"

string

templateId
optional

Example : "string"

string

weekNumber
optional

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.
Example : 0

integer

workActivityId
optional

Example : "string"

string

workSectionId
optional

Example : "string"

string

year
optional

Year when measurement was done. The complete create timestamp can be found from "createdAt" property.
Example : 0

integer

Produces
  • application/json

Example HTTP request
Request path
/inspections
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.7.4. 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
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

correlationId
optional

Correlation ID of the object.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID of the object.
Example : "string"

string

inspectionCategoryId
optional

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.
Example : "string"

enum (INTERNAL, EXTERNAL, COMPETITION)

inspectionTypeId
optional

Type of the object.
Example : "string"

enum (PUNCH, TR, MVR, SAFETY_WALK, MEMO, QUALITY, ASPHALT, QUALITY_INSPECTION, SAFETY, PHOTO, MAINTENANCE, INDUCTION, NOTIFICATION)

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name of the object.
Example : "string"

string

projectCode
optional

Example : "string"

string

projectId
optional

Example : "string"

string

projectName
optional

Example : "string"

string

statusId
optional

Status of the object.
Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE)

targetId
optional

Example : "string"

string

templateId
optional

Example : "string"

string

weekNumber
optional

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.
Example : 0

integer

workActivityId
optional

Example : "string"

string

workSectionId
optional

Example : "string"

string

year
optional

Year when measurement was done. The complete create timestamp can be found from "createdAt" property.
Example : 0

integer

Produces
  • application/json

Example HTTP request
Request path
/inspections/string
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.7.5. 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.

GET returns by default only the data of completed measurements. This means measurements having one of the following statusId values: COMPLETED, ACCEPTED, REJECTED, VERIFIED. Use the optional statusId query parameter to fetch data of measurements with a different statusId value.

Parameters
Type Name Description Schema

Query

isCombinedMeasurement
optional

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
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

projectOwnerId
optional

Fetch all items related a project owned by a given company

string

Query

workSectionId
optional

Fetch all items related to a given work section

string

Query

workActivityId
optional

Fetch all items related to a given work activity

string

Query

matrixId
optional

Fetch all items related to a given matrix

string

Query

matrixCellId
optional

Fetch all items related to a given matrix cell

string

Query

measurementCategoryId
optional

Fetch all items with a given measurement category

string

Query

measurementTypeId
optional

Fetch all items with a given measurement type

string

Query

inspectionTypeId
optional

Fetch all items with a given inspection type

string

Query

statusId
optional

Fetch all items with a given status

string

Query

languageIds
optional

Fetch all items that match with all given language tags (one or more)

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

isDeleted
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

deletedAtGt
optional

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
optional

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
optional

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
optional

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

isCompleteMeasurement
optional

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

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID of the object.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name of the object.
Example : "string"

string

projectId
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/lists
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.7.6. 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
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID of the object.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name of the object.
Example : "string"

string

projectId
optional

Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/lists/string
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.7.7. 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

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

projectId
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

measurementId
optional

Fetch all items related to a given measurement

string

Query

inspectionId
optional

Fetch all items related to a given inspection

string

Query

isDeleted
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

deletedAtGt
optional

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
optional

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
optional

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
optional

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

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

correlationId
optional

Correlation ID for measurement topic.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID for measurement topic.
Example : "string"

string

measurementId
optional

Measurement ID of parent measurement.
Example : "string"

string

minusCountWeighted
optional

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.
Example : 0

integer

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name for measurement topic.
Example : "string"

string

negativeMultiplier
optional

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.
Example : 0.0

number

orderNumber
optional

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.
Example : "string"

string

plusCountWeighted
optional

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.
Example : 0

integer

positiveMultiplier
optional

Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property.
Example : 0.0

number

result
optional

Final result for the measurement topic.
Example : 0.0

number

templateId
optional

Measurement tempalte ID of parent measurement template that was used as a base for the measurement object.
Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/measurementTopics
Example HTTP response
Response 200
{
  "count" : 1,
  "next" : "http://address.com/page_name?page=3",
  "pageSize" : 100,
  "previous" : "http://address.com/page_name?page=1",
  "results" : [ "object" ]
}
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.7.8. 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
required

string

Responses
HTTP Code Description Schema

200

Object response

default

Error

Response 200

Name Description Schema

correlationId
optional

Correlation ID for measurement topic.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID for measurement topic.
Example : "string"

string

measurementId
optional

Measurement ID of parent measurement.
Example : "string"

string

minusCountWeighted
optional

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.
Example : 0

integer

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name for measurement topic.
Example : "string"

string

negativeMultiplier
optional

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.
Example : 0.0

number

orderNumber
optional

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.
Example : "string"

string

plusCountWeighted
optional

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.
Example : 0

integer

positiveMultiplier
optional

Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property.
Example : 0.0

number

result
optional

Final result for the measurement topic.
Example : 0.0

number

templateId
optional

Measurement tempalte ID of parent measurement template that was used as a base for the measurement object.
Example : "string"

string

Produces
  • application/json

Example HTTP request
Request path
/measurementTopics/string
Example HTTP response
Response 200
"object"
Response default
{
  "code" : 400,
  "data" : {
    "field_name" : "This field is required."
  },
  "message" : "Missing data"
}

2.7.9. 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.

GET returns by default only the data of completed measurements. This means measurements having one of the following statusId values: COMPLETED, ACCEPTED, REJECTED, VERIFIED. Use the optional statusId query parameter to fetch data of measurements with a different statusId value.

Parameters
Type Name Description Schema

Query

isCombinedMeasurement
optional

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
optional

Fetch all items related to a given project

string

Query

projectCode
optional

Fetch all items related to a given project (search by project code)

string

Query

projectOwnerId
optional

Fetch all items related a project owned by a given company

string

Query

workSectionId
optional

Fetch all items related to a given work section

string

Query

workActivityId
optional

Fetch all items related to a given work activity

string

Query

matrixId
optional

Fetch all items related to a given matrix

string

Query

matrixCellId
optional

Fetch all items related to a given matrix cell

string

Query

measurementCategoryId
optional

Fetch all items with a given measurement category

string

Query

measurementTypeId
optional

Fetch all items with a given measurement type

string

Query

inspectionTypeId
optional

Fetch all items with a given inspection type

string

Query

statusId
optional

Fetch all items with a given status

string

Query

languageIds
optional

Fetch all items that match with all given language tags (one or more)

string

Query

modifiedAtGt
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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
optional

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

isDeleted
optional

Fetch only deleted items (isDeleted=1) or only existing items (isDeleted=0)

string

Query

deletedAtGt
optional

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
optional

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
optional

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
optional

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

isCompleteMeasurement
optional

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

Responses
HTTP Code Description Schema

200

List response

default

Error

Response 200

Name Description Schema

count
optional

Total number of objects that are available for retrieval
Example : 1

integer

next
optional

Path to next page of objects
Example : "http://address.com/page_name?page=3"

string

pageSize
optional

Number of objects to return per page
Example : 100

integer

previous
optional

Path to previous page of objects
Example : "http://address.com/page_name?page=1"

string

results
optional

Array of result objects
Example : [ "object" ]

< results > array

results

Name Description Schema

correlationId
optional

Correlation ID of the object.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Unique ID of the object.
Example : "string"

string

isCombinedMeasurement
optional

Boolean defines if measurement object is a combination of multiple measurements.
Example : true

boolean

measurementCategoryId
optional

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.
Example : "string"

enum (INTERNAL, EXTERNAL, COMPETITION)

measurementId
optional

Example : "string"

string

measurementTypeId
optional

Type of the object.
Example : "string"

enum (PUNCH, TR, MVR, SAFETY_WALK, MEMO, QUALITY, ASPHALT, QUALITY_INSPECTION, SAFETY, PHOTO, MAINTENANCE, INDUCTION, NOTIFICATION)

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name of the object.
Example : "string"

string

parentMeasurementId
optional

Parent measurement is top level measurement object. If measurement is part of measurement combination, parent measurement is the result of the combination.
Example : "string"

string

projectCode
optional

Example : "string"

string

projectId
optional

Example : "string"

string

projectName
optional

Example : "string"

string

result
optional

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.
Example : 0.0

number

statusId
optional

Status of the object.
Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE)

targetId
optional

Example : "string"

string

templateId
optional

Example : "string"

string

topics
optional

Example : [ "object" ]

< topics > array

weekNumber
optional

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.
Example : 0

integer

workActivityId
optional

Example : "string"

string

workSectionId
optional

Example : "string"

string

year
optional

Year when measurement was done. The complete create timestamp can be found from "createdAt" property.
Example : 0

integer

topics

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

categoryTagRelations
optional

Example : [ "object" ]

comments
optional

Comments for the measurement topic.
Example : "string"

string

contactIds
optional

Example : [ "string" ]

< string > array

correlationId
optional

Correlation ID for measurement topic.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Description for measurement topic.
Example : "string"

string

descriptionFormatId
optional

Description format ID describes how description field should be rendered.
Example : "string"

enum (H1, H2, PLAIN, MARKDOWN)

enabledNoteClassIds
optional

Example : [ "string" ]

< enum (TASK, DOCUMENTATION, POSITIVE, NOTIFICATION) > array

enabledStatusIds
optional

Example : [ "string" ]

< enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE) > array

events
optional

Example : [ "object" ]

< events > array

fileRelations
optional

Example : [ "object" ]

< fileRelations > array

id
optional

Unique ID for measurement topic.
Example : "string"

string

inspectionId
optional

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.
Example : "string"

string

isCommentsEnabled
optional

Flag for defining if measurement topic comments are enabled when making the measurement.
Example : true

boolean

isContactsEnabled
optional

Flag for defining if measurement topic contacts are enabled when making the measurement.
Example : true

boolean

isFilesEnabled
optional

Flag for defining if measurement topic files are enabled when making the measurement.
Example : true

boolean

isNotesEnabled
optional

Flag for defining if measurement topic notes are enabled when making the measurement.
Example : true

boolean

isStatusIdEnabled
optional

Flag for defining if measurement topic status is enabled when making the measurement.
Example : true

boolean

isStatusIdMandatory
optional

Flag for defining if measurement topic status is mandatory when making the measurement.
Example : true

boolean

measurementId
optional

Measurement ID of parent measurement.
Example : "string"

string

measurementOptionGroupId
optional

Example : "string"

string

measurementOptionGroupTemplateId
optional

Example : "string"

string

measurementOptionTypeId
optional

Type for measurement topic. Type affect how topic is rendered and how it’s processed during measurement processing.
Example : "string"

enum (LEVEL, STATUS, TEXT, TOPIC_TYPE_ID_GENERIC, TOPIC_TYPE_GENERIC)

measurementTopicGroupId
optional

Measurement topic group ID for parent measurement topic group that measurement topic belongs to.
Example : "string"

string

measurementTopicGroupTemplateId
optional

Measurement topic group template ID for parent measurement topic group that measurement topic template belongs to.
Example : "string"

string

minusCountWeighted
optional

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.
Example : 0

integer

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Name for measurement topic.
Example : "string"

string

negativeMultiplier
optional

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.
Example : 0.0

number

noteIds
optional

Example : [ "string" ]

< string > array

notes
optional

Example : [ "object" ]

< notes > array

orderNumber
optional

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.
Example : "string"

string

photoIds
optional

Example : [ "string" ]

< string > array

photos
optional

Example : [ "object" ]

< photos > array

plusCountWeighted
optional

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.
Example : 0

integer

positiveMultiplier
optional

Positive multiplier for measurement topic template. For more details see "negativeMultiplier" property.
Example : 0.0

number

result
optional

Final result for the measurement topic.
Example : 0.0

number

statusId
optional

Status value for the measurement topic.
Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, NOT_APPLICABLE, CANNOT_MEASURE)

templateId
optional

Measurement tempalte ID of parent measurement template that was used as a base for the measurement object.
Example : "string"

string

topicCode
optional

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.
Example : "string"

string

typeId
optional

Type for measurement topic. Type affect how topic is rendered and how it’s processed during measurement processing.
Example : "string"

enum (LEVEL, STATUS, TEXT, TOPIC_TYPE_ID_GENERIC, TOPIC_TYPE_GENERIC)

uiOrderNumber
optional

UI order number for measurement topic. For more details see "orderNumber" property

Users don’t see UI order number but only the "orderNumber".
Example : "string"

string

categoryTagRelations

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

correlationId
optional

Correlation ID for note.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

dataSourceTagId
optional

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.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.

API allows deleting tag relations by setting the 'deletedAt' timestamp.
Example : "string"

string

generalFileId
optional

ID of the related general file object.
Example : "string"

string

id
optional

Unique ID for tag relation.
Example : "string"

string

measurementId
optional

ID of the related measurement object.
Example : "string"

string

measurementOptionId
optional

ID of the related measurement option object.
Example : "string"

string

measurementOptionTemplateId
optional

ID of the related measurement option template object.
Example : "string"

string

measurementTemplateId
optional

ID of the related measurement template object.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

noteId
optional

ID of the related general file object.
Example : "string"

string

tagId
optional

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.
Example : "string"

string

workSectionDocumentId
optional

ID of the related work section document object.
Example : "string"

string

events

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

comment
optional

Example : "string"

string

concreteRecordId
optional

Example : "string"

string

correlationId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

diaryId
optional

Example : "string"

string

eventTypeId
optional

Example : "string"

enum (EMAIL_SENT, CREATED_REPORT, SEND_REPORT, CHANGED_STATUS, CHANGED_RESPONSIBLE, CHANGED_DESCRIPTION, CHANGED_SPECIAL_REMARK, CHANGED_REQUIRED_ACTION, CHANGED_REQUIRED_ACTION_LEVEL, CHANGED_TARGET, CHANGED_TARGET_DESCRIPTION, CHANGED_WORK_SECTION, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_NAME, CHANGED_PARTICIPANTS, CHANGED_ACCEPTORS, TYPE_CHANGED_ASSIGNED_TO_USER, CHANGED_OBSERVED_AT, TYPE_CHANGED_NOTE_DYNAMIC_DATA, MARKED_PENDING, MARKED_RECEIVED, MARKED_WIP, MARKED_COMPLETE, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_ACCEPTED, MARKED_REJECTED, MARKED_NOT_APPLICABLE, MARKED_CANNOT_MEASURE, DELETED, UNDELETED, ENTRY_CREATED, ENTRY_MARKED_LOCKED, ENTRY_MARKED_UNLOCKED, ENTRY_MARKED_ACCEPTED, MAINTENANCE_MESSAGE, MAINTENANCE_CUSTOMER_CONTACT, MAINTENANCE_RECORD_INVITE_TRIGGER, MAINTENANCE_RECORD_INVITE_PROCESSED, MAINTENANCE_RECORD_REPORT, MAINTENANCE_RECORD_MARKED_PENDING, MAINTENANCE_RECORD_MARKED_ACCEPTED)

id
optional

Example : "string"

string

maintenanceCycleId
optional

Example : "string"

string

measurementIds
optional

Example : [ "string" ]

< string > array

measurementTopicIds
optional

Example : [ "string" ]

< string > array

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

noteId
optional

Example : "string"

string

originalProjectId
optional

Example : "string"

string

projectId
optional

Example : "string"

string

statusIdFrom
optional

Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, FIX, WAIT, FOLLOW, NO_ACTIONS)

statusIdTo
optional

Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, FIX, WAIT, FOLLOW, NO_ACTIONS)

statusUpdatedAt
optional

Example : "string"

string (date-time)

statusUpdatedBy
optional

Example : "string"

string

statusUpdatedByFullName
optional

Example : "string"

string

targetRecordId
optional

Example : "string"

string

type
optional

Example : "string"

string

fileRelations

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

fileId
optional

General file ID of the related file object. Field is required, because all file relations must have a file that relation belongs to. All other relations are optional and API user can use any of them - or none.
Example : "string"

string

flags
optional

Example : [ "string" ]

< enum (GENERIC, MEASUREMENT, MEASUREMENT_TEMPLATE, MEASUREMENT_TOPIC, MEASUREMENT_TOPIC_TEMPLATE, TEMPLATE_BUILDER, INDUCTIONS) > array

id
optional

Unique ID for file relation.
Example : "string"

string

measurementId
optional

Measurement ID of the related measurement object.
Example : "string"

string

measurementTemplateId
optional

Measurement ID of the related measurement template object.
Example : "string"

string

measurementTopicId
optional

Measurement ID of the related measurement topic object.
Example : "string"

string

measurementTopicTemplateId
optional

Measurement ID of the related measurement topic template object.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

notes

Name Description Schema

activityId
optional

ID of the related work activity object.
Example : "string"

string

assignedToUserId
optional

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.
Example : "string"

string

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

categoryTagRelations
optional

Example : [ "object" ]

company
optional

Related contractor company object.
Example : "object"

companyId
optional

ID of the related contractor company object.
Example : "string"

string

containerId
optional

ID of the related measurement, task list, inspection or other note container object.
Example : "string"

string

containerName
optional

Defines the container (measurement, inspection, memo, etc.) name that the note is related to.
Example : "string"

string

containerOptionId
optional

ID of the related measurement or other container topic.
Example : "string"

string

containerOptionName
optional

Defines the container (measurement, inspection, memo, etc.) topic (option) name that the note is related to.
Example : "string"

string

correlationId
optional

Correlation ID for note.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

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.
Example : "Brief description of the note"

string

descriptionExtended
optional

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.
Example : "Longer description of the note"

string

displayId
optional

Display ID number for the note. Display ID number is not unique, but is a project wide running number within one noteType category. All notes have unique ID (see field id), but it is not practical to use
Example : "string"

string

displayName
optional

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.
Example : "string"

string

eventIds
optional

Example : [ "string" ]

< string > array

events
optional

Example : [ "object" ]

< events > array

geoOverlays
optional

Example : [ "object" ]

< geoOverlays > array

id
optional

Note ID in Congrid system. Identifier is unique.
Example : "string"

string

impacts
optional

Example : [ "object" ]

< impacts > array

inspectionId
optional

ID of the related inspection object.
Example : "string"

string

inspectionTopicId
optional

ID of the related inspection topic object.
Example : "string"

string

isAssignedToCurrentUser
optional

Defines if the note is assigned to current user.

Flag is used to point out notes that belong to the current user. The "assigned to" information is defined by user, project and note properties.
Example : "string"

string

isNotificationRequiredForCurrentUser
optional

Defines if requesting user should be notified about the note.

Flag is used to select some notes that are interesting for the user. Value for the boolean flag is defined in API based on user, project and note information.
Example : "string"

string

listId
optional

ID of the related punch list object.
Example : "string"

string

locationId
optional

Additional category for note location. Notes are linked to different project area hierarchy objects. In addition to area hierarchy, it’s often required to give more detailed comment for the note location.
Example : "string"

enum (CEILING, FLOOR, WALL, FIXTURE, FRAME, NONE)

marker
optional

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 note.marker relation should not be used for any new development.

TO BE DEPRECATED
Example : "object"

markerId
optional

ID of the related floor plan marker.
Example : "string"

string

measurementId
optional

ID of the related measurement object.
Example : "string"

string

measurementTopicId
optional

ID of the related measurement topic object.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

multiplier
optional

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 multiplier: 2. That would double note effect and would be same as having two notes with multiplier: 1.

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 multiplier: 10. Difference between having one note with multiplier and ten notes without multiplier is that in the latter case you would need to handle acceptance chain for ten notes, but in the first you would accept only one note.
Example : 0

integer

noteClassId
optional

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 noteType defines where note belongs to in Congrid system, noteClass defines what kind of note this is.

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. noteClass is the category for that.

Within one noteClass category there are always notes from different Congrid application modules. You can have POSITIVE notes e.g. from quality and safety and they all have similar noteClass: POSITIVE value but have different noteType.

Together with noteClass and noteType notes can be divided into groups based one what part of the system they belong to and what is the purpose of the note.
Example : "string"

enum (TASK, DOCUMENTATION, POSITIVE, NOTIFICATION)

noteTypeId
optional

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 noteType is the category for that.

Within one noteType category the are be different kind of notes. Each noteType category contains tasks, positive notes, photos and so on. Together with noteClass and noteType notes can be divided into groups based one what part of the system they belong to and what is the purpose of the note.

By default all notes are PUNCH notes. They are notes that are created in the punch lists application.
Example : "string"

enum (PUNCH, TR, MVR, SAFETY_WALK, MEMO, QUALITY, ASPHALT, QUALITY_INSPECTION, SAFETY, PHOTO, MAINTENANCE, INDUCTION, NOTIFICATION)

notifications
optional

Example : [ "object" ]

< notifications > array

objectType
optional

Re-definition of 'noteType' property.
Example : "string"

enum (PUNCH, TR, MVR, SAFETY_WALK, MEMO, QUALITY, ASPHALT, QUALITY_INSPECTION, SAFETY, PHOTO, MAINTENANCE, INDUCTION, NOTIFICATION)

observedAt
optional

Timestamp for note observation time.
Example : "string"

string (date-time)

originalProjectId
optional

ID of the related project, which is also the owner of the note.
Example : "string"

string

photoIds
optional

Example : [ "string" ]

< string > array

photos
optional

Example : [ "object" ]

< photos > array

priorityValue
optional

Priority value is a number that defines note priority.
Example : 0

integer

requiredAction
optional

Required actions is a text field used for user given description for different actions required to finish with the note.
Example : "string"

string

requiredActionDueAt
optional

Required action due at is a timestamp value used to set time limit or deadline for when the required actions should be finished.
Example : "string"

string (date-time)

requiredActionLevelId
optional

Required action level is predefined category for required actions. It is used in addition with textual required action definition to set what needs to be done with note.

Required action level options are predefined and therefore are useful as categories in analytics.
Example : "string"

enum (FIX, WAIT, FOLLOW, NO_ACTIONS)

statusEvents
optional

Example : [ "object" ]

< statusEvents > array

statusId
optional

Status of the note.
Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, FIX, WAIT, FOLLOW, NO_ACTIONS)

statusUpdatedAt
optional

Timestamp for the latest status update time.
Example : "string"

string (date-time)

target
optional

Related area hierarchy tree object (target).
Example : "object"

targetId
optional

ID of the related area hierarchy tree object (target).
Example : "string"

string

targetRecordId
optional

ID of the related target record object object.
Example : "string"

string

topicId
optional

ID of the related measurement or other container topic.
Example : "string"

string

topicName
optional

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.
Example : "string"

string

validFromAt
optional

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".
Example : "string"

string (date-time)

validToAt
optional

Validity window end timestamp. Validity window defines the time that the notification is valid.
Example : "string"

string (date-time)

visibleFromAt
optional

Visibility window start timestamp. Visibility window defines the time that the notification is showed for user.
Example : "string"

string (date-time)

visibleToAt
optional

Visibility window end timestamp. Visibility window defines the time that the notification is showed for user.
Example : "string"

string (date-time)

workActivityId
optional

ID of the related work activity object.
Example : "string"

string

workSectionId
optional

ID of the related work section object.
Example : "string"

string

categoryTagRelations

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

correlationId
optional

Correlation ID for note.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

dataSourceTagId
optional

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.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.

API allows deleting tag relations by setting the 'deletedAt' timestamp.
Example : "string"

string

generalFileId
optional

ID of the related general file object.
Example : "string"

string

id
optional

Unique ID for tag relation.
Example : "string"

string

measurementId
optional

ID of the related measurement object.
Example : "string"

string

measurementOptionId
optional

ID of the related measurement option object.
Example : "string"

string

measurementOptionTemplateId
optional

ID of the related measurement option template object.
Example : "string"

string

measurementTemplateId
optional

ID of the related measurement template object.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

noteId
optional

ID of the related general file object.
Example : "string"

string

tagId
optional

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.
Example : "string"

string

workSectionDocumentId
optional

ID of the related work section document object.
Example : "string"

string

company

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

color
optional

Company color for reports.
Example : "string"

string

companyTypeId
optional

Company type.
Example : "string"

enum (CLIENT, SUPERVISOR, DESIGNER, SUPPLIER, CONTRACTOR, OTHER, CUSTOM)

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

id
optional

Company ID.
Example : "string"

string

isRalaCertified
optional

Company RALA Certification status.
Example : true

boolean

isRalaQualified
optional

Company RALA Qualification status.
Example : true

boolean

logoUrl
optional

Signed URL for the logo. Returns Congrid logo if logo is not found.
Example : "string"

string

logoUrlOriginal
optional

Signed URL for the logo. Returns null if logo is not found.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Company name.
Example : "string"

string

projectIds
optional

Example : [ "string" ]

< string > array

specifier
optional

Description for the company.
Example : "string"

string

vatCode
optional

Company VAT code.
Example : "string"

string

verifiedVatCodeRequired
optional

Boolean that defines if projects of the company require verified / valid VAT code for all subcontractors of the projects.
Example : true

boolean

events

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

comment
optional

Example : "string"

string

concreteRecordId
optional

Example : "string"

string

correlationId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

diaryId
optional

Example : "string"

string

eventTypeId
optional

Example : "string"

enum (EMAIL_SENT, CREATED_REPORT, SEND_REPORT, CHANGED_STATUS, CHANGED_RESPONSIBLE, CHANGED_DESCRIPTION, CHANGED_SPECIAL_REMARK, CHANGED_REQUIRED_ACTION, CHANGED_REQUIRED_ACTION_LEVEL, CHANGED_TARGET, CHANGED_TARGET_DESCRIPTION, CHANGED_WORK_SECTION, CHANGED_WORK_ACTIVITY, CHANGED_CATEGORY, CHANGED_NAME, CHANGED_PARTICIPANTS, CHANGED_ACCEPTORS, TYPE_CHANGED_ASSIGNED_TO_USER, CHANGED_OBSERVED_AT, TYPE_CHANGED_NOTE_DYNAMIC_DATA, MARKED_PENDING, MARKED_RECEIVED, MARKED_WIP, MARKED_COMPLETE, MARKED_VERIFIED, MARKED_INCOMPLETE, MARKED_ACCEPTED, MARKED_REJECTED, MARKED_NOT_APPLICABLE, MARKED_CANNOT_MEASURE, DELETED, UNDELETED, ENTRY_CREATED, ENTRY_MARKED_LOCKED, ENTRY_MARKED_UNLOCKED, ENTRY_MARKED_ACCEPTED, MAINTENANCE_MESSAGE, MAINTENANCE_CUSTOMER_CONTACT, MAINTENANCE_RECORD_INVITE_TRIGGER, MAINTENANCE_RECORD_INVITE_PROCESSED, MAINTENANCE_RECORD_REPORT, MAINTENANCE_RECORD_MARKED_PENDING, MAINTENANCE_RECORD_MARKED_ACCEPTED)

id
optional

Example : "string"

string

maintenanceCycleId
optional

Example : "string"

string

measurementIds
optional

Example : [ "string" ]

< string > array

measurementTopicIds
optional

Example : [ "string" ]

< string > array

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

noteId
optional

Example : "string"

string

originalProjectId
optional

Example : "string"

string

projectId
optional

Example : "string"

string

statusIdFrom
optional

Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, FIX, WAIT, FOLLOW, NO_ACTIONS)

statusIdTo
optional

Example : "string"

enum (PENDING, RECEIVED, WIP, INCOMPLETE, COMPLETED, VERIFIED, ACCEPTED, REJECTED, FIX, WAIT, FOLLOW, NO_ACTIONS)

statusUpdatedAt
optional

Example : "string"

string (date-time)

statusUpdatedBy
optional

Example : "string"

string

statusUpdatedByFullName
optional

Example : "string"

string

targetRecordId
optional

Example : "string"

string

type
optional

Example : "string"

string

geoOverlays

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

correlationId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

data
optional

Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

floorPlanId
optional

Example : "string"

string

floorPlanSlug
optional

Example : "string"

string

id
optional

Example : "string"

string

mapLayerDefinitions
optional

Example : "string"

string

markerSchemaVersion
optional

Example : 0

integer

measurementId
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

noteId
optional

Example : "string"

string

photoId
optional

Example : "string"

string

slug
optional

Example : "string"

string

typeId
optional

Example : "string"

enum (FLOOR_PLAN_POINT_MARKER, FLOOR_PLAN_OVERLAY, PHOTO_OVERLAY, GEO_OVERLAY, SIGNATURE_OVERLAY)

x
optional

Example : 0

integer

y
optional

Example : 0

integer

zoomLevel
optional

Example : 0.0

number

impacts

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

correlationId
optional

Correlation ID for an impact.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

description
optional

Description about details of impact, explanation of money and working hours etc.
Example : "string"

string

durationMs
optional

Length of delay impact in milliseconds. Value can be "null" indicating non-applied value. For example: 86400000 = 1 day.
Example : 86400000

integer

id
optional

Impact ID in Congrid system. Identifier is unique.
Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

moneyCurrencyId
optional

Currency unit of money impact. If not given, uses project’s default currency unit.
Example : "EUR"

string

moneyCurrencyValue
optional

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.
Example : 1235000

integer

noteId
optional

ID of the related Note.
Example : "string"

string

marker

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

correlationId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

data
optional

Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

floorPlanId
optional

Example : "string"

string

floorPlanSlug
optional

Example : "string"

string

id
optional

Example : "string"

string

mapLayerDefinitions
optional

Example : "string"

string

markerSchemaVersion
optional

Example : 0

integer

measurementId
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

noteId
optional

Example : "string"

string

photoId
optional

Example : "string"

string

slug
optional

Example : "string"

string

typeId
optional

Example : "string"

enum (FLOOR_PLAN_POINT_MARKER, FLOOR_PLAN_OVERLAY, PHOTO_OVERLAY, GEO_OVERLAY, SIGNATURE_OVERLAY)

x
optional

Example : 0

integer

y
optional

Example : 0

integer

zoomLevel
optional

Example : 0.0

number

notifications

Name Description Schema

attachments
optional

Example : [ "object" ]

< attachments > array

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

bccAddresses
optional

Example : "string"

string

bounces
optional

Example : [ "object" ]

< bounces > array

ccAddresses
optional

Example : "string"

string

complaints
optional

Example : [ "object" ]

< complaints > array

correlationId
optional

Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

deliveries
optional

Example : [ "object" ]

< deliveries > array

eventId
optional

Example : "string"

string

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

noteId
optional

Example : "string"

string

projectId
optional

Example : "string"

string

reports
optional

Example : [ "object" ]

< reports > array

sentAt
optional

Example : "string"

string (date-time)

statusId
optional

Example : "string"

enum (QUEUED, WAITING_CONTENT, WAITING_REPORT, WAITING_SEND, SENT, FAILED)

toAddresses
optional

Example : "string"

string

toEmailAddresses
optional

Example : "string"

string

attachments

Name Description Schema

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

downloadUrl
optional

Example : "string"

string

filename
optional

Example : "string"

string

id
optional

Example : "string"

string

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

name
optional

Example : "string"

string

bounces

Name Description Schema

address
optional

Example : "string"

string

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

diagnosticCode
optional

Example : "string"

string

id
optional

Example : "string"

string

mailFrom
optional

Example : "string"

string

mailId
optional

Example : "string"

string

mailTimestamp
optional

Example : "string"

string (date-time)

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

modifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

modifiedByDisplayName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByFullName
optional

Object’s last modifier’s full name.
Example : "string"

string

modifiedByUserId
optional

Object’s last modifier’s id.
Example : "string"

string

snsMessageId
optional

Example : "string"

string

snsTopic
optional

Example : "string"

string

status
optional

Example : "string"

string

subType
optional

Example : "string"

string

type
optional

Example : "string"

string

complaints

Name Description Schema

address
optional

Example : "string"

string

backendDeletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string (date-time)

backendModifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

backendModifiedBy
optional

Object’s last modifier’s id.
Example : "string"

string

createdAt
optional

Object’s creating date.
Example : "string"

string (date-time)

createdBy
optional

Object creator’s id.
Example : "string"

string

createdByDisplayName
optional

Object creator’s full name.
Example : "string"

string

createdByFullName
optional

Object creator’s full name.
Example : "string"

string

createdByUserId
optional

Object creator’s id.
Example : "string"

string

deletedAt
optional

Object’s deletion date. If null, object is not deleted but active and available.
Example : "string"

string

diagnosticCode
optional

Example : "string"

string

id
optional

Example : "string"

string

mailFrom
optional

Example : "string"

string

mailId
optional

Example : "string"

string

mailTimestamp
optional

Example : "string"

string (date-time)

modifiedAt
optional

Object’s last modification date.
Example : "string"

string (date-time)

mo