Modify Assets

post

/rest/v16/assets/actions/modify

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.

Request

Supported Media Types
Body ()
Root Schema : assets-modifyCollectionRequest
Type: object
Show Source
  • User Keys
    Title: User Keys
    An array of user keys selected for the specified operation. When 'userKeys' are used, do not use 'selections'.
  • 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.
  • 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
  • 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).
  • Title: Transaction Date
    The date and time that the service request needs to be processed or fulfilled.
  • 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
Nested Schema : selections
Type: array
Show Source
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : assets-modifyCollectionResponse
Type: object
Show Source
  • Title: Navigation URL
    The target URL to where the UI navigates to on return. For assets that were created via CPQ, a successful response includes a navigation URL to the Transaction UI. For assets that were created via an external order, a successful response is empty and does not contain a URL.
  • Processed List
    Title: Processed List
    When the request is successful, the output contains the processed list of assets.
  • ABO Interactive Service Response.
    Title: ABO Interactive Service Response.
    The response schema for ABO related actions which are used to launch the Configuration UI (e.g. Modify, Reconfigure, Follow-On Order).
  • 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 Interactive Service Response.
Type: object
Title: ABO Interactive Service Response.
The response schema for ABO related actions which are used to launch the Configuration UI (e.g. Modify, Reconfigure, Follow-On Order).
Show Source
  • The id of the BOM instance calculated by the ABO process. This is used to pass to the URL parameter to configuration, since configuration will only use the BOM if the BOM id inside matches the id passed in the BOM key.
  • The context key passed to the configuration session to retrieve the BOM instance being calculated by the ABO process.
  • The URL to launch the Configuration UI with the BOM instance calculated by the ABO process.
  • The model variable name for the model to launch the Configuration UI.
  • The product line variable name for the model to launch the Configuration UI.
  • The segment variable name for the model to launch the Configuration UI.
Nested Schema : items
Type: array
Show Source
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
    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.
  • 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
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
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 the ABO process
Show Source
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
  • Title: Price Unit Price Each
    Override net unit price populated by the ABO process.
  • 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.
  • Title: Item Instance ID
    The display Id of the product instance.
  • Title: Item Instance Name
    The display name of the product instance.
  • 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
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 examples show how to modfy 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/modify

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"
      }
   ]
}
Back to Top