Skip to main content
PATCH
/
equipments
/
v2
/
rs
/
{equipmentId}
Update an equipment
curl --request PATCH \
  --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 '
{
  "name": "Equipment Name",
  "description": "Equipment description",
  "manufacturer": "Equipment Manufacturer",
  "reference": "Equipment reference",
  "condition": 2,
  "availability": 1,
  "technicalInstallationId": 1,
  "siteId": 1,
  "installedById": 1,
  "containedIn": [
    1
  ],
  "specificationIds": [
    1
  ],
  "installedAt": "2024-12-01T12:34:56.000Z",
  "constructedAt": "2024-12-01T12:34:56.000Z"
}
'
{
  "id": 1,
  "name": "Equipment Name",
  "description": "Equipment description",
  "manufacturer": "Equipment Manufacturer",
  "reference": "Equipment reference",
  "condition": 2,
  "availability": 1,
  "technicalInstallationId": 1,
  "siteId": 1,
  "positionId": 1,
  "installedById": 1,
  "installedAt": "2024-12-01T12:34:56.000Z",
  "constructedAt": "2024-12-01T12:34:56.000Z",
  "archivedAt": "2024-12-01T12:34:56.000Z",
  "updatedAt": "2024-12-05T14:56:23.000Z",
  "createdAt": "2024-01-15T08:45:00.000Z"
}

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
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Path Parameters

​
equipmentId
integer
required

Unique identifier of the equipment.

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

1

Body

application/json
​
name
string

Equipment name.

Maximum string length: 250
Example:

"Equipment Name"

​
description
string | null

Description of the equipment.

Maximum string length: 2500
Example:

"Equipment description"

​
manufacturer
string | null

Manufacturer of the equipment.

Maximum string length: 250
Example:

"Equipment Manufacturer"

​
reference
string | null

Reference of the equipment.

Maximum string length: 250
Example:

"Equipment reference"

​
condition
enum<number> | null

Condition of the equipment.

Available options:
1,
2,
3,
4,
5
Example:

2

​
availability
enum<number> | null

Availability of the equipment.

Available options:
1,
2,
3,
4
Example:

1

​
technicalInstallationId
integer

Identifier of the associated technical installation.

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

1

​
siteId
integer

Identifier of the site where the equipment is located.

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

1

​
installedById
integer | null

Identifier of the user who installed the equipment.

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

1

​
containedIn
number[]

The id of the plan item

​
specificationIds
integer[]

Unique identifier of the specificationValue.

Required range: -9007199254740991 <= x <= 9007199254740991
​
installedAt

Installation date of the equipment.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-01T12:34:56.000Z"

​
constructedAt

Construction date of the equipment.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-01T12:34:56.000Z"

Response

200 - application/json

Equipment updated

​
id
integer
required

Unique identifier of the equipment.

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

1

​
name
string
required

Equipment name.

Maximum string length: 250
Example:

"Equipment Name"

​
description
string | null
required

Description of the equipment.

Maximum string length: 2500
Example:

"Equipment description"

​
manufacturer
string | null
required

Manufacturer of the equipment.

Maximum string length: 250
Example:

"Equipment Manufacturer"

​
reference
string | null
required

Reference of the equipment.

Maximum string length: 250
Example:

"Equipment reference"

​
condition
enum<number> | null
required

Condition of the equipment.

Available options:
1,
2,
3,
4,
5
Example:

2

​
availability
enum<number> | null
required

Availability of the equipment.

Available options:
1,
2,
3,
4
Example:

1

​
technicalInstallationId
integer
required

Identifier of the associated technical installation.

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

1

​
siteId
integer
required

Identifier of the site where the equipment is located.

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

1

​
positionId
integer | null
required

Identifier of the position where the equipment is located.

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

1

​
installedById
integer | null
required

Identifier of the user who installed the equipment.

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

1

​
installedAt
required

Installation date of the equipment.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-01T12:34:56.000Z"

​
constructedAt
required

Construction date of the equipment.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-01T12:34:56.000Z"

​
archivedAt
required

Date when the equipment was archived.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-01T12:34:56.000Z"

​
updatedAt
required

Date of the last update of the equipment.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-05T14:56:23.000Z"

​
createdAt
required

Date of equipment creation.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-01-15T08:45:00.000Z"