Asset REST APIs

Get All Assets
Description	This operation returns data for all assets.
URI Endpoint	/rest/v17/assets
Endpoint Parameters	None
	This endpoint supports query specifications that follow Oracle CPQ query and pagination parameters syntax. Query specifications follow a subset of MongoDB syntax and can be used to organize or narrow return data. For more information, see Manage Collections. Asset "attributes" can not be used as a parameter in search or sort query specifications.
HTTP Method	GET
Request Body Parameters	None (nothing should be in the request body)
Response Body Parameters	A collection of asset items. Returns all attributes from the asset object in JSON format. Returns Currency and Foreign Key (FK) attributes as complex attributes. Refer to the Create Asset REST API for a sample complex attribute.

URI Endpoint Sample

Get Asset
Description	This returns asset data for a specific asset.
URI Endpoint	/rest/v17/assets/{id}
Endpoint Parameters	{id}	The unique ID of the Asset
	expand	Allows expansion of relationships.
	This endpoint supports query specifications that follow Oracle CPQ query and pagination parameters syntax. Query specifications follow a subset of MongoDB syntax and can be used to organize or narrow return data. For more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data of the asset Returns all attributes from the asset object in JSON format. Returns Currency and Foreign Key (FK) attributes as complex attributes. Refer to the Create Asset REST API for a sample complex attribute.

URI Endpoint Sample

Get Child Assets
Description	This operation retrieves all direct child assets of the specified asset.
URI Endpoint	/rest/v17/assets/{id}/childAssets
Endpoint Parameters	{id}	The unique ID of the Asset
	This endpoint supports query specifications that follow Oracle CPQ query and pagination parameters syntax. Query specifications follow a subset of MongoDB syntax and can be used to organize or narrow return data. For more information, see Manage Collections. Asset "attributes" can not be used as a parameter in search or sort query specifications.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data of the child assets Returns all attributes from the asset object in JSON format. Returns Currency and Foreign Key (FK) attributes as complex attributes. Refer to the Create Asset REST API for a sample complex attribute.

URI Endpoint Sample

Get Descendant Assets
Description	This operation retrieves all descendant assets of the specified asset.
URI Endpoint	/rest/v17/assets/{id}/descendantAssets
Endpoint Parameters	{id}	The unique ID of the Asset
	This endpoint supports query specifications that follow Oracle CPQ query and pagination parameters syntax. Query specifications follow a subset of MongoDB syntax and can be used to organize or narrow return data. For more information, see Manage Collections. Asset "attributes" can not be used as a parameter in search or sort query specifications.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data of the descendant assets Returns all attributes from the asset object in JSON format. Returns Currency and Foreign Key (FK) attributes as complex attributes. Refer to the Create Asset REST API for a sample complex attribute.

URI Endpoint Sample

Create Asset
Description	This operation creates a new asset. Asset Schema and Data Integrity You should adhere to the following guidelines to ensure proper asset population. These guidelines are applicable to the following REST API endpoints: Create Asset, Update Asset, Synchronize Asset, Synchronize Assets, and Import Assets CSV File. This does not include the BOM projection approach in the sample update asset script. The REST API schema definitions specify the basic attribute type (e.g. string, integer, number). The following guidelines describe additional requirements: The acceptable length for string type attributes is 255, with the exception of the following attributes: The acceptable length for the following attributes is 100: assetKey, displayKey, serialNumber The acceptable length for the following attributes is 30: status, usageUnitOfMeasure, fixedRecurringPeriod. The acceptable length for the "currency" attribute is 20. The acceptable length for the "assetDescription" attribute is 1000. The default format for the following of timestamp type attributes is ISO to eliminate any time zone ambiguity issues: startDate, endDate, suspendDate, resumeDate, purchaseDate. Unless noted otherwise, number type attributes allow 22 digits with a precision or 7. The following attributes are mandatory fields that should be populated with valid data: "Customer", "DisplayKey", "Part", and "Quantity". Populate the "rootAsset" and "parentAsset" fields based on hierarchy. Both fields should reference a valid asset. The parent asset should be null for the root asset record. For example, assume A2 has A1 as a parent and A1 has A3 as a parent, therefore A2 would have A3 as a grandparent. It would be invalid for A3 to have A2 as a parent, because it would create a cycle in the hierarchy where A3 has A1 as a grandparent and A3 has A3 as a great grandparent. Use the "assetKey" component fields to update the "rootAsset" and "parentAsset" fields. The parent asset cannot be its own ancestor. All amount attributes should have the same currency code. The "attributes" field should contain a JSON object which typically stores a BOM attribute. The parent asset cannot be its own ancestor. If an order line is marked as deleted, use the asset repository to delete or end-date the asset. With the exception of the action code available in the transaction_line_bom_attribute, the Attributes field should contain the same information as the transaction_line_bom_attribute. The abo_updateAsset function available in the 18D and later ABO package supports the ability to copy information from a Commerce order line and paste it into an asset. If ABO implementation package from 18D or later release is being used and abo_updateAsset is not being used to create/update assets, then Update Configuration REST API action should be invoked explicitly after asset creation or update.
URI Endpoint	/rest/v17/assets
Endpoint Parameters	None
HTTP Method	POST
Response Body Parameters	JSON data for the new asset is created. Returns all attributes from the asset object in JSON format. Returns Currency and Foreign Key (FK) attributes as complex attributes. Refer to the Create Asset REST API for a sample complex attribute.

