Get Child Assets
get
/rest/v16/assets/{id}/childAssets
This operation retrieves all direct child assets of the specified 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.
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of pairs to order the response by.
-
q: string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
Root Schema : assets-collection
Type:
Show Source
object-
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 : Assets
Type:
objectTitle:
Show Source
Assets-
assetDescription:
string
Title:
Asset DescriptionDescription of the asset. -
assetKey:
string
Title:
Asset KeyAn 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:
AttributesA JSON collection of key/value pair attributes that define the configuration of this asset/component. -
billingAccount:
string
Title:
Billing AccountThe billing account associated with this asset. -
billingProfile:
string
Title:
Billing ProfileThe billing profile associated with this asset. -
bomItemId:
string
Title:
BOM Item IdThe BOM item identifier. -
contractReference:
string
Title:
Contract ReferenceThe contract associated with this asset. -
currency:
object Currency
Title:
CurrencyCurrency Code for the asset -
customer:
string
Title:
CustomerThe customer that owns the product. This is the value stored in the main document XML attribute _customer_id. -
dateAdded:
string
Title:
Date AddedSystem field indicating the date on that the resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date that the resource was last modified. -
descendantAssets:
object descendantAssets-collection
Title:
descendantAssets-collection -
discountAmount:
object Discount Amount
Title:
Discount AmountThe amount of discount received. -
discountPercent:
number
Title:
Discount PercentThe percent of discount received. -
displayKey:
string
Title:
Display KeyThe public, non-unique key for the product instance. For example, phone number or serial number. -
endDate:
string
Title:
End DateThe date the the service contract ends. -
fixedRecurringAmount:
object Fixed Recurring Amount
Title:
Fixed Recurring AmountThe recurring charge for the product. For example, $10 per month. -
fixedRecurringPeriod:
string
Title:
Fixed Recurring PeriodThe period for the fixed recurring charge. For example, Per Month. -
id:
integer
Title:
IdThe Primary key of the asset resource. -
installDate:
string
Title:
Install DateThe date that the asset was installed. -
modelPath:
string
Title:
BOM Model PathThe path to a model in the BOM hierarchy. -
oneTimeNetAmount:
object One Time Net Amount
Title:
One Time Net AmountThe price paid to purchase the product. -
origTransactionId:
string
Title:
Original Transaction IdThe Id of the original transaction used to create the asset. -
parentAsset:
object Parent Asset Id
Title:
Parent Asset IdThe parent component of the asset tree. -
parentBomItemId:
string
Title:
Parent BOM Item IdThe BOM item identifier of the parent asset. -
parentDisplay:
string
Title:
Parent DisplayThe display key of the parent asset. -
parentPartNumber:
string
Title:
Parent Part NumberThe part number of the parent asset. -
partDescription:
string
Title:
Part DescriptionThe description of the part. -
partNumber:
string
Title:
Part NumberPart Number of the referenced product instance. -
paymentTerm:
string
Title:
Payment TermThe payment terms. For example, Net 30. -
purchaseDate:
string
Title:
Purchase DateThe date that the product or service was purchased. -
quantity:
number
Title:
QuantityThe quantity of the asset. -
registeredDate:
string
Title:
Registered DateThe date that the product was registered. -
resumeDate:
string
Title:
Resume DateThe date that the the service contract was resumed. -
rootAsset:
object Root Asset Id
Title:
Root Asset IdThe root component in the asset tree. -
rootDisplay:
string
Title:
Root DisplayThe display key of the root asset. -
rootPartNumber:
string
Title:
Root Part NumberThe part number of the root asset. -
serialNumber:
string
Title:
Serial NumberThe serial number of the asset. -
serviceAccount:
string
Title:
Service AccountThe service account associated with this asset. -
serviceAddress:
string
Title:
Service AddressThe service address associated with this asset. -
startDate:
string
Title:
Start DateThe date that the service contract starts. -
status:
object Status
Title:
StatusThe status of the asset. -
suspendDate:
string
Title:
Suspend DateThe date that the service contract was suspended. -
usageNetAmount:
object Usage Net Amount
Title:
Usage Net AmountThe variable, usage price for the product. For example, $0.10 per Copy. -
usageUnitOfMeasure:
string
Title:
Usage Unit of MeasureThe unit of measure for the usage charges. For example, Per Copy or Per Minute. -
warrantyEndDate:
string
Title:
Warranty End DateThe date that the warranty ends. -
warrantyStartDate:
string
Title:
Warranty Start DateThe date that the warranty starts.
Nested Schema : Attributes
Type:
objectTitle:
AttributesA JSON collection of key/value pair attributes that define the configuration of this asset/component.
Nested Schema : Currency
Type:
objectTitle:
CurrencyCurrency Code for the asset
Show Source
-
currencyCode:
string
Title:
Currency CodeUnique currency code for the currency.
Nested Schema : descendantAssets-collection
Type:
objectTitle:
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:
objectTitle:
Discount AmountThe amount of discount received.
Show Source
-
currency:
string
Title:
Currency -
value:
number
Title:
Value
Nested Schema : Fixed Recurring Amount
Type:
objectTitle:
Fixed Recurring AmountThe 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:
objectTitle:
One Time Net AmountThe price paid to purchase the product.
Show Source
-
currency:
string
Title:
Currency -
value:
number
Title:
Value
Nested Schema : Parent Asset Id
Type:
objectTitle:
Parent Asset IdThe parent component of the asset tree.
Show Source
-
assetKey:
string
Title:
Asset KeyAn 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:
IdPrimary Key of Asset Resource.
Nested Schema : Root Asset Id
Type:
objectTitle:
Root Asset IdThe root component in the asset tree.
Show Source
-
assetKey:
string
Title:
Asset KeyAn 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:
IdPrimary Key of Asset Resource.
Nested Schema : Status
Type:
objectTitle:
StatusThe status of the asset.
Show Source
-
displayValue:
string
Title:
Display ValueThe translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdThe primary key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Usage Net Amount
Type:
objectTitle:
Usage Net AmountThe 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:
objectTitle:
Show Source
descendantAssetsDef-
assetDescription:
string
Title:
Asset DescriptionThe description of the asset. -
assetKey:
string
Title:
Asset KeyAn 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:
AttributesA JSON collection of key/value pair attributes that define the configuration of this asset/component. -
billingAccount:
string
Title:
Billing AccountThe billing account associated with this asset. -
billingProfile:
string
Title:
Billing ProfileThe billing profile associated with this asset. -
bomItemId:
string
Title:
BOM Item IdThe BOM item identifier. -
contractReference:
string
Title:
Contract ReferenceThe contract associated with this asset. -
currency:
object Currency
Title:
CurrencyCurrency Code for the asset -
customer:
string
Title:
CustomerThe customer that owns the product. This is the value stored in the main document XML attribute _customer_id. -
dateAdded:
string
Title:
Date AddedSystem field indicating the date that the resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date that the resource was last modified. -
discountAmount:
object Discount Amount
Title:
Discount AmountThe amount of discount received. -
discountPercent:
number
Title:
Discount PercentThe percent of discount received. -
displayKey:
string
Title:
Display KeyThe public, non-unique key for the product instance. For example, phone number or serial number. -
endDate:
string
Title:
End DateThe date that the service contract ends. -
fixedRecurringAmount:
object Fixed Recurring Amount
Title:
Fixed Recurring AmountThe recurring charge for the product. For example, $10 per month. -
fixedRecurringPeriod:
string
Title:
Fixed Recurring PeriodThe period for the fixed recurring charge. For example, Per Month. -
id:
integer
Title:
IdThe primary key of the asset resource. -
installDate:
string
Title:
Install DateThe date that the asset was installed. -
modelPath:
string
Title:
BOM Model PathThe path to a model in the BOM hierarchy. -
oneTimeNetAmount:
object One Time Net Amount
Title:
One Time Net AmountThe price paid to purchase the product. -
origTransactionId:
string
Title:
Original Transaction IdThe Id of the original transaction used to create the asset. -
parentAsset:
object Parent Asset Id
Title:
Parent Asset IdThe parent component of the asset tree. -
parentBomItemId:
string
Title:
Parent BOM Item IdThe BOM item identifier of the parent asset. -
parentDisplay:
string
Title:
Parent DisplayThe display key of the parent asset. -
parentPartNumber:
string
Title:
Parent Part NumberThe part number of the parent asset. -
partDescription:
string
Title:
Part DescriptionThe description of the part. -
partNumber:
string
Title:
Part NumberPart Number of the referenced product instance. -
paymentTerm:
string
Title:
Payment TermThe payment terms. For example, Net 30. -
purchaseDate:
string
Title:
Purchase DateThe date that the product or service was purchased. -
quantity:
number
Title:
QuantityThe quantity of the asset. -
registeredDate:
string
Title:
Registered DateThe date that the product was registered. -
resumeDate:
string
Title:
Resume DateThe date that the service contract was resumed. -
rootAsset:
object Root Asset Id
Title:
Root Asset IdThe root component in the asset tree. -
rootDisplay:
string
Title:
Root DisplayThe display key of the root asset. -
rootPartNumber:
string
Title:
Root Part NumberThe part number of the root asset. -
serialNumber:
string
Title:
Serial NumberThe serial number of the asset. -
serviceAccount:
string
Title:
Service AccountThe service account associated with this asset. -
serviceAddress:
string
Title:
Service AddressThe service address associated with this asset. -
startDate:
string
Title:
Start DateThe date that the service contract starts. -
status:
object Status
Title:
StatusThe status of the asset -
suspendDate:
string
Title:
Suspend DateThe date that the service contract was suspended. -
usageNetAmount:
object Usage Net Amount
Title:
Usage Net AmountThe variable, usage price for the product. For example, $0.10 per Copy. -
usageUnitOfMeasure:
string
Title:
Usage Unit of MeasureThe unit of measure for the usage charges. For example, Per Copy or Per Minute. -
warrantyEndDate:
string
Title:
Warranty End DateThe date that the warranty ends. -
warrantyStartDate:
string
Title:
Warranty Start DateThe date that the warranty starts.
Nested Schema : Attributes
Type:
objectTitle:
AttributesA JSON collection of key/value pair attributes that define the configuration of this asset/component.
Nested Schema : Currency
Type:
objectTitle:
CurrencyCurrency Code for the asset
Show Source
-
currencyCode:
string
Title:
Currency CodeUnique currency code for the currency.
Nested Schema : Discount Amount
Type:
objectTitle:
Discount AmountThe amount of discount received.
Show Source
-
currency:
string
Title:
Currency -
value:
number
Title:
Value
Nested Schema : Fixed Recurring Amount
Type:
objectTitle:
Fixed Recurring AmountThe 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:
objectTitle:
One Time Net AmountThe price paid to purchase the product.
Show Source
-
currency:
string
Title:
Currency -
value:
number
Title:
Value
Nested Schema : Parent Asset Id
Type:
objectTitle:
Parent Asset IdThe parent component of the asset tree.
Show Source
-
assetKey:
string
Title:
Asset KeyAn 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:
IdPrimary Key of Asset Resource.
Nested Schema : Root Asset Id
Type:
objectTitle:
Root Asset IdThe root component in the asset tree.
Show Source
-
assetKey:
string
Title:
Asset KeyAn 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:
IdPrimary Key of Asset Resource.
Nested Schema : Status
Type:
objectTitle:
StatusThe status of the asset
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdThe primary key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Usage Net Amount
Type:
objectTitle:
Usage Net AmountThe variable, usage price for the product. For example, $0.10 per Copy.
Show Source
-
currency:
string
Title:
Currency -
value:
number
Title:
Value