Renew Assets
post
/rest/v16/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 User Keys
Title:
User Keys
An array of user keys selected for the specified operation. When 'userKeys' are used, do not use 'selections'. -
flattenHierarchy:
boolean
Title:
Flatten BOM Hierarchy
Determines how the BOM structure is returned. Set to 'true' to return a flattened BOM structure (default value). Set to 'false' to return a hierarchical BOM structure. -
returnBom:
boolean
Title:
Return BOM
Optional, set this item is set to 'true' to return the BOM structure for the requested assets in the response body. The default value is 'false'. -
selections:
array selections
-
sourceIdentifier:
string
Title:
Source Identifier
The variable name of the commerce process or external application identifier. '_external_order' is the default value for external orders when this parameter is not specified. The commerce process variable name 'processVarName' is used for internal orders (e.g. oraclecpqo). -
transactionDate:
string
Title:
Transaction Date
The date and time that the service request needs to be processed or fulfilled. -
transactionId:
string
Title:
Transaction Id
The Commerce Transaction ID associated with the asset(s). When the Transaction ID is not provided, a new Transaction is created and associated with the requested operation.
Nested Schema : User Keys
Type:
array
Title:
User Keys
An array of user keys selected for the specified operation. When 'userKeys' are used, do not use 'selections'.
Show Source
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
When the request is successful, the output contains the processed list of assets. -
result:
object ABO Headless Service Response.
Title:
ABO Headless Service Response.
Response Schema for ABO related actions which are used to create transaction lines without launching the Configuration UI (e.g. terminate, suspend, resume). -
resultTransactionId:
integer
Title:
Result Transaction Id
The commerce transaction Id. If the transaction Id is not provided, a new transaction is created.
Nested Schema : Processed List
Type:
array
Title:
Processed List
When the request is successful, the output contains the processed list of assets.
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 lines without launching the Configuration UI (e.g. terminate, suspend, resume).
Show Source
-
bomkey:
string
Title:
BOM Key
The BOM instance ID, also is asset-key for the newly created order line. -
lineId:
string
Title:
Line Id
The transaction line identifier for the created line. For an internal CPQ Commerce process, it is the ine number. For an external commerce application, it is the config_id which can be used to construct the endpoint to access specific configuration instance.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Success Entry
Title:
Success Entry
Success Entry.
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
The BOM instance hierarchy returned by the configBomInstance endpoint to retrieve the BOM instance created by the ABO process. It only describes a two-level flattened hierarchy and fields populated by the out-of-box ABO process. -
lineId:
integer
Title:
Line Id
Line document number or Configuration Id.
Nested Schema : ABO BOM
Type:
object
Title:
ABO BOM
The BOM instance hierarchy returned by the configBomInstance endpoint to retrieve the BOM instance created by the ABO process. It only describes a two-level flattened hierarchy and fields populated by the out-of-box ABO process.
Show Source
-
asset_fields:
object ABO BOM Asset Field Definitions
Title:
ABO BOM Asset Field Definitions
List of additional Commerce attributes populated by the 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 the ABO process -
explodedQuantity:
integer
The exploded quantity of current BOM item, which is the multiplication of the parent BOM item exploded quantiy and the current BOM item quantity.
-
fields:
object ABO BOM Field definitions
Title:
ABO BOM Field definitions
List of additional Commerce attributes populated by the ABO process -
id:
string
The unique instance identifier for BOM item.
-
isModel:
integer
Identifies if the current item is a model.
-
parentId:
string
Identifier of parent BOM item, root BOM item will have empty parentId.
-
partNumber:
string
Title:
Part Number
The The 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 the ABO process.
Show Source
-
amount:
object amount
Amount of the asset associated to the Configuration BOM.
-
billingAccount:
object billingAccount
Billing Account of the asset associated to the Configuration BOM.
-
endDate:
object endDate
End Date of the asset associated to the Configuration BOM.
-
id:
object id
Id of the asset associated to the Configuration BOM.
-
serviceAccount:
object serviceAccount
Service Account of the asset associated to the Configuration BOM.
-
startDate:
object startDate
Start Date of the asset associated to the Configuration 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 the 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 the ABO process
Show Source
-
_price_unit_price_each:
string
Title:
Price Unit Price Each
Override net unit price populated by the ABO process. -
fulfillmentStatus_l:
string
Title:
Fultillment Status
The fulfillment status identifies the current state of an order and the associated saved BOM instance. Possible values include: CREATED - Upon creating the configured BOM instance, the fulfillment status is set to CREATED and indicates the order has not been submitted for fulfillment; BEING_FULFILLED - Indicates the order was submitted to the fulfillment system and CPQ has not yet been notified of the order 's fulfillment; FULFILLED: Indicates the order is fulfilled and assets have been created in CPQ; and CLOSED - Indicates the order is closed or cancelled. -
itemInstanceId_l:
string
Title:
Item Instance ID
The display Id of the product instance. -
itemInstanceName_l:
string
Title:
Item Instance Name
The display name of the product instance. -
oRCL_ABO_ActionCode_l:
string
Title:
Action Code
The action code for the current transaction line, the possible values are Add, Update, Delete, Terminate, Suspend, etc.
Nested Schema : amount
Type:
object
Amount of the asset associated to the Configuration BOM.
Nested Schema : billingAccount
Type:
object
Billing Account of the asset associated to the Configuration BOM.
Nested Schema : endDate
Type:
object
End Date of the asset associated to the Configuration BOM.
Nested Schema : id
Type:
object
Id of the asset associated to the Configuration BOM.
Nested Schema : serviceAccount
Type:
object
Service Account of the asset associated to the Configuration BOM.
Nested Schema : startDate
Type:
object
Start Date of the asset associated to the Configuration 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 the 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 the ABO process -
explodedQuantity:
integer
The exploded quantity of current BOM item, which is the multiplication of the parent BOM item exploded quantiy and the current BOM item quantity.
-
fields:
object ABO BOM Field definitions
Title:
ABO BOM Field definitions
List of additional Commerce attributes populated by the ABO process -
id:
string
Unique instance identifier for the BOM item
-
isModel:
integer
Identifies if the current item is a model.
-
parentId:
string
Identifier of the parent BOM item, the root BOM item will have an empty parent Id.
-
partNumber:
string
The part number of the BOM item.
-
quantity:
integer
Requested quantity of the current line, it can have a 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 examples show 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 - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/assets/actions/renew
Internal Order Using Asset Keys
Request Body Sample
{ "sourceIdentifier": "oraclecpqo", "transactionId": "21275813", "transactionDate": "2019-01-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=2019-01-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" } ] }
External Order Using Selections
Request Body Sample
{ "sourceIdentifier": "_external_order", "transactionId": "", "transactionDate": "2019-05-20", "returnBom": false, "selections": ["21652013", "21652080"] }
Response Body Sample
{ "resultTransactionId": "", "navigationURL": "", "processedList": [{ "lineId": "21652103", "assetKey": "abo_778bf926-cb08-4eae-8907-e7efa388ad8f" }, { "lineId": "21652111", "assetKey": "abo_53a62368-b9e1-4e91-86e2-09dfc87f66b4" } ] }