URI Endpoint Sample

Sample Request Body

URI Endpoint Sample

Request Sample

Response Sample

URI Endpoint Sample

Internal Order Using Asset Keys

External Order using Selections

Renew Asset
Description	This operation merges a renew request with the projected asset for the requested date, and then stores the results to a Configuration BOM Instance. For renew requests, the root and subordinate action codes are set to Renew.
URI Endpoint	/rest/v17/assets/{id}/actions/renew
Endpoint Parameters	id	The asset ID
HTTP Method	POST
Request Parameters	transactionId	Optional, used for external process integrations The current Transaction identifier
	transactionDate	The date and time that the service request needs to be processed or fulfilled.
	sourceIdentifier	The identifier for the integration process When this parameter is not specified, the default value is "_external_order"
Response Parameters	lineId	The Configuration ID for the Configuration BOM Instance

URI Endpoint Sample

Sample Request Body

Sample Response Body

{ "result": { "lineId": "36562570" } }

URI Endpoint Sample

Internal Order Using Asset Keys

External Order using Selections

Resume Asset
Description	This operation merges a resume request with the projected asset for the requested date, and then stores the results to a Configuration BOM Instance. For resume requests, the root and subordinate action codes are set to Resume.
URI Endpoint	/rest/v17/assets/{id}/actions/resume
Endpoint Parameters	id	The asset ID
HTTP Method	POST
Request Parameters	transactionId	Optional, used for external process integrations The current Transaction identifier
	transactionDate	The date and time that the service request needs to be processed or fulfilled.
	sourceIdentifier	The identifier for the integration process When this parameter is not specified, the default value is "_external_order"
Response Parameters	lineId	The Configuration ID for the Configuration BOM Instance

URI Endpoint Sample

Sample Request Body

Sample Response Body

{ "result": { "lineId": "36562557" } }

URI Endpoint Sample

Internal Order Using Asset Keys

External Order using Selections

URI Endpoint Sample

Sample Request Body

Sample Response Body

{ "result": { "lineId": "36562556" } }

URI Endpoint Sample

Internal Order Using Asset Keys

External Order using Selections

Synchronize Assets
Description	This operation invokes a Synchronize action using the payload to edit the hierarchy contents. Asset Schema and Data Integrity You should adhere to the following guidelines to ensure proper asset population. These guidelines are applicable to the following REST API endpoints: Create Asset, Update Asset, Synchronize Asset, Synchronize Assets, and Import Assets CSV File. This does not include the BOM projection approach in the sample update asset script. The REST API schema definitions specify the basic attribute type (e.g. string, integer, number). The following guidelines describe additional requirements: The acceptable length for string type attributes is 255, with the exception of the following attributes: The acceptable length for the following attributes is 100: assetKey, displayKey, serialNumber The acceptable length for the following attributes is 30: status, usageUnitOfMeasure, fixedRecurringPeriod. The acceptable length for the "currency" attribute is 20. The acceptable length for the "assetDescription" attribute is 1000. The default format for the following of timestamp type attributes is ISO to eliminate any time zone ambiguity issues: startDate, endDate, suspendDate, resumeDate, purchaseDate. Unless noted otherwise, number type attributes allow 22 digits with a precision or 7. The following attributes are mandatory fields that should be populated with valid data: "Customer", "DisplayKey", "Part", and "Quantity". Populate the "rootAsset" and "parentAsset" fields based on hierarchy. Both fields should reference a valid asset. The parent asset should be null for the root asset record. For example, assume A2 has A1 as a parent and A1 has A3 as a parent, therefore A2 would have A3 as a grandparent. It would be invalid for A3 to have A2 as a parent, because it would create a cycle in the hierarchy where A3 has A1 as a grandparent and A3 has A3 as a great grandparent. Use the "assetKey" component fields to update the "rootAsset" and "parentAsset" fields. The parent asset cannot be its own ancestor. All amount attributes should have the same currency code. The "attributes" field should contain a JSON object which typically stores a BOM attribute. The parent asset cannot be its own ancestor. If an order line is marked as deleted, use the asset repository to delete or end-date the asset. With the exception of the action code available in the transaction_line_bom_attribute, the Attributes field should contain the same information as the transaction_line_bom_attribute. The abo_updateAsset function available in the 18D and later ABO package supports the ability to copy information from a Commerce order line and paste it into an asset. If ABO implementation package from 18D or later release is being used and abo_updateAsset is not being used to create/update assets, then Update Configuration REST API action should be invoked explicitly after asset creation or update.
URI Endpoint	/rest/v17/assets/actions/synchronize
Request Body Parameters	documents	Type: JSON Holds a row or collection. Each row can include an optional _sync_action operation parameter.
	_client_driven_action	Type: Boolean Enables apply changes instead of replacing the target asset object. Currently this parameter must be set to "true".
