Skip to main content
GET
/
commissions
/
v2
/
rs
/
{commissionId}
Get single commission by ID
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/commissions/v2/rs/{commissionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "visitType": 1,
    "status": 1,
    "decision": 1,
    "commissionDate": "2024-12-01T12:34:56.000Z",
    "buildingWorkId": 1,
    "comment": "Urgent repairs needed.",
    "createdByUserId": 1,
    "archivedAt": "2024-12-31T23:59:59.000Z",
    "deletedAt": "2024-11-30T10:15:30.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "createdBy": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe"
    },
    "report": {
      "id": 1,
      "name": "Document Name",
      "status": 1,
      "presignedUrl": "https://bucket.s3.amazonaws.com/1"
    },
    "labels": [
      {
        "id": 1,
        "name": "Urgent",
        "color": "#FF5733"
      }
    ],
    "signedBy": "Signatory",
    "signedDate": "2024-12-01T12:34:56.000Z",
    "presignedUrl": "https://example.com/presigned-url",
    "buildingWorks": [
      {
        "id": 1,
        "description": "Building work description",
        "authorizationNumber": "Authorization number",
        "status": 1,
        "receptionDate": "2024-11-20T10:30:00.000Z",
        "archivedAt": "2024-11-20T10:30:00.000Z",
        "establishmentCell": {
          "establishment": {
            "id": 1,
            "establishmentSiteId": 5,
            "name": "Main site",
            "count": 123
          },
          "cell": {
            "id": 1,
            "name": "Main site",
            "count": 123
          }
        }
      }
    ],
    "sites": [
      {
        "id": 1,
        "name": "Main site",
        "isEstablishment": true,
        "establishmentId": 10
      }
    ],
    "establishmentCell": {
      "establishment": {
        "id": 1,
        "establishmentSiteId": 5,
        "name": "Main site",
        "count": 123
      },
      "cell": {
        "id": 1,
        "name": "Main site",
        "count": 123
      }
    },
    "updatableFields": {
      "visitType": true,
      "decision": true,
      "commissionDate": true,
      "comment": true,
      "labelIds": true,
      "siteIds": true,
      "buildingworkIds": true,
      "siteId": true
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true,
      "canBeSigned": true
    }
  }
}

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"

Path Parameters

​
commissionId
integer
required

Unique identifier of the commission.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "created-by": Get information about the person that created the commission

  • "report": Get information about the report

  • "labels": Get the labels linked to the commission

  • "signature": Get the signature information for the commission

  • "building-works": Get the building works linked to the commission

  • "sites": Get every sites linked

  • "establishment-cell": Get information about the establishment cell

  • "updatable-fields": Get information about the field that can be updated

  • "actions-info": Give information about actions that can be done on the commission

Available options:
created-by,
report,
labels,
signature,
building-works,
sites,
establishment-cell,
updatable-fields,
actions-info

Response

200 - application/json

Commission retrieved successfully

​
data
object
required