Renew Assets

post

/rest/v19/assets/actions/renew

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.

Request

Supported Media Types
Body ()
Root Schema : assets-renewCollectionRequest
Type: object
Show Source
Nested Schema : userKeys
Type: array
Show Source
Nested Schema : selections
Type: array
Show Source
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : assets-renewCollectionResponse
Type: object
Show Source
Nested Schema : Processed List
Type: array
Title: Processed List
List of successfully processed requests.
Show Source
Nested Schema : ABO Headless Service Response.
Type: object
Title: ABO Headless Service Response.
Response Schema for ABO related actions which are used to create transaction line without launching configurator UI such as terminate, suspend, resume.
Show Source
  • Bom instance id also is asset-key for the newly created order line.
  • Transaction line identifier for the created line, for CPQ internal commerce process, it is line number, for external commerce application, it is config_id which can be used to construct the endpoint to access specific config instance.
Nested Schema : Success Entry
Type: object
Title: Success Entry
Success Entry.
Show Source
  • Title: Asset Key
    Unique identifier of Asset.
  • ABO Bom
    Title: ABO Bom
    BOM Instance Hierarchy as returned by configBomInstance endpoint to retrieve bom instance created by ABO process. It only describe two level flatten hierarchy and fields populated by out of box ABO process right now
  • Title: Line Id
    Line document number or Config Id.
Nested Schema : ABO Bom
Type: object
Title: ABO Bom
BOM Instance Hierarchy as returned by configBomInstance endpoint to retrieve bom instance created by ABO process. It only describe two level flatten hierarchy and fields populated by out of box ABO process right now
Show Source
Nested Schema : ABO Bom Asset Field definitions
Type: object
Title: ABO Bom Asset Field definitions
List of additional commerce attributes populated by ABO process
Show Source
Nested Schema : attributes
Type: object
Nested Schema : children
Type: array
Show Source
Nested Schema : ABO Bom Custom Attributes definitions
Type: object
Title: ABO Bom Custom Attributes definitions
List of additional commerce attributes populated by ABO process
Show Source
Nested Schema : ABO Bom Field definitions
Type: object
Title: ABO Bom Field definitions
List of additional commerce attributes populated by ABO process
Show Source
Nested Schema : amount
Type: object
Amount of the Asset associated to the Config Bom
Nested Schema : billingAccount
Type: object
BillingAccount of the Asset associated to the Config Bom
Nested Schema : endDate
Type: object
EndDate of the Asset associated to the Config Bom
Nested Schema : id
Type: object
Id of the Asset associated to the Config Bom
Nested Schema : serviceAccount
Type: object
ServiceAccount of the Asset associated to the Config Bom
Nested Schema : startDate
Type: object
StartDate of the Asset associated to the Config Bom
Nested Schema : Bom Item
Type: object
Title: Bom Item
Structure of Bom Item Object
Show Source
Nested Schema : attributes
Type: object
Nested Schema : field1
Type: object
Custom Attribute for a Part
Nested Schema : field10
Type: object
Custom Attribute for a Part
Nested Schema : field11
Type: object
Custom Attribute for a Part
Nested Schema : field12
Type: object
Custom Attribute for a Part
Nested Schema : field13
Type: object
Custom Attribute for a Part
Nested Schema : field14
Type: object
Custom Attribute for a Part
Nested Schema : field15
Type: object
Custom Attribute for a Part
Nested Schema : field16
Type: object
Custom Attribute for a Part
Nested Schema : field17
Type: object
Custom Attribute for a Part
Nested Schema : field18
Type: object
Custom Attribute for a Part
Nested Schema : field19
Type: object
Custom Attribute for a Part
Nested Schema : field2
Type: object
Custom Attribute for a Part
Nested Schema : field20
Type: object
Custom Attribute for a Part
Nested Schema : field21
Type: object
Custom Attribute for a Part
Nested Schema : field22
Type: object
Custom Attribute for a Part
Nested Schema : field23
Type: object
Custom Attribute for a Part
Nested Schema : field24
Type: object
Custom Attribute for a Part
Nested Schema : field25
Type: object
Custom Attribute for a Part
Nested Schema : field26
Type: object
Custom Attribute for a Part
Nested Schema : field27
Type: object
Custom Attribute for a Part
Nested Schema : field28
Type: object
Custom Attribute for a Part
Nested Schema : field29
Type: object
Custom Attribute for a Part
Nested Schema : field3
Type: object
Custom Attribute for a Part
Nested Schema : field30
Type: object
Custom Attribute for a Part
Nested Schema : field4
Type: object
Custom Attribute for a Part
Nested Schema : field5
Type: object
Custom Attribute for a Part
Nested Schema : field6
Type: object
Custom Attribute for a Part
Nested Schema : field7
Type: object
Custom Attribute for a Part
Nested Schema : field8
Type: object
Custom Attribute for a Part
Nested Schema : field9
Type: object
Custom Attribute for a Part
Back to Top

Examples

The following example shows how to renew assets by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST  -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/assets/actions/renew

Request Body Sample

{
   "sourceIdentifier": "oraclecpqo",
   "transactionId": "21275813",
   "transactionDate": "2025-10-27 00:00:00",
   "returnBom": false,
   "flattenHierarchy": false,
   "assetKeys": ["abo_05b05644-82de-4240-86eb-8feee4aa90d6", "abo_d60556a9-8639-403b-aea0-d0fbd3d73c29"]
}

Response Body Sample

{
   "resultTransactionId": "21275813",
   "navigationURL": "https://sitename.oracle.com/commerce/buyside/document.jsp?formaction=cancelAddFromCatalogCookie&bs_id=21479248&actionVarName=_open_transaction&commerceProcess=oraclecpqo&process=oraclecpqo&txnDate=2025-10-27 00:00:00&transactionId=21275813",
   "processedList": [{
      "lineId": "8",
      "assetKey": "abo_05b05644-82de-4240-86eb-8feee4aa90d6"
   }, {
      "lineId": "11",
      "assetKey": "abo_d60556a9-8639-403b-aea0-d0fbd3d73c29"
    }
  ]
}
Back to Top