Response Body Parameters	documents	Type: JSON Holds a row or collection. Each row can include an optional _sync_status operation parameter.
HTTP Method	POST
Success Response	The JSON data for the asset object that was updated When updating a collection, utilize the user key to refer to the target asset row. The _sync_action parameter supports add, modify, and delete values. The _sync_status parameter values include created and updated. The optional _proxy_id parameter, added to each row in the input payload, enables parameter cross references. When present, the value for each row must be unique. When the _proxy_id parameter is present in the row inserted, the corresponding row data in the response will have the same _proxy_id value. The _proxy_id parameter is typically used when the caller of the Synchronize API wants to keep track of the real Asset ID created and use it for further processing at a later time. The response payload does not include deleted objects.

Sample Request Body

Sample Response Body

{ "documents": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/assets" } ], "items": [{ "_sync_status": "created", "fixedRecurringAmount": null, "endDate": null, "rootAsset": { "id": 3022895555, "assetKey": "abo_821aded1-d789-4ec6-8364-9a59e9db33ed", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/assets" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555" } ] }, "discountAmount": { "value": 0, "currency": "USD" }, "warrantyEndDate": null, "billingAccount": null, "dateAdded": "2022-10-27T18:51:36.713Z", "assetKey": "abo_821aded1-d789-4ec6-8364-9a59e9db33ed", "parentBomItemId": null, "warrantyStartDate": null, "lastUserUpdateDate": "2022-10-27T18:51:36.713Z", "id": 3022895555, "oneTimeNetAmount": { "value": 0, "currency": "USD" }, "usageNetAmount": null, "serialNumber": null, "lastSyncDate": null, "assetDescription": null, "usageUnitOfMeasure": null, "suspendDate": null, "contractReference": null, "parentAsset": null, "paymentTerm": "", "syncStatus": null, "startDate": "2022-10-25T00:00:00.000Z", "resumeDate": null, "status": { "lookupCode": "ACTIVE", "displayValue": "Active", "id": 18325665, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_ASSET_STATUS_CODE%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/18325665" } ] }, "displayKey": "testbed:systemConfiguration:rootSystem-3023084779-1", "rootDisplay": null, "purchaseDate": null, "registeredDate": null, "fixedRecurringPeriod": null, "modelPath": "testbed:systemConfiguration:rootSystem", "installDate": null, "billingProfile": null, "currency": { "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/currencies/USD" } ] }, "discountPercent": 0, "quantity": 1, "serviceAddress": null, "dateModified": "2022-10-27T18:51:36.713Z", "serviceAccount": null, "totalAssetAmount": null, "rootPartNumber": null, "bomItemId": "BOM_SysConfigRoot", "parentPartNumber": null, "origTransactionId": null, "partDescription": null, "parentDisplay": null, "partNumber": "SysConfigRoot", "attributes": {}, "customer": "account112", "descendantAssets": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets" } ], "items": [{ "_sync_status": "created", "fixedRecurringAmount": null, "endDate": null, "rootAsset": { "id": 3022895555, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/assets" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555" } ] }, "discountAmount": { "value": 0, "currency": "USD" }, "warrantyEndDate": null, "billingAccount": null, "dateAdded": "2022-10-27T18:51:36.906Z", "assetKey": "abo_d0193e89-1fc5-48eb-9e5c-37b64006136d", "parentBomItemId": null, "warrantyStartDate": null, "lastUserUpdateDate": "2022-10-27T18:51:36.906Z", "id": 3022895556, "oneTimeNetAmount": { "value": 10, "currency": "USD" }, "usageNetAmount": null, "serialNumber": null, "lastSyncDate": null, "assetDescription": null, "usageUnitOfMeasure": null, "suspendDate": null, "contractReference": null, "parentAsset": { "assetKey": "abo_821aded1-d789-4ec6-8364-9a59e9db33ed", "id": 3022895555, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/assets" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555" } ] }, "paymentTerm": "", "syncStatus": null, "startDate": null, "resumeDate": null, "status": null, "displayKey": "SCNestRoot-3023084779-2", "rootDisplay": null, "purchaseDate": null, "registeredDate": null, "fixedRecurringPeriod": null, "modelPath": null, "installDate": null, "billingProfile": null, "currency": { "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/currencies/USD" } ] }, "discountPercent": 0, "quantity": 1, "serviceAddress": null, "dateModified": "2022-10-27T18:51:36.906Z", "serviceAccount": null, "totalAssetAmount": null, "rootPartNumber": null, "bomItemId": "BOM_SCNestPrime", "parentPartNumber": null, "origTransactionId": null, "partDescription": null, "parentDisplay": null, "partNumber": "SCNestRoot", "attributes": {}, "customer": "account112", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895556" }, { "kind": "", "rel": "child", "name": "childAssets", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895556/childAssets" }, { "kind": "", "rel": "child", "name": "descendantAssets", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895556/descendantAssets" } ] }, { "_sync_status": "created", "fixedRecurringAmount": null, "endDate": null, "rootAsset": { "id": 3022895555, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/assets" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555" } ] }, "discountAmount": { "value": 0, "currency": "USD" }, "warrantyEndDate": null, "billingAccount": null, "dateAdded": "2022-10-27T18:51:36.938Z", "assetKey": "abo_68f4601d-efe4-4212-9c2a-5d1a5349a919", "parentBomItemId": null, "warrantyStartDate": null, "lastUserUpdateDate": "2022-10-27T18:51:36.938Z", "id": 3022895557, "oneTimeNetAmount": { "value": 0, "currency": "USD" }, "usageNetAmount": null, "serialNumber": null, "lastSyncDate": null, "assetDescription": null, "usageUnitOfMeasure": null, "suspendDate": null, "contractReference": null, "parentAsset": { "assetKey": "abo_d0193e89-1fc5-48eb-9e5c-37b64006136d", "id": 3022895556, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/assets" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/assets/3022895556" } ] }, "paymentTerm": "", "syncStatus": null, "startDate": null, "resumeDate": null, "status": null, "displayKey": "DiffConfigRoot-3023084779-3", "rootDisplay": null, "purchaseDate": null, "registeredDate": null, "fixedRecurringPeriod": null, "modelPath": null, "installDate": null, "billingProfile": null, "currency": { "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/currencies/USD" } ] }, "discountPercent": 0, "quantity": 3, "serviceAddress": null, "dateModified": "2022-10-27T18:51:36.938Z", "serviceAccount": null, "totalAssetAmount": null, "rootPartNumber": null, "bomItemId": "BOM_diffConfigRoot", "parentPartNumber": null, "origTransactionId": null, "partDescription": null, "parentDisplay": null, "partNumber": "DiffConfigRoot", "attributes": { "Rate": { "value": "Only" }, "Persistent": { "value": "false" } }, "customer": "account112", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895557" }, { "kind": "", "rel": "child", "name": "childAssets", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895557/childAssets" }, { "kind": "", "rel": "child", "name": "descendantAssets", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895557/descendantAssets" } ] }, { "_sync_status": "created", "fixedRecurringAmount": null, "endDate": null, "rootAsset": { "id": 3022895555, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/assets" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555" } ] }, "discountAmount": { "value": 0, "currency": "USD" }, "warrantyEndDate": null, "billingAccount": null, "dateAdded": "2022-10-27T18:51:36.966Z", "assetKey": "abo_eac2ec1f-cdcf-4832-b560-5125577a9de5", "parentBomItemId": null, "warrantyStartDate": null, "lastUserUpdateDate": "2022-10-27T18:51:36.966Z", "id": 3022895558, "oneTimeNetAmount": { "value": 300, "currency": "USD" }, "usageNetAmount": null, "serialNumber": null, "lastSyncDate": null, "assetDescription": null, "usageUnitOfMeasure": null, "suspendDate": null, "contractReference": null, "parentAsset": { "assetKey": "abo_68f4601d-efe4-4212-9c2a-5d1a5349a919", "id": 3022895557, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/assets" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/assets/3022895557" } ] }, "paymentTerm": "", "syncStatus": null, "startDate": null, "resumeDate": null, "status": null, "displayKey": "SCNestReplaceKid1-3023084779-4", "rootDisplay": null, "purchaseDate": null, "registeredDate": null, "fixedRecurringPeriod": null, "modelPath": null, "installDate": null, "billingProfile": null, "currency": { "currencyCode": "USD", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/currencies" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/currencies/USD" } ] }, "discountPercent": 0, "quantity": 1, "serviceAddress": null, "dateModified": "2022-10-27T18:51:36.966Z", "serviceAccount": null, "totalAssetAmount": null, "rootPartNumber": null, "bomItemId": "BOM_diffConfigKid1", "parentPartNumber": null, "origTransactionId": null, "partDescription": null, "parentDisplay": null, "partNumber": "SCNestReplaceKid1", "attributes": { "Rate": { "value": "Only" }, "Persistent": { "value": "false" } }, "customer": "account112", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895558" }, { "kind": "", "rel": "child", "name": "childAssets", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895558/childAssets" }, { "kind": "", "rel": "child", "name": "descendantAssets", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/descendantAssets/3022895558/descendantAssets" } ] } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555" }, { "kind": "", "rel": "child", "name": "childAssets", "href": "https://sitename.oracle.com/rest/v17/assets/3022895555/childAssets" } ] } ] } }

