Skip to main content
GET
/
technical-installations
/
v2
/
rs
List technical installations for the organization / or siteIds
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/technical-installations/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "name": "establishment_informations.installation_ascenseurs",
      "sourceType": 1,
      "updatedAt": "2024-12-09T14:23:00.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "archivedAt": "2024-05-20T10:15:00.000Z",
      "disable": true,
      "image": {
        "id": 1,
        "presignedUrl": "https://example.com/presigned-url"
      },
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true,
        "canBeAdded": true,
        "canBeRemoved": true
      },
      "nameFr": "Ascenseurs",
      "nameEn": "Elevators",
      "nameDe": "Aufzüge",
      "stats": {
        "nbPastDue": 5,
        "nbAtRisk": 2,
        "nbFutureDue": 3,
        "nbAnomalyResolved": 4,
        "nbAnomalyUnresolved": 1,
        "nbAnomalyPending": 2
      },
      "nbRules": 5,
      "nbSpecifications": 10,
      "rules": [
        {
          "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",
          "scopes": [
            {
              "id": 1,
              "specificationValues": [
                {
                  "id": 1,
                  "value": "Annual Safety Check",
                  "definition": "Annual Safety Check"
                }
              ],
              "name": "Example Name"
            }
          ],
          "actions": {
            "canBeUpdated": true,
            "canBeDeleted": true,
            "canBeRestored": true,
            "canBeAdded": true,
            "canBeRemoved": true,
            "hasWarningOnDelete": true
          },
          "stats": {
            "nbPastDue": 5,
            "nbFutureDue": 3,
            "nbAtRisk": 2
          },
          "siteRuleActions": {
            "canBeDeleted": true
          }
        }
      ],
      "siteTechnicalInstallationActions": {
        "canBeDeleted": 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:

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

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

  • "names-translation": Get the technicalInstallations with specific fields

  • "stats": Get the statistics of the 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)

  • "nb-rules": Number of rules associated with the technical installation

  • "nb-specifications": Number of specifications associated with the technical installation

  • "rules": Get the rules linked to the technical installations

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

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

  • "rule-stats": Get the statistics of the 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

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

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

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

Available options:
image,
actions-info,
names-translation,
stats,
nb-rules,
nb-specifications,
rules,
rule-scopes,
rule-actions-info,
rule-stats,
rule-scopes-partial,
site-it-actions-info,
site-rule-actions-info
​
whereName
string

Filter by name

Example:

"string"

​
whereCreatedAt
string

Filter by createdAt date

Example:

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

​
whereSourceType
integer[]

Filter by source type

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

Filter by library

Example:

true

​
whereOrgAndLibrary
boolean

Filter by the rules of the organization and all the one in the library

Example:

true

​
whereIsArchived
boolean

Filter by archived status

Example:

true

​
whereArchivedAt
string

Filter by archivedAt date

Example:

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

​
whereNotInOrganization
boolean

Filter by organization not in the list

Example:

true

​
whereNotInSite
integer

Filter by site not in the list

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

1

​
whereSiteIds
integer[]

Filter by siteIds

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

Filter by not having specific site IDs

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

Filter by not having other IT installations

Example:

true

​
whereText
string

Filter by global text in report

Example:

"string"

​
whereReportId
integer

Filter by reportId

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

1

​
whereEquipmentId
integer

Filter by equipment ID

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

1

​
whereSiteIdsAreCompatible
integer[]

Filter by compatibility with target rules

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

Filter by incompatibility with target rules

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

Filter by technical installation ID

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

1

​
whereTechnicalInstallationIds
integer[]

Filter by technical installation IDs

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

Filter if the IT has connections with at least one sites

Example:

true

​
orderBy
object[]
​
targetSiteId
integer

Target Site identifier. If provided, the actions-info for the technical installation and rule will be the one for this site.

Required range: -9007199254740991 <= x <= 9007199254740991
​
whereRuleLibrary
boolean

Filter by rule library

Example:

true

​
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]
​
whereRuleLink
string

Filter by rule link

Example:

"string"

​
whereRuleRrule
string

Filter by rule recurrence rule

Example:

"string"

​
whereRuleWorkflowType
integer[]

Filter by workflow type

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

Filter by compliance 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]
​
whereRuleCreatedAt
string

Filter by createdAt date

Example:

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

​
whereRuleUpdatedAt
string

Filter by updatedAt date

Example:

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

​
whereRuleIsArchived
boolean

Filter by isArchived flag

Example:

true

​
whereRuleArchivedAt
string

Filter by archivedAt date

Example:

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

​
whereRuleTechnicalInstallationIds
integer[]

Filter by technical installation ids

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

Filter by scope ids

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

Filter by specification value ids

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

Filter by technical installation name

Example:

"string"

​
ruleOrderBy
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 technical installations

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.