Skip to main content
POST
/
specifications
/
v2
/
bo
/
library
Create specification
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/specifications/v2/bo/library \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "name": "Annual Safety Check",
  "technicalInstallationId": 1,
  "color": "#FF5733",
  "items": [
    "Annual Safety Check"
  ]
}
'
{
  "specification": {
    "id": 1,
    "name": "Annual Safety Check",
    "color": "#FF5733",
    "technicalInstallationId": 1,
    "archivedAt": "2024-12-10T10:00:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to create specification

​
name
string
required

Name of the rule.

Maximum string length: 250
Example:

"Annual Safety Check"

​
technicalInstallationId
integer
required

Identifier of the associated technical installation.

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

1

​
color
string
required

Color associated with the specificationDefinition, in hex format.

Maximum string length: 20
Example:

"#FF5733"

​
items
string[]

Name of the rule.

Required string length: 1 - 200

Response

201 - application/json

The specification has been created

​
specification
object
required