Skip to main content
GET
/
buildingworks
/
v2
/
rs
List Building Work Details
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/buildingworks/v2/rs \
  --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",
      "establishmentCell": {
        "establishment": {
          "id": 1,
          "establishmentSiteId": 5,
          "name": "Main site",
          "count": 123
        },
        "cell": {
          "id": 1,
          "name": "Main site",
          "count": 123
        }
      },
      "createdBy": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe"
      },
      "commission": {
        "id": 1,
        "status": 1,
        "decision": 1,
        "commissionDate": "2024-12-01T12:34:56.000Z"
      },
      "sites": [
        {
          "id": 1,
          "name": "Main site",
          "isEstablishment": true,
          "establishmentId": 10
        }
      ],
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      }
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

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"

Query Parameters

​
extend
enum<string>[]

Extend options:

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

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

  • "commission": Get information about the commission

  • "sites": Get every sites linked

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

Available options:
establishment-cell,
created-by,
commission,
sites,
actions-info
​
whereSiteIds
integer[]

Filter by site IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereDescription
string

Filter by description

Example:

"string"

​
whereAuthorizationNumber
string

Filter by authorization number

Example:

"string"

​
whereStatus
integer[]

Filter by status

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereCommissionIds
integer[]

Filter by commission IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereStartAt
string

Filter by start date

Example:

"2021-01-01T00:00:00.000Z"

​
whereEndAt
string

Filter by end date

Example:

"2021-01-01T00:00:00.000Z"

​
whereContractorName
string

Filter by contractor name

Example:

"string"

​
whereSupervisingTechnicianName
string

Filter by supervising technician name

Example:

"string"

​
whereArchitectName
string

Filter by architect name

Example:

"string"

​
whereReceptionDate
string

Filter by reception date

Example:

"2021-01-01T00:00:00.000Z"

​
whereSitesName
string

Filter by associated site names

Example:

"string"

​
whereCreatedByUserId
integer[]

Filter by creator user ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereCreatedByUserName
string

Filter by creator user name

Example:

"string"

​
isArchived
boolean

Filter by archived status

Example:

true

​
isDeleted
boolean

Filter by deleted status

Example:

true

​
whereArchivedAt
string

Filter by archived date

Example:

"2021-01-01T00:00:00.000Z"

​
whereUpdatedAt
string

Filter by updated date

Example:

"2021-01-01T00:00:00.000Z"

​
whereCreatedAt
string

Filter by creation date

Example:

"2021-01-01T00:00:00.000Z"

​
whereText
string

Full text search on description and authorization number

Example:

"string"

​
whereOpinion
integer[]

Filter by opinion

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

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

1

​
pageSize
integer
default:50

Page size.

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

50

​
findId
integer

Get the page where the item with this id is located.

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

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

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

10

Response

200 - application/json

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

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.