Additional Parameters

This parameter contains the destination URL when an Oracle CPQ action has a destination tab with a configured destination. When available, the destination URL is returned in the JSON response.

Destination URL Sample

"destinationURL": "https://sitename.oracle.com/commerce/display_company_profile.jsp?action_id=17905905&document_id=4356178&bsId=18016533&versionId=15514396"

The "partnerInfo" parameter for New Transaction actions supports Commerce integrations. This parameter contains the "partnerOpportunityId" and "partnerAccountId" parameters.

Request Body Sample

{
   "partnerInfo": {
      "partnerOpportunityId": "12313vv12",
      "partnerAccountId": "12423a0A"
   },
    "documents": {
        "myAttr": 17
   }
}

The "revsionId" parameter can be included in the request and response body for most Commerce action REST APIs. The revisionId is a critical part of client-server communication for collaboration. It enables the server to identify the latest revision from the clients. The most recent revision of a data change is applied on top of the last revision. Without the revision id, it's possible that an out-of-date request from one client could accidentally revert a concurrent change requested by a different client.

Unlike the cacheInstanceId, "-1" is not a valid revisionId value. When loading a Transaction for the first time, the revisionId parameter is omitted from the request. After the first request, the client should retrieve the revisionId from every response, store it on client side, and include it with the next request.

The Selection parameter is used in the REST call request body to select specific items, such as external order asset keys, data table items, eligibility rules, tasks, or transaction lines. This parameter can be used for transaction level actions that support line selection.

Asset Key Example

{
  "sourceIdentifier": "_external_order",
  "transactionId": "",
  "transactionDate": "2019-05-20",
  "returnBom": false,
  "selections": ["21652013", "21652080"]
} 

Data Table Examples

{"selections": ["Racks", "Rack_Components"]}

{"selections": ["Size", "Weight"]}

{"selections": [123456, 789012, 345678]}

Tasks Example

{"selections": [41365769, 4118171, 41365772]}

Transaction Line Example

{"selections": ["transactionLine/2", "transactionLine/3"]}

RESTful action services automatically execute the integration tasks specified in the integration tab of the action definition. Set the "skipIntegration" parameter to "true" to disable the execution of integration tasks.

Skip Integration Syntax: "skipIntegration": true.

To optimize Commerce rules evaluation during REST API services, customers can include the "skipRules" parameter in request body for Commerce Modify type REST API calls. When this parameter is provided in the REST call, Access Rules will not be evaluated. This parameter can be used with the endpoint for any Modify type action.

Request Body Example

 {
  "cacheInstanceId": "...",
  "criteria": {
    ...
  },
  ...,
  "skipRules": ["HIDING"],
  "documents": {
    ...
  }
}