Skip to main content
Loading...

API docs by

Get details of an asset

Request

The Get assets by Id API returns all details for a specific asset from its identification number. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

Path
assetIdstringrequired

{assetId} identification number

Headers
Authorizationstringrequired

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

Assets search response

Bodyapplication/json
assetNumberstring

Asset number.

serialNumberstring

Serial number of the asset.

orderNumberstring

Order number associated with the asset/service.

productNamestring

Product type.

ibxstring

Ibx of the location.

cagestring

Cage of the location.

productDescriptionstring

Product description.

accountNumberstring

Account number of the product/services belongs to.

accountNamestring

Account name of the product/services.

installationDatestring, (date-time)

Date time of the product or service is purchased/installed.

customerReferenceNumberstring

Customer reference number.

statusstring
Enum:"ACTIVE""INACTIVE"
productDetailsArray of objects(AssetsProperty)

key/value pairs of product details.

Response
{
  "data": [
    { … }
  ]
}
Was this page helpful?