Skip to main content
GET
/
equipments
/
v2
/
rs
/
{equipmentId}
Get an equipment by its id
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/equipments/v2/rs/{equipmentId} \
  --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,
    "positionId": 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
    },
    "updatableFields": {
      "name": true,
      "description": true,
      "reference": true,
      "condition": true,
      "availability": true,
      "technicalInstallationId": true,
      "siteId": true,
      "installedById": true,
      "containedIn": true,
      "specificationIds": true,
      "installedAt": true,
      "constructedAt": true
    },
    "establishmentCell": {
      "establishment": {
        "id": 1,
        "name": "Main site",
        "count": 123
      },
      "cell": {
        "id": 1,
        "name": "Main site",
        "count": 123
      }
    }
  }
}

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

Path Parameters

​
equipmentId
integer
required

Unique identifier of the equipment.

Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "technical-installation": Get information about technical installations linked to the specification definition

  • "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

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

  • "establishment-cell": Get information about the establishment cell

Available options:
technical-installation,
site,
position,
installed-by,
specifications,
actions-info,
updatable-fields,
establishment-cell

Response

200 - application/json

Equipment found

​
data
object
required