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
- application/json
Root Schema : assets-renewCollectionRequest
Type:
Show Source
object
-
assetKeys:
array userKeys
-
flattenHierarchy:
boolean
Title:
Flat Bom
Boolean value asking Config Bom to be returned as flat -
returnBom:
boolean
Title:
Return Bom
Boolean value asking Config Bom to be returned -
selections:
array selections
-
sourceIdentifier:
string
Title:
Source Identifier
The variable name of the commerce process or external application identifier. -
transactionDate:
string
Title:
Transaction Date
The date and time on which the service request was made. -
transactionId:
string
Title:
Transaction Id
The current transaction identifier.
Response
Supported Media Types
- application/json
Default Response
Root Schema : assets-renewCollectionResponse
Type:
Show Source
object
- navigationURL: string
-
processedList:
array Processed List
Title:
Processed List
List of successfully processed requests. -
result:
object ABO Headless Service Response.
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. -
resultTransactionId:
integer
Title:
Result Transaction Id
New transaction id created as part of asset operation.
Nested Schema : Processed List
Type:
array
Title:
Processed List
List of successfully processed requests.
Show Source
-
Array of:
object Success Entry
Title:
Success Entry
Success Entry.
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
-
bomkey:
string
Bom instance id also is asset-key for the newly created order line.
-
lineId:
string
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
-
assetKey:
string
Title:
Asset Key
Unique identifier of Asset. -
bom:
object 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 -
lineId:
integer
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
-
asset_fields:
object ABO Bom Asset Field definitions
Title:
ABO Bom Asset Field definitions
List of additional commerce attributes populated by ABO process -
attributes:
object attributes
-
children:
array children
-
custom_attributes:
object ABO Bom Custom Attributes definitions
Title:
ABO Bom Custom Attributes definitions
List of additional commerce attributes populated by ABO process -
explodedQuantity:
integer
Exploded Quantity of current bom item, it is the multiplication of exploded quantiy of parent bom item and quantity of current bom item
-
fields:
object ABO Bom Field definitions
Title:
ABO Bom Field definitions
List of additional commerce attributes populated by ABO process -
id:
string
unique instance identifier for bom item
-
isModel:
integer
Identifies if this is model
-
parentId:
string
Identifier of parent bom item, root bom item will have empty parentId
-
partNumber:
string
part number of the bom item
-
quantity:
integer
Requested quantity of current line, it can have fractional value
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
-
amount:
object amount
Amount of the Asset associated to the Config Bom
-
billingAccount:
object billingAccount
BillingAccount of the Asset associated to the Config Bom
-
endDate:
object endDate
EndDate of the Asset associated to the Config Bom
-
id:
object id
Id of the Asset associated to the Config Bom
-
serviceAccount:
object serviceAccount
ServiceAccount of the Asset associated to the Config Bom
-
startDate:
object startDate
StartDate of the Asset associated to the Config Bom
Nested Schema : attributes
Type:
object
Nested Schema : children
Type:
Show Source
array
-
Array of:
object Bom Item
Title:
Bom Item
Structure of Bom Item Object
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
-
field1:
object field1
Custom Attribute for a Part
-
field10:
object field10
Custom Attribute for a Part
-
field11:
object field11
Custom Attribute for a Part
-
field12:
object field12
Custom Attribute for a Part
-
field13:
object field13
Custom Attribute for a Part
-
field14:
object field14
Custom Attribute for a Part
-
field15:
object field15
Custom Attribute for a Part
-
field16:
object field16
Custom Attribute for a Part
-
field17:
object field17
Custom Attribute for a Part
-
field18:
object field18
Custom Attribute for a Part
-
field19:
object field19
Custom Attribute for a Part
-
field2:
object field2
Custom Attribute for a Part
-
field20:
object field20
Custom Attribute for a Part
-
field21:
object field21
Custom Attribute for a Part
-
field22:
object field22
Custom Attribute for a Part
-
field23:
object field23
Custom Attribute for a Part
-
field24:
object field24
Custom Attribute for a Part
-
field25:
object field25
Custom Attribute for a Part
-
field26:
object field26
Custom Attribute for a Part
-
field27:
object field27
Custom Attribute for a Part
-
field28:
object field28
Custom Attribute for a Part
-
field29:
object field29
Custom Attribute for a Part
-
field3:
object field3
Custom Attribute for a Part
-
field30:
object field30
Custom Attribute for a Part
-
field4:
object field4
Custom Attribute for a Part
-
field5:
object field5
Custom Attribute for a Part
-
field6:
object field6
Custom Attribute for a Part
-
field7:
object field7
Custom Attribute for a Part
-
field8:
object field8
Custom Attribute for a Part
-
field9:
object field9
Custom Attribute for a Part
Nested Schema : ABO Bom Field definitions
Type:
object
Title:
ABO Bom Field definitions
List of additional commerce attributes populated by ABO process
Show Source
-
_price_unit_price_each:
string
Override net unit price populated by ABO process
-
fulfillmentStatus_l:
string
Indicates fulfillment status
-
itemInstanceId_l:
string
Display id of product instance
-
itemInstanceName_l:
string
display name of the product instance
-
oRCL_ABO_ActionCode_l:
string
action code for the current transaction line, the possible values are Add, Update, Delete , Terminate , Suspend and etc
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
-
asset_fields:
object ABO Bom Asset Field definitions
Title:
ABO Bom Asset Field definitions
List of additional commerce attributes populated by ABO process -
attributes:
object attributes
-
custom_attributes:
object ABO Bom Custom Attributes definitions
Title:
ABO Bom Custom Attributes definitions
List of additional commerce attributes populated by ABO process -
explodedQuantity:
integer
Exploded Quantity of current bom item, it is the multiplication of exploded quantiy of parent bom item and quantity of current bom item
-
fields:
object ABO Bom Field definitions
Title:
ABO Bom Field definitions
List of additional commerce attributes populated by ABO process -
id:
string
unique instance identifier for bom item
-
isModel:
integer
Identifies if this is model
-
parentId:
string
Identifier of parent bom item, root bom item will have empty parentId
-
partNumber:
string
part number of the bom item
-
quantity:
integer
Requested quantity of current line, it can have fractional value
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
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" } ] }