1. REST API Services for CPQ Cloud
  2. Tasks
  3. Commerce
  4. Actions

Transaction Pipeline Viewer

post

/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_pipelineViewer

The Pipeline Viewer action is used to check rules that are in effect for the current Commerce process. This action returns both main document and sub-document items.

Request

Path Parameters
  • The variable name of the main document, the first letter must be capitalized
  • The variable name of the Commerce process, the first letter must be capitalized
  • Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
Body ()
Root Schema : commerceTransaction-pipelineViewerRequest
Type: object
Show Source
  • Title: Cache Instance Id
    The unique identifier for the entry of transaction data stored in the cache. Only valid cache instance ids are supported. The '- 1' value is not supportedThis typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
Back to Top

Response

Default Response

Body ()
Root Schema : commerceTransaction-pipelineViewerResponse
Type: object
Show Source
  • Title: Cache Instance Id
    The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
  • Rules
    Title: Rules
    Rules associated with the transaction.
Nested Schema : Rules
Type: array
Title: Rules
Rules associated with the transaction.
Show Source
Nested Schema : Rule
Type: object
Title: Rule
Rule definition.
Show Source
Nested Schema : Components
Type: object
Title: Components
Rule Components.
Show Source
Nested Schema : Main document
Type: object
Title: Main document
Rules in main document.
Show Source
Nested Schema : Sub document
Type: object
Title: Sub document
Rules in sub document.
Show Source
Nested Schema : Actions
Type: array
Title: Actions
Rules in actions.
Show Source
Nested Schema : Attributes
Type: array
Title: Attributes
Rules in attributes.
Show Source
Nested Schema : Actions
Type: array
Title: Actions
Rules in actions.
Show Source
Nested Schema : Attributes
Type: array
Title: Attributes
Rules in attributes.
Show Source
Back to Top

Examples

The following example shows how to check rules that are in effect for the current Commerce process by submitting POST requests 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/v7/commerceDocumentsOraclecpqoTransaction/18016533/actions/_pipelineViewer

Response Body Sample

{
"cacheInstanceId": "bDYxrCAnUwiVpYXUGDoT1GilCF0CFMPEGTcuKCPER3QFuxHJf33AYtAU1atZItpt"
}

Response Body Sample

{
   "pipelineViewerRules": [{
         "name": "Hide Level 2 Reason Approver",
      "type": "Hiding Rule",
      "components": {
        "mainDoc": {
          "attributes": [{
              "name": "Hiding Attribute 1",
              "variableName": "hidingAttribute1"
            }, {
              ...
          }],
          "actions": [{
              "name": "Hiding Action 1",
              "variableName": "hidingAction1"
            }, {
              ...
               }
                 ]
              },
         "subDoc": {
           "attributes": [{
              "name": "Hiding Attribute 10",
              "variableName": "hidingAttribute10"
            }, {
              ...
          }],
          "actions": [{
              "name": "Hiding Action 10",
              "variableName": "hidingAction10"
            }, {
              ...
                     }
                     ]
                  }
               }
            }, {
      "name": "Hide Level 3 Reason Approver",
      "type": "Hiding Rule",
      "components": {
        "mainDoc": {
          ...
        },
        "subDoc": {
          ...
            }
         }
      }
   ]
}
Back to Top