Skip to main content
GET
/
buildingworks
/
v2
/
rs
/
{buildingWorkId}
Get Building Work Details
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/buildingworks/v2/rs/{buildingWorkId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "description": "Building work description",
    "authorizationNumber": "Authorization number",
    "status": 1,
    "receptionDate": "2024-11-20T10:30:00.000Z",
    "contractorName": "Contractor name",
    "supervisingTechnicianName": "Supervising technician name",
    "architectName": "Architect name",
    "createdByUserId": 1,
    "startAt": "2024-11-20T10:30:00.000Z",
    "endAt": "2024-11-20T10:30:00.000Z",
    "archivedAt": "2024-11-20T10:30:00.000Z",
    "deletedAt": "2024-11-20T10:30:00.000Z",
    "updatedAt": "2024-12-05T14:56:23.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "createdBy": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe"
    },
    "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
      }
    ],
    "commission": {
      "id": 1,
      "status": 1,
      "decision": 1,
      "commissionDate": "2024-12-01T12:34:56.000Z",
      "establishmentCell": {
        "establishment": {
          "id": 1,
          "establishmentSiteId": 5,
          "name": "Main site",
          "count": 123
        },
        "cell": {
          "id": 1,
          "name": "Main site",
          "count": 123
        }
      }
    },
    "cerfa": {
      "id": 1,
      "name": "Document Name",
      "presignedUrl": "https://example.com/presigned-url"
    },
    "securityNotice": {
      "id": 1,
      "name": "Document Name",
      "presignedUrl": "https://example.com/presigned-url"
    },
    "accessibilityNotice": {
      "id": 1,
      "name": "Document Name",
      "presignedUrl": "https://example.com/presigned-url"
    },
    "documents": {
      "hasCerfa": true,
      "hasSecurityNotice": true,
      "hasAccessibilityNotice": true,
      "hasPlans": true
    },
    "updatableFields": {
      "description": true,
      "authorizationNumber": true,
      "status": true,
      "workNature": true,
      "contractorName": true,
      "supervisingTechnicianName": true,
      "architectName": true,
      "startAt": true,
      "endAt": true,
      "siteIds": true
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": 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

buildingWorkId
integer
required

Unique identifier of the building work.

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

1

Query Parameters

extend
enum<string>[]

Extend options:

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

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

  • "sites": Get every sites linked

  • "commission": Get information about the commission

  • "documents": Get information about the documents

  • "documents-info": Get information about the documents

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

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

Available options:
created-by,
establishment-cell,
sites,
commission,
documents,
documents-info,
updatable-fields,
actions-info

Response

200 - application/json

A list of building work details associated with the given establishment.

data
object
required