Get Asset

GET /assets/{assetId}

Get Asset

cURL

curl --request GET \
  --url https://api.example.com/assets/{assetId}

200

{
  "type": "<string>",
  "id": "<string>",
  "lastModifiedAt": "<string>",
  "createdAt": "<string>",
  "status": "ASSET_CREATED",
  "policyId": "<string>",
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "createdOnBranch": true,
  "editedOnBranch": true,
  "startedAt": "<string>",
  "stoppedAt": "<string>",
  "cancelledAt": "<string>",
  "externalAssetId": "<string>"
}

Path Parameters

assetId · string · required

assetId

Query Parameters

whenAt · string

Optional: the whenAt datetime

simulatedAt · string

Optional: the simulatedAt datetime

branchId · string

Optional: the branchId

Response

200

application/json

type · string · required

Entity type

id · string · required

assetId

lastModifiedAt · string · required

Last modified date of the asset

createdAt · string · required

Creation date of the asset

status · enum<string> · required

Status of the asset

Available options: ASSET_CREATED, ASSET_REMOVED, ASSET_QUOTED, ASSET_CONFIRMED, ASSET_STARTED, ASSET_STOPPED, ASSET_CANCELLED

policyId · string · required

policyId of asset owner

customFields · object[]

custom fields per product

Show child attributes

name · string

Optional: Name of the entity

createdOnBranch · boolean

Whether the asset was created on a branch

editedOnBranch · boolean

Whether the asset was edited on a branch

startedAt · string

Date the asset starts

stoppedAt · string

Date the asset stops

cancelledAt · string

Date the asset was cancelled

externalAssetId · string

externalAssetId

quote · object

asset quote

Show child attributes

proratedQuote · object

Prorated asset quote based on the invoicing frequency of the policy

Show child attributes