Skip to main content
GET
/
sites-rules
/
v1
/
rs
/
sites
/
{siteId}
/
rules
/
{ruleId}
Get site rule for the site
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/sites-rules/v1/rs/sites/{siteId}/rules/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "ruleId": 99,
    "siteId": 42,
    "dueAt": "2024-12-01T12:34:56.000Z",
    "archivedAt": "2024-12-01T12:34:56.000Z",
    "updatedAt": "2024-12-01T12:34:56.000Z",
    "createdAt": "2024-12-01T12:34:56.000Z",
    "actions": {
      "canBeDeleted": true
    },
    "updatableFields": {
      "dueAt": true
    },
    "rule": {
      "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",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "technicalInstallations": [
        {
          "id": 1,
          "name": "establishment_informations.installation_ascenseurs"
        }
      ],
      "scopes": [
        {
          "id": 1,
          "specificationValues": [
            {
              "value": "Annual Safety Check",
              "definition": "Annual Safety Check"
            }
          ]
        }
      ]
    },
    "site": {
      "id": 1,
      "name": "Main site",
      "types": [
        1,
        1
      ],
      "isEstablishment": true,
      "establishmentId": 10,
      "serialNumber": "123456",
      "archivedAt": "2024-12-10T10:00:00.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "establishment": {
        "id": 1,
        "address": "123 Main Street",
        "zipCode": 75001,
        "city": "Paris",
        "country": "France",
        "classifications": [
          0,
          2
        ],
        "isGroupment": 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

siteId
integer
required

Unique identifier of the site.

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

1

ruleId
integer
required

Unique identifier of the rule.

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

1

Query Parameters

extend
enum<string>[]

Extend options:

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

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

  • "rule": Get the rules with specific fields

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

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

  • "site": Get the site information

  • "site-establishment": Get the establishment information of the site

Available options:
actions-info,
updatable-fields,
rule,
rule-technical-installations,
rule-scopes,
site,
site-establishment

Response

200 - application/json

List site rule

data
object
required