Update asset

patch https://iris.trackunit.com/api/asset/v1/assets/{assetId}

This API request can be used to update an asset using a partial update approach through the use of JSON Patch defined in RFC 6902.

To be able to call the service a valid token is required. To get a token follow this guide: How to obtain a token

Path Params

assetId

string

required

ID of the asset

Body Params

assetType

string

Type	Description
Attachment	A thing which can be added/attached to something else (machine or equipment) in order to make it more useful or versatile.
Tool	A small powered asset.
Equipment	A non-powered asset.
Other	Anything not matching the other asset types.

brand

string

length between 0 and 256

The brand of the asset.

externalReference

string

length between 0 and 100

An external reference on the asset that can be used to store the identifier from other systems such as ERPs.

model

string

length between 0 and 256

The model type of the asset.

name

string

length between 0 and 127

The name of the asset.

productionDate

date

An optional field to specify the exact production date of the asset in the format YYYY-MM-DD when more precision is needed.
Minimum allowed year for production date is 1900. Maximum allowed year for production date is current year plus one.
For AssetType=MACHINE, it is derived if only productionYear is set. The year of Production Date must match Production Year if both are provided together.
Updating one while deleting the other is an error.

productionYear

int32

The year the asset was produced. Minimum allowed production year is 1900. Maximum allowed production year is current year plus one.
For AssetType=MACHINE, it is derived if only productionDate is set. Production Year must match the year of Production Date if both are provided together.
Updating one while deleting the other is an error.

serialNumber

string

length between 0 and 100

The asset serial number (VIN, PIN etc.)

type

string

length between 0 and 50

The type of the asset (excavator, lift, bucket etc.)

Responses

Response body

object

assetType

string

required

Type	Description
Attachment	A thing which can be added/attached to something else (machine or equipment) in order to make it more useful or versatile.
Tool	A small powered asset.
Equipment	A non-powered asset.
Other	Anything not matching the other asset types.

OTHER MACHINE ATTACHMENT EQUIPMENT TOOL GATEWAY

brand

string

The brand of the asset.

createdAt

date-time

required

Timestamp indicating when the asset was created.

externalReference

string

An external reference on the asset that can be used to store the identifier from other systems such as ERPs.

string

required

The ID of the asset.

model

string

The model type of the asset.

name

string

required

The name of the asset.

ownerAccountId

string

required

The ID of the owner account.

permissions

object

required

deprecated

Contains the list of user permissions applying to given asset.
Deprecated and marked for removal - use GET /assets/{assetId}/editability or POST /assets/actions instead.

edit

boolean

required

deprecated

Defines the permission to edit the object.
Deprecated and marked for removal - use GET /assets/{assetId}/editability instead.

productionYear

int32

≥ 1900

The year the asset was produced.

serialNumber

string

The asset serial number (VIN, PIN etc.)

telematicsDevices

array of objects

List of associated telematics devices.

telematicsDevices

object

string

required

serialNumber

string

required

type

string

The type of the asset (excavator, lift, bucket etc.)

200Asset was successfully updated.

401Invalid or missing bearer token in Authorization header

403User not allowed to make this request. These are the possible error codes from this API: only_owner_of_the_asset_can_edit_given_fields Fields like: assetType, type, model, brand, productionYear, serialNumber can be modified only by user which is the owner of the asset.

404Resource not found. These are the possible error codes from this API: asset_not_found Asset was not found by given id.

500Internal server error