List equipments

curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/equipments/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'

{
  "data": [
    {
      "id": 1,
      "name": "Equipment Name",
      "description": "Equipment description",
      "manufacturer": "Equipment Manufacturer",
      "reference": "Equipment reference",
      "condition": 2,
      "availability": 1,
      "technicalInstallationId": 1,
      "siteId": 1,
      "installedById": 1,
      "installedAt": "2024-12-01T12:34:56.000Z",
      "constructedAt": "2024-12-01T12:34:56.000Z",
      "archivedAt": "2024-12-01T12:34:56.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "updatedAt": "2024-12-05T14:56:23.000Z",
      "technicalInstallation": {
        "id": 1,
        "name": "establishment_informations.installation_ascenseurs",
        "image": {
          "id": 1,
          "presignedUrl": "https://example.com/presigned-url"
        },
        "tradKey": "establishment_informations.installation_ascenseurs",
        "isDefault": false
      },
      "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"
      },
      "position": {
        "id": 1,
        "xPercent": 1,
        "yPercent": 1
      },
      "plan": {
        "id": 1,
        "name": "Main Plan"
      },
      "building": {
        "id": 1,
        "name": "Main Building"
      },
      "isPositioned": true,
      "containedIn": [
        {
          "id": 1,
          "name": "Plan Item 1"
        }
      ],
      "installedBy": {
        "id": 1,
        "name": "Company Name"
      },
      "specifications": [
        {
          "id": 1,
          "name": "Annual Safety Check",
          "archivedAt": "2024-12-10T10:00:00.000Z",
          "specificationDefinition": {
            "id": 1,
            "name": "Annual Safety Check",
            "sourceType": 2,
            "color": "#FF5733",
            "archivedAt": "2024-12-10T10:00:00.000Z"
          }
        }
      ],
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true,
        "canBePositioned": true
      },
      "anomalyStats": {
        "unreviewed": 5,
        "pending": 3,
        "resolved": 10
      },
      "establishmentCell": {
        "establishment": {
          "id": 1,
          "name": "Main site",
          "count": 123
        },
        "cell": {
          "id": 1,
          "name": "Main site",
          "count": 123
        }
      }
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

List equipments

Retrieves a paginated list of equipment entries with filtering, sorting, and optional extended data.

Permissions

Required Permission: READONLY
Required Access Types: [ADMIN, USER]

Business Logic

Supports pagination with optional total count calculation
Filters results based on user’s site permissions
Supports extended fields (action-infos, contained-in, installed-by, position, site, specifications, technical-installation)
Allows complex filtering through where parameters
Supports custom sorting through orderBy parameters
Applies multilingual transformations based on access token language

GET

equipments

List equipments

curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/equipments/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'

{
  "data": [
    {
      "id": 1,
      "name": "Equipment Name",
      "description": "Equipment description",
      "manufacturer": "Equipment Manufacturer",
      "reference": "Equipment reference",
      "condition": 2,
      "availability": 1,
      "technicalInstallationId": 1,
      "siteId": 1,
      "installedById": 1,
      "installedAt": "2024-12-01T12:34:56.000Z",
      "constructedAt": "2024-12-01T12:34:56.000Z",
      "archivedAt": "2024-12-01T12:34:56.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "updatedAt": "2024-12-05T14:56:23.000Z",
      "technicalInstallation": {
        "id": 1,
        "name": "establishment_informations.installation_ascenseurs",
        "image": {
          "id": 1,
          "presignedUrl": "https://example.com/presigned-url"
        },
        "tradKey": "establishment_informations.installation_ascenseurs",
        "isDefault": false
      },
      "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"
      },
      "position": {
        "id": 1,
        "xPercent": 1,
        "yPercent": 1
      },
      "plan": {
        "id": 1,
        "name": "Main Plan"
      },
      "building": {
        "id": 1,
        "name": "Main Building"
      },
      "isPositioned": true,
      "containedIn": [
        {
          "id": 1,
          "name": "Plan Item 1"
        }
      ],
      "installedBy": {
        "id": 1,
        "name": "Company Name"
      },
      "specifications": [
        {
          "id": 1,
          "name": "Annual Safety Check",
          "archivedAt": "2024-12-10T10:00:00.000Z",
          "specificationDefinition": {
            "id": 1,
            "name": "Annual Safety Check",
            "sourceType": 2,
            "color": "#FF5733",
            "archivedAt": "2024-12-10T10:00:00.000Z"
          }
        }
      ],
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true,
        "canBePositioned": true
      },
      "anomalyStats": {
        "unreviewed": 5,
        "pending": 3,
        "resolved": 10
      },
      "establishmentCell": {
        "establishment": {
          "id": 1,
          "name": "Main site",
          "count": 123
        },
        "cell": {
          "id": 1,
          "name": "Main site",
          "count": 123
        }
      }
    }
  ],
  "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"

