Skip to main content
GET
/
specifications
/
v1
/
rs
/
{specificationId}
Get specification
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/specifications/v1/rs/{specificationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Annual Safety Check",
    "sourceType": 2,
    "technicalInstallationId": 1,
    "archivedAt": "2024-12-10T10:00:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "items": [
      {
        "id": 1,
        "name": "Annual Safety Check"
      }
    ],
    "technicalInstallation": {
      "id": 1,
      "name": "establishment_informations.installation_ascenseurs"
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    },
    "updatableFields": {
      "name": 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"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Path Parameters

​
specificationId
integer
required

Unique identifier of the specificationDefinition.

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

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "technical-installation": Get information about technical installations linked to the specification definition

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

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

Available options:
technical-installation,
actions-info,
updatable-fields

Response

200 - application/json

get of a specification

​
data
object
required