Standard ABO: Assets REST APIs

Oracle CPQ 25D introduced support for the new Oracle CPQ platform-based implementation of Asset-Based Ordering (ABO) referred to as Standard ABO. The Oracle CPQ 26A Interface Catalog includes the Standard ABO Assets v19 REST APIs which are required to support the new Standard ABO implementation.

Note: Oracle CPQ 25C and earlier ABO implementations, known as Package ABO, required migration package upgrades to support new features. However, the REST API v19 endpoints for Assets do not work with Package ABO. Customers using Package ABO must continue using REST API v18 or earlier for Assets and Projected Assets.

Oracle CPQ 26A introduces the following enhancements to existing Standard ABO Assets REST API v19:

Get All Assets

Oracle CPQ 26A has added support for the following parameters: customerName, transactionNumber, itemType, modelName, isOptionalItem, and isModel.

We have also added support for keyword, account, and hierarchical search (enableHierarchy=true). The hierarchical search returns only the information necessary to display the matched asset within its proper context. For any given matched asset, the response will include:

  • The matched asset itself
  • The asset's direct parent, its parent's parent, and so on, up to the root asset of the hierarchy. The API will not return siblings of the matched asset or other child assets that are not part of the direct ancestral path.

Asset custom fields can now be used within the orderby and q parameters to sort and filter by the values of custom fields.

Create Asset

Oracle CPQ 26A has added support for the following parameters: customerName, transactionNumber, itemType, modelName, isOptionalItem, and isModel.

Upsert Asset

Oracle CPQ 26A has added support for the following parameters: customerName, transactionNumber, itemType, modelName, isOptionalItem, and isModel.

Oracle CPQ 26A introduces the following new Standard ABO Assets REST API v19 endpoints:

Get Eligible Actions for Assets

This operation retrieves all eligible actions for assets.

  • Endpoint:  /rest/v19/assets/eligibleActions
  • Method:  POST

Get Asset Metadata

This resource retrieves metadata describing attributes available for the Assets resource.

  • Endpoint:  /rest/v19/assets/metadata
  • Method:  GET

Steps to Enable and Configure

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.