Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Equipment

Update a piece of equipment.

put/api/equipment/{id}

Path parameters

idstring required

Request body

namestring required

Identifying name. Must be unique.

descriptionstring required

Description. Required.

workCenterIdstring nullable

WorkCenter identifier. Please reference /api/work-centers endpoint.

manufacturerstring nullable

Manufacturer.

modelNumberstring nullable

Model number.

serialNumberstring nullable

Serial number.

canRunUnattendedboolean

Indicates if this equipment can be run unattended. This allows the portion of an operation that utilizes this equipment to be scheduled outside of a shift.

unlimitedCapacityboolean

Indicates if this equipment can support multiple operations simultaneously.

status'good' | 'poor' | 'bad' | 'outOfService'

Equipment status

notesstring nullable

Notes associated to the equipment.

Response

The updated equipment

idstring required

Unique id associated to this entity.

namestring required

Identifying name. Must be unique.

descriptionstring nullable

Description.

workCenterIdstring nullable

WorkCenter identifier. Please reference /api/work-centers endpoint.

manufacturerstring nullable

Manufacturer.

modelNumberstring nullable

Model number.

serialNumberstring nullable

Serial number.

canRunUnattendedboolean nullable

Indicates if this equipment can be run unattended. This allows the portion of an operation that utilizes this equipment to be scheduled outside of a shift.

unlimitedCapacityboolean nullable

Indicates if this equipment can support multiple operations simultaneously.

status'good' | 'poor' | 'bad' | 'outOfService'

Equipment status

notesstring nullable

Notes associated to the equipment.

deletedboolean

Indicates whether this equipment has been deleted