URI Endpoint Sample

Request Sample

Response Sample

{ "result": { "lineId": "36562556" } }

URI Endpoint Sample

Internal Order Using Asset Keys

External Order using Selections

Update Asset
Description	This operation updates an existing asset. Asset Schema and Data Integrity You should adhere to the following guidelines to ensure proper asset population. These guidelines are applicable to the following REST API endpoints: Create Asset, Update Asset, Synchronize Asset, Synchronize Assets, and Import Assets CSV File. This does not include the BOM projection approach in the sample update asset script. The REST API schema definitions specify the basic attribute type (e.g. string, integer, number). The following guidelines describe additional requirements: The acceptable length for string type attributes is 255, with the exception of the following attributes: The acceptable length for the following attributes is 100: assetKey, displayKey, serialNumber The acceptable length for the following attributes is 30: status, usageUnitOfMeasure, fixedRecurringPeriod. The acceptable length for the "currency" attribute is 20. The acceptable length for the "assetDescription" attribute is 1000. The default format for the following of timestamp type attributes is ISO to eliminate any time zone ambiguity issues: startDate, endDate, suspendDate, resumeDate, purchaseDate. Unless noted otherwise, number type attributes allow 22 digits with a precision or 7. The following attributes are mandatory fields that should be populated with valid data: "Customer", "DisplayKey", "Part", and "Quantity". Populate the "rootAsset" and "parentAsset" fields based on hierarchy. Both fields should reference a valid asset. The parent asset should be null for the root asset record. For example, assume A2 has A1 as a parent and A1 has A3 as a parent, therefore A2 would have A3 as a grandparent. It would be invalid for A3 to have A2 as a parent, because it would create a cycle in the hierarchy where A3 has A1 as a grandparent and A3 has A3 as a great grandparent. Use the "assetKey" component fields to update the "rootAsset" and "parentAsset" fields. The parent asset cannot be its own ancestor. All amount attributes should have the same currency code. The "attributes" field should contain a JSON object which typically stores a BOM attribute. The parent asset cannot be its own ancestor. If an order line is marked as deleted, use the asset repository to delete or end-date the asset. With the exception of the action code available in the transaction_line_bom_attribute, the Attributes field should contain the same information as the transaction_line_bom_attribute. The abo_updateAsset function available in the 18D and later ABO package supports the ability to copy information from a Commerce order line and paste it into an asset. If ABO implementation package from 18D or later release is being used and abo_updateAsset is not being used to create/update assets, then Update Configuration REST API action should be invoked explicitly after asset creation or update.
URI Endpoint	/rest/v17/assets/{id}
Endpoint Parameters	{id}	The unique ID of the Asset to update
HTTP Method	POST
Response Body Parameters	Creation of the JSON data for the updated asset.