Content-Type

enum<string>

required

Content type, must be "application/json".

Available options:

application/json

x-sites

string

List of site IDs.

Example:

"['1', '2']"

Query Parameters

extend

enum<string>[]

Extend options:

"technical-installation": Get information about technical installation linked to the equipment
"site": Get the site of the equipment
"position": Get the position of the equipment
"installed-by": Get the installed by of the equipment
"specifications": Get the specifications of the equipment
"actions-info": Give information about actions that can be done on the equipment
"anomaly-stats": Get information about anomalies in equipments
"establishment-cell": Get information about the establishment cell

Available options:

technical-installation,

site,

position,

installed-by,

specifications,

actions-info,

anomaly-stats,

establishment-cell

whereName

string

Filter by name

Example:

"string"

whereDescription

string

Filter by description

Example:

"string"

whereReference

string

Filter by reference

Example:

"string"

whereCondition

integer[]

Filter by condition

Example:

[1, 2, 3]

whereAvailability

integer[]

Filter by availability

Example:

[1, 2, 3]

whereTechnicalInstallationIds

integer[]

Filter by technical installation IDs

Example:

[1, 2, 3]

whereSiteIds

integer[]

Filter by site IDs

Example:

[1, 2, 3]

whereInstalledByIds

integer[]

Filter by installed by user IDs

Example:

[1, 2, 3]

whereSpecificationIds

integer[]

Filter by specification IDs

Example:

[1, 2, 3]

installedAt

string

Filter by installedAt

Example:

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

constructedAt

string

Filter by constructedAt

Example:

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

archivedAt

string

Filter by archivedAt

Example:

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

isArchived

boolean

Filter by isArchived

Example:

true

updatedAt

string

Filter by updatedAt

Example:

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

createdAt

string

Filter by createdAt

Example:

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

whereCanBePositioned

boolean

Filter anomalies that can be positioned (have a location in metadata)

Example:

true

whereText

string

Filter by global text in equipment

Example:

"string"

whereCanBePositionedInPlan

integer

Filter equipments that can be positioned in a plan

Example:

1

whereReportId

integer

Filter by report ID

Example:

1

whereRuleIds

integer[]

Filter by rule IDs

Example:

[1, 2, 3]

orderBy

object[]

Show child attributes

includeCount

boolean

default:false

Include total count in response.

Example:

true

page

integer

default:1

Page number.

Example:

1

pageSize

integer

default:50

Page size.

Example:

50

findId

integer

Get the page where the item with this id is located.

Example:

1

subPageSize

integer

default:10

Sub page size for grouping items.

Example:

10

Response

200 - application/json

List of equipments

data

object[]

required

Show child attributes

totalCount

integer

Total count of items.

Example:

100

pagination

object

Pagination information.

Show child attributes

Get an equipment by its id Migrate CSV / Excel to database

⌘I

Overview

Activity Log

AI

Attachment

Anomaly

Auth Rs

Comment

Commission

Company

Dashboard

Document

Equipment

Establishment

Intervention

Intervention Anomaly

Label

Organization

Plan Item

Plan

Profile Rule

Report

Routine

Rule

Site

Site Technical Installation

Site Rule

Specification

Tag

Technical Installation

List equipments

Permissions

Business Logic

Authorizations

Headers

Query Parameters

Response