Get an Asset
get
/rest/v19/assets/{id}
This operation returns asset data for the specific asset. This endpoint supports queries for child and descendent assets.
Request
Path Parameters
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=charges. To include all the child resources specify the value of this query parameter to be all.
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : assetBean
Type:
Show Source
object-
assetDescription:
string()
Title:
Asset DescriptionDescription of the asset -
assetInstanceTracked:
boolean()
Title:
Asset Instance TrackedWhether the asset instance is tracked -
assetKey:
string()
Title:
Asset KeyUnique key identifier for the asset -
assetProductType:
string()
Title:
Asset Product TypeType of the asset product -
attributes:
string()
Title:
Attributes ObjectJSON string containing asset attributes -
billingAccount:
string()
Title:
Billing Account ReferenceReference to the billing account -
billingProfile:
string()
Title:
Billing Profile ReferenceReference to the billing profile -
billToAccountId:
string()
Title:
Bill To Account IdThe id of the billing account -
billToAccountName:
string()
Title:
Bill To Account NameName of the bill-to account -
billToAddress:
string()
Title:
Bill To AddressAddress of the organization where the asset was billed -
billToFirstName:
string()
Title:
Bill To Contact First NameFirst name of the contact person of the organization to which the asset was billed -
billToLastName:
string()
Title:
Bill To Contact Last NameLast name of the contact person of the organization to which the asset was billed -
billToParty:
string()
Title:
Bill To Party ReferenceReference to the bill-to party -
billToSiteUse:
string()
Title:
Bill To Site Use ReferenceReference to the bill-to site use -
bomItemId:
string()
Title:
BOM Item IDBill of Materials item identifier -
bomModelPath:
string()
Title:
BOM Model PathPath to the Bill of Materials model -
businessUnitId:
string()
Title:
Business Unit IdCustomer business unit identifier -
cancelledQuantity:
number()
Title:
Cancelled QuantityQuantity that has been cancelled -
charges:
Asset Charges
Title:
Asset ChargesRead Only:trueCollection of asset charges -
closedDate:
string()
Title:
Closed DateDate when the asset was closed -
competitiveAsset:
string()
Title:
Competitive AssetWhether the asset is competitive -
configAttrInfo:
string()
Title:
Config Attribute InfoRead Only:trueConfiguration attribute information -
contractedPeriods:
integer()
Title:
Contracted PeriodsNumber of contracted periods -
contractReference:
string()
Title:
Contract ReferenceReference to the associated contract -
coveredFulfillmentLineId:
string()
Title:
Covered Fulfillment Line IdFulfillment Line Id for the covered item -
coveredItemAssetKey:
string()
Title:
Covered Item Asset KeyAsset key of the covered item -
coveredItemLineNumber:
string()
Title:
Covered Item Line NumberLine number of the covered item -
coveredItemOrderNumber:
string()
Title:
Covered Item Order NumberOrder number of the covered item -
coveredItemUom:
string()
Title:
Covered Item UOMUnit of measure for the covered item -
currency:
string()
Title:
Currency CodeCurrency code for the asset -
customer:
string()
Title:
Customer ReferenceReference to the customer -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation Date of the Asset. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast Modified date of the Asset. -
discountAmount:
Discount Amount
Title:
Discount AmountAmount of discount applied -
discountPercent:
number()
Title:
Discount PercentPercentage of discount applied -
displayKey:
string()
Title:
Display KeyDisplay key for the asset -
endDate:
string()
Title:
End DateEnd date of the asset -
extAssetVersionNumber:
string()
Title:
External Asset Version NumberVersion number of the external asset -
fixedRecurringAmt:
Fixed Recurring Amount
Title:
Fixed Recurring AmountFixed recurring amount for the asset -
fixedRecurringPeriod:
string()
Title:
Fixed Recurring Period CodeCode for the fixed recurring period -
fulfilledQuantity:
number()
Title:
Fulfilled QuantityQuantity that has been fulfilled -
fulfillmentSourceSystem:
string()
Title:
Fulfillment Source SystemSource system for fulfillment -
goodsQuoteLineId:
string()
Title:
Goods Quote Line IDID of the goods quote line -
hasPendingOrder:
boolean()
Title:
Has Pending OrderIndicates whether the asset has a pending order -
id:
integer()
Title:
IDUnique identifier for the asset -
installDate:
string()
Title:
Install DateInstallation date of the asset -
instances:
Asset Instances
Title:
Asset InstancesRead Only:trueCollection of asset instances -
inventoryItemId:
string()
Title:
Inventory Item IDID of the inventory item -
inventoryOrgId:
string()
Title:
Inventory Org IDID of the inventory organization -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
oneTimeNetAmt:
One Time Net Amount
Title:
One Time Net AmountOne-time net amount for the asset -
orderLineId:
string()
Title:
Order Line IDID of the order line -
orderNumber:
string()
Title:
Order NumberNumber of the order -
originalAssetKey:
string()
Title:
Original Asset KeyOriginal key of the asset -
originalRootAssetKey:
string()
Title:
Original Root Asset KeyOriginal key of the root asset -
origTransactionId:
string()
Title:
Original Transaction IDID of the original transaction -
parentAsset:
Parent Asset
Title:
Parent AssetRead Only:trueParent asset object -
parentAssetId:
integer()
Title:
Parent Asset IDID of the parent asset -
parentAssetKey:
string()
Title:
Parent Asset KeyKey of the parent asset -
partDisplayNumber:
string()
Title:
Part Display NumberPart display number of the asset -
partNumber:
string()
Title:
Part NumberPart number of the asset -
paymentTerm:
string()
Title:
Payment Term CodeCode for the payment term -
previousAssetKey:
string()
Title:
Previous Asset KeyKey of the previous asset -
previousAssetRelationCode:
string()
Title:
Previous Asset Relation CodeCode for the previous asset relation -
priceQuantity:
number()
Title:
Price QuantityQuantity used for pricing -
purchaseDate:
string()
Title:
Purchase DateDate of purchase -
quantity:
number()
Title:
QuantityQuantity of the asset -
ratePlanNumber:
string()
Title:
Rate Plan NumberNumber of the rate plan -
registeredDate:
string()
Title:
Registered DateDate of registration -
resumeDate:
string()
Title:
Resume DateDate of resumption -
rootAsset:
Root Asset
Title:
Root AssetRead Only:trueRoot asset object -
rootAssetId:
integer()
Title:
Root Asset IDID of the root asset -
rootAssetKey:
string()
Title:
Root Asset KeyKey of the root asset -
salesProductType:
string()
Title:
Sales Product TypeType of sales product -
serviceAccount:
string()
Title:
Service Account ReferenceReference to the service account -
serviceAddress:
string()
Title:
Service Address ReferenceReference to the service address -
shipToParty:
string()
Title:
Ship To Party ReferenceReference to the ship-to party -
shipToPartyName:
string()
Title:
Ship To Party NameName of the ship-to party -
shipToPartySite:
string()
Title:
Ship To Party Site ReferenceReference to the ship-to party site -
soldToCustAcct:
string()
Title:
Sold To Customer Account ReferenceReference to the sold-to customer account -
soldToParty:
string()
Title:
Sold To Party ReferenceReference to the sold-to party -
soldToPartyName:
string()
Title:
Sold To Party NameName of the sold-to party -
soldToPartySite:
string()
Title:
Sold To Party Site ReferenceReference to the sold-to party site -
sourceSystem:
string()
Title:
Source SystemSource system of the asset -
startDate:
string()
Title:
Start DateStart date of the asset -
status:
Status
Title:
StatusRead Only:trueStatus of the asset -
statusCode:
string()
Title:
Status CodeCode representing the status -
subscriptionFulfillmentLineId:
string()
Title:
Subscription Fulfillment Line IDID of the subscription fulfillment line -
subscriptionNumber:
string()
Title:
Subscription NumberNumber of the subscription -
subscriptionProductPuid:
string()
Title:
Subscription Product PUIDPUID of the subscription product -
suspendDate:
string()
Title:
Suspend DateDate when the asset was suspended -
totalAssetAmount:
Total Asset Amount
Title:
Total Asset AmountTotal amount for the asset -
totalContractValue:
Total Contract Value
Title:
Total Contract ValueThe total contract value of the asset including all one-time and recurring charges -
uomCode:
string()
Title:
UOM CodeUnit of measure code -
usageNetAmt:
Usage Net Amount
Title:
Usage Net AmountNet amount for usage -
usageUomCode:
string()
Title:
Usage UOM CodeUnit of measure code for usage -
warrantyEnd:
string()
Title:
Warranty EndEnd date of warranty -
warrantyStart:
string()
Title:
Warranty StartStart date of warranty
Nested Schema : Asset Charges
Title:
Asset ChargesRead Only:
trueCollection of asset charges
Match All
Collection of asset charges
Show Source
Nested Schema : Discount Amount
Title:
Discount AmountAmount of discount applied
Match All
Amount of discount applied
Show Source
Nested Schema : Fixed Recurring Amount
Title:
Fixed Recurring AmountFixed recurring amount for the asset
Match All
Fixed recurring amount for the asset
Show Source
Nested Schema : Asset Instances
Title:
Asset InstancesRead Only:
trueCollection of asset instances
Match All
Collection of asset instances
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : One Time Net Amount
Title:
One Time Net AmountOne-time net amount for the asset
Match All
One-time net amount for the asset
Show Source
Nested Schema : Parent Asset
Title:
Parent AssetRead Only:
trueParent asset object
Match All
Parent asset object
Show Source
Nested Schema : Root Asset
Title:
Root AssetRead Only:
trueRoot asset object
Match All
Root asset object
Show Source
Nested Schema : Status
Title:
StatusRead Only:
trueStatus of the asset
Match All
Status of the asset
Show Source
Nested Schema : Total Asset Amount
Title:
Total Asset AmountTotal amount for the asset
Match All
Total amount for the asset
Show Source
Nested Schema : Total Contract Value
Title:
Total Contract ValueThe total contract value of the asset including all one-time and recurring charges
Match All
The total contract value of the asset including all one-time and recurring charges
Show Source
Nested Schema : Usage Net Amount
Title:
Usage Net AmountNet amount for usage
Match All
Net amount for usage
Show Source
Nested Schema : ResponseCollectionModel_assetChargeBean
Type:
Show Source
object-
count:
integer()
Title:
CountRead Only:trueThe number of resource instances returned in the current range. -
hasMore:
boolean()
Title:
HasMoreRead Only:trueIndicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
limit:
integer()
Title:
LimitRead Only:trueThe actual paging size used by the server. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
offset:
integer()
Title:
OffSetRead Only:trueThe offset value used in the current page. -
totalResults:
integer()
Title:
Total ResultsRead Only:trueCaptures 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 : Links
Type:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : assetChargeBean
Type:
Show Source
object-
applyTo:
string()
Title:
Apply ToIndicates what this charge applies to -
assetKey:
string()
Title:
Asset Key -
chargeDefIntegrationId:
string()
Title:
Charge Definition Integration IdThe charge definition code in the integrated order management system -
chargeName:
string()
Title:
Charge NameName of the charge -
chargeSequenceNumber:
integer(int64)
-
chargeTypeCode(required):
string()
Title:
Charge Type Code -
contractDiscountAmount:
Contract Discount Amount
Title:
Contract Discount AmountDiscount amount based on contract -
contractListAmount:
Contract List Amount
Title:
Contract List AmountList amount based on contract -
contractNetAmount:
Contract Net Amount
Title:
Contract Net AmountNet amount based on contract -
customDiscountAmount:
Custom Discount Amount
Title:
Custom Discount AmountAmount of custom discount -
customDiscountType:
string()
Title:
Custom Discount TypeType of custom discount applied -
dateAdded:
string()
Title:
Date AddedRead Only:trueLast modified date of Asset Charge Bean. -
dateModified:
string()
Title:
Date ModifiedRead Only:trueCreation date of the Asset Charge Bean. -
dynamicPricingType:
string()
Title:
Dynamic Pricing TypeType of dynamic pricing -
extendedDiscountAmount:
Extended Discount Amount
Title:
Extended Discount AmountTotal extended discount amount -
id:
integer()
Title:
idRead Only:true -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
listAmount:
List Amount
Title:
List AmountThe list amount for this charge -
netAmount:
Net Amount
Title:
Net AmountTotal net amount -
netPrice:
Net Price
Title:
Net PricePrice after applying discounts -
pricePeriodCode:
string()
Title:
Price Period CodeCode representing the pricing period -
priceTypeCode(required):
string()
Title:
Price Type Code -
priceUom:
string()
Title:
Price UOMUnit of measure for the price -
primaryFlag:
boolean()
Title:
Primary FlagIndicates if this is the primary charge. -
rateCardStructure:
string()
Title:
Rate Card StructureStructure of the rate card -
unitPrice:
Unit Price
Title:
Unit PricePrice per unit
Nested Schema : Contract Discount Amount
Title:
Contract Discount AmountDiscount amount based on contract
Match All
Discount amount based on contract
Show Source
Nested Schema : Contract List Amount
Title:
Contract List AmountList amount based on contract
Match All
List amount based on contract
Show Source
Nested Schema : Contract Net Amount
Title:
Contract Net AmountNet amount based on contract
Match All
Net amount based on contract
Show Source
Nested Schema : Custom Discount Amount
Title:
Custom Discount AmountAmount of custom discount
Match All
Amount of custom discount
Show Source
Nested Schema : Extended Discount Amount
Title:
Extended Discount AmountTotal extended discount amount
Match All
Total extended discount amount
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : List Amount
Title:
List AmountThe list amount for this charge
Match All
The list amount for this charge
Show Source
Nested Schema : Net Amount
Title:
Net AmountTotal net amount
Match All
Total net amount
Show Source
Nested Schema : Net Price
Title:
Net PricePrice after applying discounts
Match All
Price after applying discounts
Show Source
Nested Schema : amountBean
Type:
Show Source
object-
amount:
number()
Title:
AmountAmount -
currencyCode:
string()
Title:
Currency CodeCurrency Code
Nested Schema : ResponseCollectionModel_assetInstanceBean
Type:
Show Source
object-
count:
integer()
Title:
CountRead Only:trueThe number of resource instances returned in the current range. -
hasMore:
boolean()
Title:
HasMoreRead Only:trueIndicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
limit:
integer()
Title:
LimitRead Only:trueThe actual paging size used by the server. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
offset:
integer()
Title:
OffSetRead Only:trueThe offset value used in the current page. -
totalResults:
integer()
Title:
Total ResultsRead Only:trueCaptures 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 : Links
Type:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : assetInstanceBean
Type:
Show Source
object-
assetKey:
string()
Title:
Asset Key -
dateAdded:
string()
Title:
Date AddedRead Only:trueLast modified date of Asset Instance Bean. -
dateModified:
string()
Title:
Date ModifiedRead Only:trueCreation date of the Asset Instance Bean. -
extAssetRef:
string()
Title:
External Asset Ref -
fulfilmentId:
string()
Title:
Fulfilment Id -
id:
integer()
Title:
idRead Only:trueid -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
lotNumber:
string()
Title:
Lot Number -
parExtAssetRef:
string()
Title:
Parent External Asset Ref -
quantity:
number()
Title:
Quantity -
rootExtAssetRef:
string()
Title:
Root External Asset Ref -
serialNumber:
string()
Title:
Serial Number
Nested Schema : Links
Type:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : assetObjBean
Type:
Show Source
object-
assetKey:
string()
Title:
Object Asset KeyObject Asset Key -
id:
integer()
Title:
Object IdObject Id
Nested Schema : lookupBean
Type:
Show Source
object-
displayValue:
string()
Title:
Display ValueDisplayValue -
id:
integer()
Title:
IdLookup Id -
lookupCode:
string()
Title:
Lookup CodeLookup Code
Examples
The following example shows how to returns asset data for the specific asset by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/assets/51562170
Response Body Sample
{
"id": 51562170,
"assetKey": "abo_b4c7f396-b17f-4c55-b0c6-efdc03de1e81",
"parentAssetId": 51562171,
"rootAssetId": 51562172,
"assetDescription": "SolarPanel1301",
"bomItemId": "BOM_965e7b77f77a6cbc6d8c2a5c4f342ac39be9f36e92db514d24afa7b8d24c98ce",
"discountAmount": {
"amount": 0.0,
"currencyCode": "USD"
},
"discountPercent": 0.0,
"displayKey": "SolarPanel1301-51537897-5",
"endDate": "2028-08-23T04:54:21Z",
"partNumber": "SolarPanel1301",
"quantity": 10.0,
"totalAssetAmount": {
"amount": 0.0,
"currencyCode": "USD"
},
"priceQuantity": 10.0,
"startDate": "2025-08-24T04:54:21Z",
"status": {
"id": 36341498,
"lookupCode": "ACTIVE",
"displayValue": "Active"
},
"soldToPartyName": "Computer Service and Rentals",
"billToAddress": "301 Summit Hill Drive",
"partDisplayNumber": "SolarPanel1301",
"totalContractValue": {
"amount": 0,
"currencyCode": "USD"
},
"billToAccountId": "1006",
"businessUnitId": "204",
"billToAccountName": "Computer Service and Rentals",
"shipToPartyName": "Computer Service and Rentals",
"contractedPeriods": 1,
"salesProductType": "GOODS",
"assetInstanceTracked": false,
"originalAssetKey": "abo_b4c7f396-b17f-4c55-b0c6-efdc03de1e81",
"inventoryItemId": "300100592828797",
"inventoryOrgId": "204",
"fulfilledQuantity": 0,
"cancelledQuantity": 0,
"goodsQuoteLineId": "51537897~5",
"orderLineId": "300100647971731",
"competitiveAsset": "N",
"orderNumber": "522066",
"assetProductType": "goods",
"originalRootAssetKey": "abo_1a75c455-6cbe-466a-ab36-e7f5f056c064",
"hasPendingOrder": false,
"dateModified": "2025-08-26T15:04:46Z",
"dateAdded": "2025-08-26T04:55:55Z",
"parentAssetKey": "abo_0f51535f-b5c6-4fa5-9100-f96975ae0242",
"rootAssetKey": "abo_1a75c455-6cbe-466a-ab36-e7f5f056c064",
"parentAsset": {
"id": 51562171,
"assetKey": "abo_0f51535f-b5c6-4fa5-9100-f96975ae0242"
},
"rootAsset": {
"id": 51562172,
"assetKey": "abo_1a75c455-6cbe-466a-ab36-e7f5f056c064"
},
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/assets/51562170"
}, {
"rel": "parent",
"href": "https://sitename.oracle.com/rest/v19/assets"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/assets/51562170/charges"
}
],
"attributes": "{}",
"currency": "USD",
"customer": "1006",
"fixedRecurringAmount": {
"amount": 0.0,
"currencyCode": "USD"
},
"oneTimeNetAmount": {
"amount": 0.0,
"currencyCode": "USD"
},
"usageNetAmount": {
"amount": 0.0,
"currencyCode": "USD"
},
"statusCode": "ACTIVE",
"soldToParty": "1006",
"soldToPartySite": "1034",
"soldToCustAcct": "1006",
"billToParty": "1006",
"billToSiteUse": "1025",
"shipToParty": "1006",
"shipToPartySite": "1222",
"fulfillmentSourceSystem": "FOM"
}