Sample Request Body

{ "partNumber": "part1", "quantity": "1.0", "displayKey": "display-100-2-1234", "customer": "SpecialAccount100", "assetKey": "abo_ae100", "discountPercent": "5.0", "discountAmount": { "currency": "USD", "value": 15.0 }, "currency": { "currencyCode": "USD" }, "fixedRecurringAmount": { "currency": "USD", "value": 50.00 }, "oneTimeNetAmount": { "currency": "USD", "value": 300.00 } }

Update Configuration
Description	This operation gathers a projection of all involved configuration attributes from open order lines related to an asset and updates the internal configuration on the root asset.
URI Endpoint	/rest/v17/assets/actions/updateConfiguration
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	assetList	An array of assets to update.
	assetKey	Asset key value
	orderLines	An array of order lines to update Notes: Oracle CPQ recommends grouping all Order Lines related to same asset under single entry in Asset List The order of entries in "orderLines" array dictates the order projections are made and attribute deltas will be applied in this order.
	™ type	Order type identifier: (internalOrder or externalOrder)
	™ _bs_id	The Oracle CPQ transaction ID.
		Required for internal orders ("type": "internalOrder")
	™ _document_number	The main document or sub-document number. For Transaction Lines, this represents the numerical order in which each line item was created.
		Required for internal orders ("type": "internalOrder")
	™ configId	The Configuration Id for the Configuration BOM Instance
		Required for external orders ("type": "externalOrder")
Response Body Parameters	For successful updates, nothing is returned in the response body. If an error occurs, none of the assets are updated and an error message is returned. The error message contains information for the first asset causing the failure.

URI Endpoint Sample

Sample Request Body

{ "assetList": [{ "assetKey": "abo_c2874186-3714-4eb3-a339-c9fe696d471d", "orderLines": [{ "type": "internalOrder", "_bs_id": 19621776, "_document_number": 10 }, { "type": "internalOrder", "_bs_id": 19621776, "_document_number": 21 }, ..., { "type": "internalOrder", "_bs_id": 19621776, "_document_number": 25 } ] }, ...{ "assetKey": "abo_c2874186-3714-4eb3-a339-c9fe696d4712", "orderLines": [{ "type": "externalOrder", "configId": 20972643 }, { "type": "externalOrder", "configId": 20973645 }, ..., { "type": "externalOrder", "configId": 20972848 } ] }, ...] }

