Skip to main content
PUT
Update an equipment item

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

equipment_item_id
string<uuid>
required

The unique identifier for the equipment item.

Body

application/vnd.api+json

The full equipment item representation. This is a replace (PUT) - any optional relationship or attribute omitted from the body (such as owner) is cleared. The allocation is the exception: an item's allocation can never be cleared, so leaving all five allocated_* relationships out keeps the current one. Supplying one of allocated_person, allocated_scheme, allocated_work_order, allocated_location or allocated_vehicle reallocates the item to it, with the same checks and history as the allocation relationship endpoints. Supplying the relationship the item is already allocated to without meta.starts_at also keeps the current allocation, its start date included; to change only the start date, supply that relationship with a new meta.starts_at. An item with no allocation, created before allocation was required, must be given one: an update that leaves it out is refused with a 400, as is one that supplies more than one. reference, serial and asset_number are all required. asset_number must be unique within the organisation; duplicate serial values within the same organisation are allowed. business_area is required and must always be supplied; send data: null to clear it. manufacturer and model are both optional, but if model is supplied with a non-null data then manufacturer MUST also be supplied with a non-null data and the model must belong to that manufacturer. This applies even when only changing the model — clients must re-send the manufacturer alongside it.

data
object
required

Response

Get a list of equipment in the organisation.

JSON API response object

data
object
required

An equipment item

jsonapi
object
required
included
object[]

Related resources that can be included when an equipment item is returned.

An equipment manufacturer