Get an Asset
get
/rest/v16/assets/{id}
This operation returns asset data for the specific asset.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Primary Key of Asset Resource.
Query Parameters
-
expand: string
Allows expansion of relationships.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Assets
Type:
object
Title:
Show Source
Assets
-
assetDescription:
string
Title:
Asset Description
Description of the asset. -
assetKey:
string
Title:
Asset Key
An invariant key that uniquely identifies the asset/component for the lifetime of the asset. It will be unique across all asset repositories. -
attributes:
object Attributes
Title:
Attributes
A JSON collection of key/value pair attributes that define the configuration of this asset/component. -
billingAccount:
string
Title:
Billing Account
The billing account associated with this asset. -
billingProfile:
string
Title:
Billing Profile
The billing profile associated with this asset. -
bomItemId:
string
Title:
BOM Item Id
The BOM item identifier. -
contractReference:
string
Title:
Contract Reference
The contract associated with this asset. -
currency:
object Currency
Title:
Currency
Currency Code for the asset -
customer:
string
Title:
Customer
The customer that owns the product. This is the value stored in the main document XML attribute _customer_id. -
dateAdded:
string
Title:
Date Added
System field indicating the date on that the resource was created. -
dateModified:
string
Title:
Date Modified
System field indicating the date that the resource was last modified. -
descendantAssets:
object descendantAssets-collection
Title:
descendantAssets-collection
-
discountAmount:
object Discount Amount
Title:
Discount Amount
The amount of discount received. -
discountPercent:
number
Title:
Discount Percent
The percent of discount received. -
displayKey:
string
Title:
Display Key
The public, non-unique key for the product instance. For example, phone number or serial number. -
endDate:
string
Title:
End Date
The date the the service contract ends. -
fixedRecurringAmount:
object Fixed Recurring Amount
Title:
Fixed Recurring Amount
The recurring charge for the product. For example, $10 per month. -
fixedRecurringPeriod:
string
Title:
Fixed Recurring Period
The period for the fixed recurring charge. For example, Per Month. -
id:
integer
Title:
Id
The Primary key of the asset resource. -
installDate:
string
Title:
Install Date
The date that the asset was installed. -
modelPath:
string
Title:
BOM Model Path
The path to a model in the BOM hierarchy. -
oneTimeNetAmount:
object One Time Net Amount
Title:
One Time Net Amount
The price paid to purchase the product. -
origTransactionId:
string
Title:
Original Transaction Id
The Id of the original transaction used to create the asset. -
parentAsset:
object Parent Asset Id
Title:
Parent Asset Id
The parent component of the asset tree. -
parentBomItemId:
string
Title:
Parent BOM Item Id
The BOM item identifier of the parent asset. -
parentDisplay:
string
Title:
Parent Display
The display key of the parent asset. -
parentPartNumber:
string
Title:
Parent Part Number
The part number of the parent asset. -
partDescription:
string
Title:
Part Description
The description of the part. -
partNumber:
string
Title:
Part Number
Part Number of the referenced product instance. -
paymentTerm:
string
Title:
Payment Term
The payment terms. For example, Net 30. -
purchaseDate:
string
Title:
Purchase Date
The date that the product or service was purchased. -
quantity:
number
Title:
Quantity
The quantity of the asset. -
registeredDate:
string
Title:
Registered Date
The date that the product was registered. -
resumeDate:
string
Title:
Resume Date
The date that the the service contract was resumed. -
rootAsset:
object Root Asset Id
Title:
Root Asset Id
The root component in the asset tree. -
rootDisplay:
string
Title:
Root Display
The display key of the root asset. -
rootPartNumber:
string
Title:
Root Part Number
The part number of the root asset. -
serialNumber:
string
Title:
Serial Number
The serial number of the asset. -
serviceAccount:
string
Title:
Service Account
The service account associated with this asset. -
serviceAddress:
string
Title:
Service Address
The service address associated with this asset. -
startDate:
string
Title:
Start Date
The date that the service contract starts. -
status:
object Status
Title:
Status
The status of the asset. -
suspendDate:
string
Title:
Suspend Date
The date that the service contract was suspended. -
usageNetAmount:
object Usage Net Amount
Title:
Usage Net Amount
The variable, usage price for the product. For example, $0.10 per Copy. -
usageUnitOfMeasure:
string
Title:
Usage Unit of Measure
The unit of measure for the usage charges. For example, Per Copy or Per Minute. -
warrantyEndDate:
string
Title:
Warranty End Date
The date that the warranty ends. -
warrantyStartDate:
string
Title:
Warranty Start Date
The date that the warranty starts.
Nested Schema : Attributes
Type:
object
Title:
Attributes
A JSON collection of key/value pair attributes that define the configuration of this asset/component.
Nested Schema : Currency
Type:
object
Title:
Currency
Currency Code for the asset
Show Source
-
currencyCode:
string
Title:
Currency Code
Unique currency code for the currency.
Nested Schema : descendantAssets-collection
Type:
object
Title:
Show Source
descendantAssets-collection
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Discount Amount
Type:
object
Title:
Discount Amount
The amount of discount received.
Show Source
-
currency:
string
Title:
Currency
-
value:
number
Title:
Value
Nested Schema : Fixed Recurring Amount
Type:
object
Title:
Fixed Recurring Amount
The recurring charge for the product. For example, $10 per month.
Show Source
-
currency:
string
Title:
Currency
-
value:
number
Title:
Value
Nested Schema : One Time Net Amount
Type:
object
Title:
One Time Net Amount
The price paid to purchase the product.
Show Source
-
currency:
string
Title:
Currency
-
value:
number
Title:
Value
Nested Schema : Parent Asset Id
Type:
object
Title:
Parent Asset Id
The parent component of the asset tree.
Show Source
-
assetKey:
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
id:
integer
Title:
Id
Primary Key of Asset Resource.
Nested Schema : Root Asset Id
Type:
object
Title:
Root Asset Id
The root component in the asset tree.
Show Source
-
assetKey:
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
id:
integer
Title:
Id
Primary Key of Asset Resource.
Nested Schema : Status
Type:
object
Title:
Status
The status of the asset.
Show Source
-
displayValue:
string
Title:
Display Value
The translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
The primary key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Usage Net Amount
Type:
object
Title:
Usage Net Amount
The variable, usage price for the product. For example, $0.10 per Copy.
Show Source
-
currency:
string
Title:
Currency
-
value:
number
Title:
Value
Nested Schema : items
Type:
Show Source
array
-
Array of:
object descendantAssetsDef
Title:
descendantAssetsDef
Nested Schema : descendantAssetsDef
Type:
object
Title:
Show Source
descendantAssetsDef
-
assetDescription:
string
Title:
Asset Description
The description of the asset. -
assetKey:
string
Title:
Asset Key
An invariant key that uniquely identifies the asset/component for the lifetime of the asset. It will be unique across all asset repositories. -
attributes:
object Attributes
Title:
Attributes
A JSON collection of key/value pair attributes that define the configuration of this asset/component. -
billingAccount:
string
Title:
Billing Account
The billing account associated with this asset. -
billingProfile:
string
Title:
Billing Profile
The billing profile associated with this asset. -
bomItemId:
string
Title:
BOM Item Id
The BOM item identifier. -
contractReference:
string
Title:
Contract Reference
The contract associated with this asset. -
currency:
object Currency
Title:
Currency
Currency Code for the asset -
customer:
string
Title:
Customer
The customer that owns the product. This is the value stored in the main document XML attribute _customer_id. -
dateAdded:
string
Title:
Date Added
System field indicating the date that the resource was created. -
dateModified:
string
Title:
Date Modified
System field indicating the date that the resource was last modified. -
discountAmount:
object Discount Amount
Title:
Discount Amount
The amount of discount received. -
discountPercent:
number
Title:
Discount Percent
The percent of discount received. -
displayKey:
string
Title:
Display Key
The public, non-unique key for the product instance. For example, phone number or serial number. -
endDate:
string
Title:
End Date
The date that the service contract ends. -
fixedRecurringAmount:
object Fixed Recurring Amount
Title:
Fixed Recurring Amount
The recurring charge for the product. For example, $10 per month. -
fixedRecurringPeriod:
string
Title:
Fixed Recurring Period
The period for the fixed recurring charge. For example, Per Month. -
id:
integer
Title:
Id
The primary key of the asset resource. -
installDate:
string
Title:
Install Date
The date that the asset was installed. -
modelPath:
string
Title:
BOM Model Path
The path to a model in the BOM hierarchy. -
oneTimeNetAmount:
object One Time Net Amount
Title:
One Time Net Amount
The price paid to purchase the product. -
origTransactionId:
string
Title:
Original Transaction Id
The Id of the original transaction used to create the asset. -
parentAsset:
object Parent Asset Id
Title:
Parent Asset Id
The parent component of the asset tree. -
parentBomItemId:
string
Title:
Parent BOM Item Id
The BOM item identifier of the parent asset. -
parentDisplay:
string
Title:
Parent Display
The display key of the parent asset. -
parentPartNumber:
string
Title:
Parent Part Number
The part number of the parent asset. -
partDescription:
string
Title:
Part Description
The description of the part. -
partNumber:
string
Title:
Part Number
Part Number of the referenced product instance. -
paymentTerm:
string
Title:
Payment Term
The payment terms. For example, Net 30. -
purchaseDate:
string
Title:
Purchase Date
The date that the product or service was purchased. -
quantity:
number
Title:
Quantity
The quantity of the asset. -
registeredDate:
string
Title:
Registered Date
The date that the product was registered. -
resumeDate:
string
Title:
Resume Date
The date that the service contract was resumed. -
rootAsset:
object Root Asset Id
Title:
Root Asset Id
The root component in the asset tree. -
rootDisplay:
string
Title:
Root Display
The display key of the root asset. -
rootPartNumber:
string
Title:
Root Part Number
The part number of the root asset. -
serialNumber:
string
Title:
Serial Number
The serial number of the asset. -
serviceAccount:
string
Title:
Service Account
The service account associated with this asset. -
serviceAddress:
string
Title:
Service Address
The service address associated with this asset. -
startDate:
string
Title:
Start Date
The date that the service contract starts. -
status:
object Status
Title:
Status
The status of the asset -
suspendDate:
string
Title:
Suspend Date
The date that the service contract was suspended. -
usageNetAmount:
object Usage Net Amount
Title:
Usage Net Amount
The variable, usage price for the product. For example, $0.10 per Copy. -
usageUnitOfMeasure:
string
Title:
Usage Unit of Measure
The unit of measure for the usage charges. For example, Per Copy or Per Minute. -
warrantyEndDate:
string
Title:
Warranty End Date
The date that the warranty ends. -
warrantyStartDate:
string
Title:
Warranty Start Date
The date that the warranty starts.
Nested Schema : Attributes
Type:
object
Title:
Attributes
A JSON collection of key/value pair attributes that define the configuration of this asset/component.
Nested Schema : Currency
Type:
object
Title:
Currency
Currency Code for the asset
Show Source
-
currencyCode:
string
Title:
Currency Code
Unique currency code for the currency.
Nested Schema : Discount Amount
Type:
object
Title:
Discount Amount
The amount of discount received.
Show Source
-
currency:
string
Title:
Currency
-
value:
number
Title:
Value
Nested Schema : Fixed Recurring Amount
Type:
object
Title:
Fixed Recurring Amount
The recurring charge for the product. For example, $10 per month.
Show Source
-
currency:
string
Title:
Currency
-
value:
number
Title:
Value
Nested Schema : One Time Net Amount
Type:
object
Title:
One Time Net Amount
The price paid to purchase the product.
Show Source
-
currency:
string
Title:
Currency
-
value:
number
Title:
Value
Nested Schema : Parent Asset Id
Type:
object
Title:
Parent Asset Id
The parent component of the asset tree.
Show Source
-
assetKey:
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
id:
integer
Title:
Id
Primary Key of Asset Resource.
Nested Schema : Root Asset Id
Type:
object
Title:
Root Asset Id
The root component in the asset tree.
Show Source
-
assetKey:
string
Title:
Asset Key
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories. -
id:
integer
Title:
Id
Primary Key of Asset Resource.
Nested Schema : Status
Type:
object
Title:
Status
The status of the asset
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
The primary key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Usage Net Amount
Type:
object
Title:
Usage Net Amount
The variable, usage price for the product. For example, $0.10 per Copy.
Show Source
-
currency:
string
Title:
Currency
-
value:
number
Title:
Value