Search Projected Assets by Customer
Description	This REST API call provides a consolidated list of fulfilled and pending order asset lines in a hierarchical list for a specific customer. In addition, users can perform search and sort operations on the consolidated list of projected assets.
URI Endpoint	/rest/v17/projectedAssets/actions/search
HTTP Method	POST
Request Body Parameters	customerId	The variable name for the account or customer ID number
	sourceIdentifier	The identifier for the Commerce process. The variable name of the Commerce process (e.g. oraclecpqo)
	criteria	(Optional) Administrators can provide criteria parameters in the request body to retrieve specific content and limit the size of the response. For example: enableHierarchy – true/false (default is false for root only query) offset – default is 0 limit – default is 1000 fields – resource fields (assetKey, rootAssetKey and id are always returned) state – true (false is not valid) orderby - attributes supported are id, assetKey, partNumber, lineId, serviceId, and transactionId (string based) Notes: Oracle CPQ recommends grouping all Order Lines related to same asset under single entry in Asset List The order of entries in "orderLines" array dictates the order projections are made and attribute deltas will be applied in this order.
	This endpoint supports the standard query specification expression, except for the totalResults and expand/collapse. For more information, see Query Specification Syntax. Note: This endpoint does not support the following query parameter attributes: quantity sourceIdentifier customerId numberOfOpenOrders
Response Body Parameters	The JSON data for the specified customer projected assets.

URI Endpoint Sample

Sample Request Body

Sample Response Body

NOTES:

• This service can be used to return root asset only (enableHierarchy=false) or asset tree (enableHierarchy=true). By default the server processes a maximum of 100,000 rows for all assets and in addition a maximum of 100 root rows for the tree search. When the results exceed the server limits, the state parameter includes a warning in the response.

• The Commerce process assetkey (instanceid_l) data column must be indexed.

• If upgrading to 21D and an ABO Commerce process is already implemented, you must repopulate the data column if there are any pending fulfilled transaction lines already in the Commerce process.
• The search and sort behavior when enableHierarchy=true is very similar to the Transaction Line hierarchical search and sort. The result line returns in a flat list with children following their parent. Only results that match the specified criteria are returned and non-matching results for those parent/child items are not provided in the result. The sort feature takes into account parent/child relationship but does not sort between children of different parents.
• The search results take into account the information available in the database and from a memory search of merged data of the projected assets. With this in mind, the child component of the search/sort will always match the specified criteria; however, a root line search/sort can only guarantee to match the criteria from the database query.

  Due to the nature of combination of database search and in-memory search, there could be differences in the search results based on the user-specified criteria for multiple changeable attributes. For example:

  	Quantity	Date Added
  Asset (database query)	10	Oct 1
  Pending Fulfilled Orders (database query)	20	Nov 1
  Projected Asset (merged data)	20	Oct 1

  • If the user searches on the projected asset, the result would indicate a Quantity of 20 with the Date Added of Oct 1.
  • If the user searches for Quantity less than 10 and Date added is less than Oct 15, the asset would not return a result because the criteria was filtered out in the database query prior to the merged projected asset query.

  In general, avoid a combination multiple attributes for a search when those attributes may change the result from the pending fulfillment order query.

• When there are multiple pending fulfilled order lines for the same asset, the projected asset info will come from the pending fulfilled line of latest request date. Therefore if the first pending fulfilled order line is asset creation order with action code of Add, even if the asset doesn't exist, the action in the final projected asset will still show as updated based on the second pending fulfilled line.

• If the response includes hasMore=true, this indicates that more results can be retrieved via pagination without changing search criteria. You could still get a warning of too much result data even if the response is hasMore=false. In this case, you should apply more restrictive search criteria.

• If you get a warning that there are too many results from the root asset search of the database, try to apply more restrictive criteria. You won't be able to limit the number of results from the database by adding restrictive criteria using fulfillmentstatus, action code, creation date, or modification date attributes as those are only being applied in memory.

  • For flat mode, partNumber is the only attribute that can for more restrictive search results.

  • For tree search mode, try to apply criteria with partNumber, assetkey, lineId, or transactionId attributes.

• The 21C and earlier ABO package sample Update Asset script incorporates all the pending fulfilled lines information to update the asset. This script logic assumes the pending fulfilled order will always update the asset in the order of request date. If this logic does not fit your business case, the Update Asset script will need to be customized to your needs.

• The 21C and earlier ABO package includes an Update Asset sample script which needs to be updated for this feature to populate the origTransactionid attribute for the asset. Modify the abo_convertDeltaBomToAsset function by adding the following line to the asset payload:

  jsonput(assetPayload, "origTransactionId", transactionId);

• The 21D Search Projected Assets by Customer REST API includes two endpoints that are for future use. You will receive an error message if you attempt to use the unreleased endpoints.

Follow-on Order
Description	This operation is used to make changes to an existing order that has not yet been fulfilled. When a follow-on order is created, the projected state of an existing unfulfilled order is calculated and a new configuration URL is returned. The configuration URL can be used to launch the model configurator page, which will reflect the user intended net changes to the subscription.
URI Endpoint	/rest/v17/configBomInstance/{configId}/actions/followOnOrder
Endpoint Parameters	config_id	The Configuration Id for the Configuration BOM Instance
HTTP Method	POST
Request Parameters	sourceIdentifier	The identifier for the integration process When this parameter is not specified, the default value is "_external_order"
	transactionDate	The date and time that the service request needs to be processed or fulfilled.
	transactionId	The current Transaction identifier
Response Parameters	configurationURL	The URL to launch the model configurator page

URI Endpoint Sample

Sample Request Body

Sample Response Body

