Skip to main content
GET
/
commissions
/
v1
/
{commissionId}
{
  "data": {
    "buildingWorkId": 123,
    "commissionDate": "2024-12-01T12:34:56.000Z",
    "commissionType": 123,
    "createdAt": "2024-12-01T12:34:56.000Z",
    "createdById": 123,
    "decision": 123,
    "id": 123,
    "signatureUrl": "",
    "signedBy": 123,
    "signedDate": "2024-12-01T12:34:56.000Z",
    "siteId": 123,
    "comment": "Urgent repairs needed.",
    "status": 123,
    "updatedAt": "2024-12-01T12:34:56.000Z",
    "visitType": 123
  },
  "updatableFields": {
    "decision": true,
    "commissionDate": "PAST",
    "comment": "Updated comment"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json

Query Parameters

includeEditInfo
boolean
required

Indicates whether to include additional details on modifications to the anomaly entries.

Example:

true

includeSite
boolean
required

Specifies if the site information associated with the log should be included.

Example:

true

includeReport
boolean
required

Specifies whether the report information associated with the anomaly should be included or not.

Example:

true

includeReportAnomalies
boolean
required

Specifies whether to include anomalies related to the report.

Example:

true

includeBuildingWork
boolean
required

Indicates whether to include building work details in the response.

Example:

true

includeCreatedBy
boolean
required

Specifies whether to include the creator’s information.

Example:

true

includeSignature
boolean
required

Specifies whether to include the total count of entries in the response, useful for determining the total available pages.

Example:

true

updatableFields
boolean
required

Indicates whether to include the updatable fields in the response.

Example:

true

Response

200 - application/json

Successfully retrieved the commission details.

data
object
required
updatableFields
object
required