Assets REST APIs to Support Standard Asset-Based Ordering

Oracle CPQ 25D supports the new Oracle CPQ platform-based implementation of Asset-Based Ordering (ABO) referred to as Standard ABO.  The Oracle CPQ 25D Interface Catalog includes the Standard ABO Assets, Configuration BOM Instance, and Projected Assets v19 REST APIs. The Oracle 25D REST API v19 endpoints are required to support the new Standard ABO implementation.

Oracle CPQ 25C and earlier ABO implementations required migration package upgrades for new ABO feature support. These implementations are referred to as Package ABO implementations. The REST API v19 Assets, Configuration BOM Instances, and Projected Assets endpoints do not support the Oracle CPQ pre-25D Package ABO implementation. Customers with the Oracle CPQ Package ABO implementation must continue using their existing Assets and Projected Assets REST API v18 or earlier endpoints.

Oracle CPQ 25D introduces the following Assets REST API v19 Standard ABO endpoints:

Assets

Get All Assets

This operation retrieves all assets.

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

Get an Asset

This operation returns asset data for the specific asset. This endpoint supports queries for child and descendent assets.

  • Endpoint:  /rest/v19/assets/{id}
  • Method:  GET

Get Asset Charges 

This operation retrieves all charges of the specified asset.

  • Endpoint:  /rest/v19/assets/{id}/charges
  • Method:  GET

Get Action Logs

This operation retrieve a list of all action logs.

  • Endpoint:  /rest/v19/actionLogs
  • Method:  GET

Actions

Create Asset

This operation creates a new asset.

  • Endpoint:  /rest/v19/assets/{id}
  • Method:  POST

Delete Asset

This operation deletes an asset.

  • Endpoint:  /rest/v19/assets/{id}
  • Method:  DELETE

Update Asset

This operation updates an asset.

  • Endpoint:  /rest/v19/assets/{id}
  • Method:  PATCH

Upsert Assets

This operation supports insert/updated of multiple asset records in a single call. If the asset instance already exists, it is updated with the newly provided information. If the asset instance doesn’t exist, a new entry is created with the provided information.

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

Modify Asset

This operation calculates the projected state of the asset for the requested date and returns a configuration URL that can be used to launch the model configurator page reflecting the projected state.

  • Endpoint:  /rest/v19/assets/{id}/actions/modify
  • Method:  POST

Modify Assets

This operation calculates the projected state of the designated assets for the requested date. For modify requests the action codes are set to '-' for No Update.

  • Endpoint:  /rest/v19/assets/actions/modify
  • Method:  POST

Renew Asset

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.

  • Endpoint:  /rest/v19/assets/{id}/actions/renew
  • Method:  POST

Renew Assets

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.

  • Endpoint:  /rest/v19/assets/actions/renew
  • Method:  POST

Resume Asset

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.

  • Endpoint:  /rest/v19/assets/{id}/actions/resume
  • Method:  POST

Resume Assets

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.

  • Endpoint:  /rest/v19/assets/actions/resume
  • Method:  POST

Suspend Asset

This operation merges a suspend request with the projected asset for the requested date, and then stores the results to a Configuration BOM Instance. For suspend requests, the root and subordinate action codes are set to Suspend.

  • Endpoint:  /rest/v19/assets/{id}/actions/suspend
  • Method:  POST

Suspend Assets

This operation merges a suspend request with the projected assets for the requested date, and then stores the results to a Configuration BOM Instance. For suspend requests, the root and subordinate action codes are set to Suspend.

  • Endpoint:  /rest/v19/assets/actions/suspend
  • Method:  POST

Terminate Asset

This operation merges a termination request with the projected asset for the requested date, and then stores the results to a Configuration BOM Instance. For termination requests, the root item action code is set to Terminate and subordinate asset action codes are set to Delete.

  • Endpoint:  /rest/v19/assets/{id}/actions/terminate
  • Method:  POST

Terminate Assets

This operation merges a termination request with the projected asset for the requested date, and then stores the results to a Configuration BOM Instance. For termination requests, the root item action code is set to Terminate and subordinate asset action codes are set to Delete.

  • Endpoint:  /rest/v19/assets/actions/terminate
  • Method:  POST

Create Asset Charge

This operation creates a new charge for the specified asset.

  • Endpoint:  /rest/v19/assets/{id}/charges
  • Method:  POST

Delete Asset Charge

This operation deletes a charge for the specified asset.

  • Endpoint:  /rest/v19/assets/{id}/charges/{chargedId}
  • Method:  DELETE

Update Asset Charge

This operation updates a charge for the specified asset.

  • Endpoint:  /rest/v19/assets/{id}/charges/{chargeId}
  • Method:  PATCH

Steps to Enable

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.