{ "result": { "product_line": "integrationProductLine", "model": "integrationModel", "configContextKey": "3bdd9731-bc89-483b-85d5-09e02515c6d0", "segment": "integration", "bomkey": "abo_3cf6636c-9119-4960-b185-d13daee2631d", "configuratorURL": "https://sitename.oracle.com/commerce/new_equipment/products/model_configs.jsp?_from_partner=true&product_line=integrationProductLine&model=integrationModel&segment=integration&bm_sales_root_bom_item_id=abo_3cf6636c-9119-4960-b185-d13daee2631d&configContextKey=3bdd9731-bc89-483b-85d5-09e02515c6d0" } }

Get Configuration Instance
Description	This operation will use one of the following identifiers to retrieve a saved Configuration BOM Instance: The lineId returned from a Terminate, Suspend, Resume, or Renew service The config_id returned by client side JSON object for client integration case. Note: Get Configuration Instance is only available for external integrations.
URI Endpoint	/rest/v17/configBomInstance/{config_Id}/actions/getConfigBom
Endpoint Parameters	config_Id	The Configuration BOM Instance Id
HTTP Method	POST
Request Parameters	flattenHierachy	True	Returns a flattened BOM structure True is the default value.
		False	Returns a hierarchical BOM structure
Response Parameters	JSON data containing the saved Configuration BOM instance

URI Endpoint Sample

Sample Request Body

Sample Response Body

{ "configBom": { "partNumber": "part1", "quantity": 3, "explodedQuantity": 3, "category": "sales", "id": "abo_3cf6636c-9119-4960-b185-d13daee2631d", "fields": { "_price_unit_price_each": "3.0", "oRCL_ABO_ActionCode_l": "NO_UPDATE", "fulfillmentStatus_l": "CREATED", "_is_line_item_mandatory": true, "itemInstanceName_l": "part1-36503087-1", "itemInstanceId_l": "abo_3cf6636c-9119-4960-b185-d13daee2631d" }, "parentId": "", "children": [ { "partNumber": "part22", "quantity": 1, "explodedQuantity": 6, "id": "abo_cdfd49b4-b500-4e11-84e7-3739d1f2625f", "fields": { "_price_unit_price_each": "US Dollar price not defined.", "oRCL_ABO_ActionCode_l": "NO_UPDATE", "_is_line_item_mandatory": true, "itemInstanceName_l": "part22-36503087-13", "itemInstanceId_l": "abo_cdfd49b4-b500-4e11-84e7-3739d1f2625f" }, "parentId": "abo_d37e0168-c455-4748-af6c-da3fa2c0996c" }, { "partNumber": "part222", "quantity": 1, "explodedQuantity": 6, "id": "abo_e3ddd440-6928-4231-88b2-3c6d3ed1c09f", "fields": { "_price_unit_price_each": "US Dollar price not defined.", "oRCL_ABO_ActionCode_l": "NO_UPDATE", "_is_line_item_mandatory": true, "itemInstanceName_l": "part222-36503087-12", "itemInstanceId_l": "abo_e3ddd440-6928-4231-88b2-3c6d3ed1c09f" }, "parentId": "abo_d37e0168-c455-4748-af6c-da3fa2c0996c" } ] } }

Reconfigure from Assets
Description	This operation can be used to update a Transaction prior to fulfillment and will internally calculate the projected state of the configuration instance. It returns a new configuration URL that can be used to launch the model configurator page that will reflect the user-intended net changes to the subscription.
URI Endpoint	/rest/v17/configBomInstance/{configId}/actions/reconfig
Endpoint Parameters	config_id	The Configuration BOM Instance Id
HTTP Method	POST
Request Parameters	None
Response Parameters	configuratorURL	The URL to launch the model configurator page

URI Endpoint Sample

Sample Response Body

