Skip to main content
GET
/
rules
/
v1
/
rs
/
{ruleId}
Get rule for the given site Ids
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/rules/v1/rs/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Annual Safety Check",
    "description": "This rule requires an annual safety check for all installations.",
    "type": 1,
    "sourceType": 1,
    "links": [
      {
        "name": "Rule Details",
        "url": "https://example.com/rule-details"
      }
    ],
    "rrule": "FREQ=YEARLY;BYMONTH=12;BYMONTHDAY=1",
    "workflowType": 1,
    "complianceType": 1,
    "establishmentCategories": [
      1,
      2,
      3
    ],
    "establishmentClassifications": [
      "ERP",
      "IGH",
      "HAB"
    ],
    "establishmentTypes": [
      "J",
      "P",
      "EF"
    ],
    "companyTypes": [
      1
    ],
    "archivedAt": "2024-12-10T10:00:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "scopes": [
      {
        "id": 1,
        "specificationValues": [
          {
            "id": 1,
            "value": "Annual Safety Check",
            "definition": "Annual Safety Check"
          }
        ],
        "name": "Example Name"
      }
    ],
    "technicalInstallations": [
      {
        "id": 1,
        "name": "establishment_informations.installation_ascenseurs",
        "presignedUrl": "https://example.com/presigned-url"
      }
    ],
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true,
      "canBeAdded": true,
      "canBeRemoved": true
    },
    "updatableFields": {
      "name": true,
      "description": true,
      "links": true,
      "rrule": true,
      "workflowType": true,
      "complianceType": true,
      "establishmentCategories": true,
      "establishmentClassifications": true,
      "establishmentTypes": true,
      "companyTypes": [
        1
      ],
      "scopes": 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

ruleId
integer
required

Unique identifier of the rule.

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

1

Query Parameters

extend
enum<string>[]

Extend options:

  • "scopes": Get information about scopes linked to the rule

  • "scopes-partial": Get information about scopes linked to the rule

  • "technical-installations": Get information about technical installations linked to the rule

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

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

Available options:
scopes,
scopes-partial,
technical-installations,
actions-info,
updatable-fields

Response

200 - application/json

get of a rule

data
object
required