Skip to main content
GET
/
sites-technical-installations
/
v1
/
rs
List site technical installations for the site
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/sites-technical-installations/v1/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "siteId": 42,
      "technicalInstallationId": 99,
      "archivedAt": "2024-05-20T10:15:00.000Z",
      "updatedAt": "2024-12-09T14:23:00.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "actions": {
        "canBeDeleted": true
      },
      "stats": {
        "nbPastDue": 5,
        "nbAtRisk": 2,
        "nbFutureDue": 3,
        "nbAnomalyResolved": 4,
        "nbAnomalyUnresolved": 1,
        "nbAnomalyPending": 2
      },
      "siteRules": [
        {
          "id": 1,
          "ruleId": 99,
          "siteId": 42,
          "status": 2,
          "rule": {
            "id": 1,
            "name": "Annual Safety Check",
            "description": "This rule requires an annual safety check for all installations.",
            "type": 1,
            "sourceType": 1,
            "rrule": "FREQ=YEARLY;BYMONTH=12;BYMONTHDAY=1",
            "workflowType": 1,
            "archivedAt": "2024-12-10T10:00:00.000Z",
            "createdAt": "2024-01-15T08:45:00.000Z",
            "scopes": [
              {
                "id": 1,
                "name": "Example Name",
                "specificationValues": [
                  {
                    "id": 1,
                    "value": "Annual Safety Check",
                    "definition": "Annual Safety Check"
                  }
                ]
              }
            ]
          },
          "dueAt": "2024-12-01T12:34:56.000Z",
          "contractId": 123,
          "routineId": 456,
          "archivedAt": "2024-12-01T12:34:56.000Z",
          "updatedAt": "2024-12-01T12:34:56.000Z",
          "createdAt": "2024-12-01T12:34:56.000Z",
          "upcomingInterventionStatus": 1,
          "nextIntervention": {
            "id": 1,
            "status": 2,
            "scheduledStart": "2024-12-01T12:34:56.000Z",
            "scheduledEnd": "2024-12-05T14:56:23.000Z"
          },
          "lastIntervention": {
            "id": 1,
            "status": 2,
            "scheduledStart": "2024-12-01T12:34:56.000Z",
            "scheduledEnd": "2024-12-05T14:56:23.000Z",
            "trainingProof": {
              "name": "document.pdf",
              "presignedUrl": "https://example.com/presigned-url"
            }
          },
          "routine": {
            "id": 1,
            "name": "Monthly Maintenance",
            "autoCreateEnabled": true,
            "assignedTo": {
              "type": 123,
              "id": 1,
              "name": "John Doe",
              "email": "test@mail.com"
            }
          },
          "contract": {
            "id": 1,
            "name": "Service Agreement",
            "archivedAt": "2024-12-01T12:34:56.000Z",
            "company": {
              "id": 1,
              "name": "Company Name"
            }
          },
          "actions": {
            "canBeDeleted": true
          },
          "report": {
            "id": 1,
            "name": "Document Name",
            "interventionId": 1,
            "anomalyStats": {
              "unreviewed": 5,
              "pending": 3,
              "resolved": 10
            },
            "count": 123
          }
        }
      ],
      "technicalInstallation": {
        "id": 1,
        "name": "establishment_informations.installation_ascenseurs",
        "sourceType": 1,
        "archivedAt": "2024-05-20T10:15:00.000Z",
        "createdAt": "2024-01-15T08:45:00.000Z",
        "image": {
          "id": 1,
          "presignedUrl": "https://example.com/presigned-url"
        }
      },
      "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
        }
      }
    }
  ],
  "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:

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

  • "stats": Get the statistics of the site IT:

    • the number of rule that:
      • have at least one rule in a site that is due in the past
      • have at least one rule in a site that is due is at risk (not working yet)
      • have at every rule in every site that is due in the future
    • the number of anomalies from intervention reports by status (resolved, pending, unresolved)
  • "site-rule": Get the site rules with specific fields

  • "site-rule-interventions": Get the upcoming intervention and / or the last intervention details for a site rule

  • "site-rule-routine": Get the routine details for a site rule

  • "site-rule-contract": Get the contract details for a site rule

  • "site-rule-actions-info": Get the status details for a site rule

  • "site-rule-report": Get the upcoming intervention and / or the last intervention details for a site rule

  • "site-rule-equipment-scopes": [deprecated] Get the equipment scopes details for a site rule

  • "technical-installation": Get information about the technical installation

  • "it-image": Get information about the image linked to the site technical installation

  • "site": Get the site information

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

  • "site-rule-scopes": [deprecated] Get the scopes details for a site rule

  • "site-rule-scopes-partial": [deprecated] Get the partial scopes details for a site rule

Available options:
actions-info,
stats,
site-rule,
site-rule-interventions,
site-rule-routine,
site-rule-contract,
site-rule-actions-info,
site-rule-report,
site-rule-equipment-scopes,
technical-installation,
it-image,
site,
site-establishment,
site-rule-scopes,
site-rule-scopes-partial
whereSiteIds
integer[]

Filter by site IDs

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

Filter by technical installation IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
whereIsArchived
boolean

Filter by archived status

Example:

true

whereArchivedAt
string

Filter by archivedAt date

Example:

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

whereCreatedAt
string

Filter by createdAt date

Example:

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

whereSiteName
string

Filter by site name

Example:

"string"

whereSiteSerialNumber
string

Filter by site serial number

Example:

"string"

whereSiteTypes
integer[]

Filter by site type

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
whereSiteIsEstablishment
boolean

Filter by establishment status

Example:

true

whereSourceType
integer[]

Filter by source type

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

Filter by IT name

Example:

"string"

whereComplianceType
integer[]

Filter by compliance type

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
whereNoOtherIT
boolean

Filter by not having other IT installations

Example:

true

orderBy
object[]
whereRuleSiteSiteIds
integer[]

Filter by site IDs

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

Filter by rule IDs

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

Filter by routine IDs

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

Filter by routine name

Example:

"string"

whereRuleSiteContractIds
integer[]

Filter by contract IDs

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

Filter by contract name

Example:

"string"

whereRuleSiteCreatedAt
string

Filter by createdAt date

Example:

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

whereRuleSiteIsArchived
boolean

Filter by archived status

Example:

true

whereRuleSiteArchivedAt
string

Filter by archivedAt date

Example:

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

whereRuleName
string

Filter by rule name

Example:

"string"

whereRuleDescription
string

Filter by rule description

Example:

"string"

whereRuleType
integer[]

Filter by rule type

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

Filter by rule source type

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

Filter by rule recurrence rule

Example:

"string"

whereRuleWorkflowType
integer[]

Filter by workflow type

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

Filter by establishment categories

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

Filter by establishment classifications

Example:
["string1", "string2", "string3"]
whereRuleEstablishmentTypes
string[]

Filter by establishment types

Example:
["string1", "string2", "string3"]
whereRuleCompanyTypes
integer[]

Filter by company types

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
siteRuleOrderBy
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

List site technical installations

data
object[]
required
totalCount
integer

Total count of items.

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

100

pagination
object

Pagination information.