{ "result": { "product_line": "integrationProductLine", "model": "integrationModel", "configContextKey": "11461f91-91c7-4978-a8d6-c9c3d43e97f4", "segment": "integration", "bomkey": "abo_3cf6636c-9119-4960-b185-d13daee2631d", "configuratorURL": https://sitename.oracle.com/commerce/new_equipment/products/external_reconfig.jsp?_config_id=36503159&bm_sales_root_bom_item_id=abo_3cf6636c-9119-4960-b185-d13daee2631d&configContextKey=11461f91-91c7-4978-a8d6-c9c3d43e97f4 } }

Get Exported File
Description	This operation invokes a GET call to retrieve the file downloaded on the browser.
URI Endpoint	/rest/v17/files/fileName
Endpoint Parameter	fileName	This parameter contains the control file name from the export call response.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	Refer to the exported Asset CSV data file.
Success Response	The CSV file with the data.
Notes	These calls perform user access validation, so the same user must perform the export and get file calls.

Sample URI Endpoint

/rest/v17/files/assets_1464387178004

Export Assets CSV File
Description	This operation invokes an Export action to export an asset collection or single instance to a CSV file. It exports the object attributes as column headers and the key attributes with the dotted notation.
URI Endpoint	/rest/v17/assets/actions/export
Request Body Parameters	criteria	Type: JSON Requirements for the asset collection or single instance row export. Asset "attributes" can not be used as a parameter in search or sort query specifications.
Response Body Parameters	exportedFileName	Type: JSON This parameter contains the absolute path to the JSON control file used in the consecutive call to retrieve the CSV file.
HTTP Method	POST
Success Response	The JSON data of the absolute path of the control file.

Sample URI Endpoints

Sample Request

CSV Export

Import Assets CSV File
Description	This operation invokes an Import action to process the uploaded CSV to import data. It supports create, update, and delete operations. Asset Schema and Data Integrity You should adhere to the following guidelines to ensure proper asset population. These guidelines are applicable to the following REST API endpoints: Create Asset, Update Asset, Synchronize Asset, Synchronize Assets, and Import Assets CSV File. This does not include the BOM projection approach in the sample update asset script. The REST API schema definitions specify the basic attribute type (e.g. string, integer, number). The following guidelines describe additional requirements: The acceptable length for string type attributes is 255, with the exception of the following attributes: The acceptable length for the following attributes is 100: assetKey, displayKey, serialNumber The acceptable length for the following attributes is 30: status, usageUnitOfMeasure, fixedRecurringPeriod. The acceptable length for the "currency" attribute is 20. The acceptable length for the "assetDescription" attribute is 1000. The default format for the following of timestamp type attributes is ISO to eliminate any time zone ambiguity issues: startDate, endDate, suspendDate, resumeDate, purchaseDate. Unless noted otherwise, number type attributes allow 22 digits with a precision or 7. The following attributes are mandatory fields that should be populated with valid data: "Customer", "DisplayKey", "Part", and "Quantity". Populate the "rootAsset" and "parentAsset" fields based on hierarchy. Both fields should reference a valid asset. The parent asset should be null for the root asset record. For example, assume A2 has A1 as a parent and A1 has A3 as a parent, therefore A2 would have A3 as a grandparent. It would be invalid for A3 to have A2 as a parent, because it would create a cycle in the hierarchy where A3 has A1 as a grandparent and A3 has A3 as a great grandparent. Use the "assetKey" component fields to update the "rootAsset" and "parentAsset" fields. The parent asset cannot be its own ancestor. All amount attributes should have the same currency code. The "attributes" field should contain a JSON object which typically stores a BOM attribute. The parent asset cannot be its own ancestor. If an order line is marked as deleted, use the asset repository to delete or end-date the asset. With the exception of the action code available in the transaction_line_bom_attribute, the Attributes field should contain the same information as the transaction_line_bom_attribute. The abo_updateAsset function available in the 18D and later ABO package supports the ability to copy information from a Commerce order line and paste it into an asset. If ABO implementation package from 18D or later release is being used and abo_updateAsset is not being used to create/update assets, then Update Configuration REST API action should be invoked explicitly after asset creation or update.
URI Endpoint	/rest/v17/assets/actions/import
Request Header (optional)	Prefer: respond-async	If you are importing a large amount of data, we recommend requesting an asynchronous response to prevent the import from timing out. See Asynchronous Import Mode Examples for more details.
Request Body Parameters	fileName	File name extracted from the response rest link in the previous call.
Response Body Parameters	importLogFileName	This parameter contains the absolute path to the control file, which contains user Information and the absolute path to the log file.
HTTP Method	POST
Success Response	The absolute path to the control file, which contains user Information and the absolute path to the log file.

Sample URI Endpoint

Sample Request Body

Sample Response Body Payload

Asynchronous Import Mode Examples

Upload File
Description	This operation invokes a POST call to upload a file from the user's file system. It returns a control file used for the import action.
URI Endpoint	/rest/v17/files
File Parameters	attachment	The CSV file
	Header	content-disposition
	Media-type	application-JSON/octet-stream
HTTP Method	POST
Request Body Parameters	CSV file
Response Body Parameters	The response provides the absolute path to the control file, which contains user Information and the absolute path to the CSV to be imported. The import CSV file should contain a column called _sync_action to specify actions to perform. If the CSV file does not contain this column, the default upsert action is used. Use dot notation to represent Foreign Key (FK) attributes. For example, an asset object has an FK attribute called rootAsset. The import operation should import these attributes as rootAsset.id,rootAsset.assetKey.  Use dot notation to represent Currency attributes. For example, an asset has a Currency attribute called discountAmount.  The import operation needs to import these attributes as discountAmount.value,discountAmount.currency. Use dot notation to represent LOVs.

Sample URI Endpoint

Sample Response Body

/rest/v17/files/upload_1465847155416

Get Import Log
Description	Invokes a GET call to retrieve the actual import log file.
URI Endpoint	/rest/v17/files/fileName
Endpoint Parameter	fileName	The name of the import log file from the import call response
HTTP Method	GET
Request Body Parameters	None
Response Body Parameter	CSV file
Success Response	The CSV file with the object data as the status (CSV column) of the import for each row and if the import failed for the row the error message (CSV column). User access is validated, so both the import and get log file calls should be performed by the same user.

Sample URI Endpoint

/rest/v17/files/assets_output_1465848183346