Updates an asset.

patch

https://asset-management.api.eu1.scalar.zf.com/v1/assets/{assetId}

Updates an asset.

Path Params

assetId

uuid

required

ID of the asset

Body Params

Provides input to update asset details.

displayName

string | null

Represents the Asset name.

internalCode

string | null

Represents the Asset code used for internal identification.

externalCode

string | null

Represents the Asset code used for external identification.

assetType

string

enum

Represents the type of the Asset.

Allowed:

mileage

double

Defaults to 0

Represents the mileage of the Asset.

assetCategory

string

enum

Defaults to Unknown

Represents the category of the Asset.

assignees

object | null

Represents the field to assign either teams or users to an asset.Or it can be accessed by all when the All property is set True.

licensePlate

string

Represents License-plate details.

vin

string | null

Represents the Vehicle Identification Number (VIN) (Chassis number). When TDA feature is enabled for an organization it is mandatory. For trailer asset types it is optional.

status

string | null

enum

Defaults to Active

Represents status of the asset.

Allowed:

devices

array of strings | null

Represents a list of devices connected to the asset. Type of device can be anyone of the device types mentioned: txgo, txgo2, txg03, simtxgo, simtxgo2, simtxgo3, daf, tp, tpnb, tpsim, txtrailerguard, simtxtrailerguard, munic, traxee, simtraxee, scania, tcu350c, tmd102, tmd104, tmd200, tmd200a, and mcu.

devices

customLabels

object | null

Represents Custom labels.

tachoVersion

string

enum

Defaults to notConnected

Represents the tacho version of the asset. Available only for assetType : car, van, and truck. Tacho version is not required for trailer asset type.

Allowed:

emission

string | null

enum

Defaults to null

Emission norms of the asset

Allowed:

energySource

string | null

enum

Defaults to null

Energy Source of the asset

seatCapacity

integer

Defaults to 0

Seating Capacity of the Asset

wheelChairCapacity

int32

Defaults to 0

Wheelchair Capacity of the Asset

fleetId

string | null

Fleet Id

assetMetadata

object

tachoDetail

object | null

Represents the tacho details. It is mandatory when TDA feature is enabled for the organization. Tacho detail is not required for trailer asset type.

model

string | null

Model setting of the asset.

segment

string | null

Segment setting of the asset.

manufacturer

string | null

Manufacturer setting of the asset

trailerType

string | null

trailer type of the asset

countryCode

string | null

Country of registration of the asset. Two-letter country codes (e.g., US for United States, DE for Germany) as per ISO 3166-1 alpha-2 standard.

nextInspectionDate

date-time | null

Next inspection or mandatory checkup date of the asset

Responses

401

Unauthorized access.

429

Too many requests.

200Success code. Returns the updated asset, if succeeded.

400Failure code. The request was unacceptable, verify the following points: License plate was not provided License plate is already in use by another asset Invalid asset status

404Failure code. The provided asset ID was not found.

500Faliure code. Indicates an internal server error (unhandled exception).