Jump to

• Request
• Response
• Examples

Pipeline Viewer - Transaction

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_pipelineViewer

Use this endpoint to display the rules that are in effect for the current Commerce process. This operation returns both transaction and transaction line items.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Body ()

Root Schema : Transaction-_pipelineViewerRequest

Type: object

Show Source

• cacheInstanceId: string
  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.

{
    "type":"object",
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"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.",
            "title":"Cache Instance Id"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_pipelineViewerResponse

Type: object

Show Source

• cacheInstanceId: string
  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.
• pipelineViewerRules: array Rules
  Title: Rules

  Rules associated with the transaction.

{
    "type":"object",
    "properties":{
        "pipelineViewerRules":{
            "$ref":"#/definitions/pipelineViewerRules"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"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.",
            "title":"Cache Instance Id"
        }
    }
}

Nested Schema : Rules

Type: array

Title: Rules

Rules associated with the transaction.

Show Source

• Array of: object Rule
  Title: Rule

  Rule definition.

{
    "title":"Rules",
    "type":"array",
    "description":"Rules associated with the transaction.",
    "items":{
        "$ref":"#/definitions/pipelineViewerRule"
    }
}

Nested Schema : Rule

Type: object

Title: Rule

Rule definition.

Show Source

• name: string
  Title: Name

  Rule name
• pipelineViewerRuleComponents: object Components
  Title: Components

  Rule components
• type: string
  Title: Type

  Rule type

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Rule name",
            "title":"Name"
        },
        "type":{
            "type":"string",
            "description":"Rule type",
            "title":"Type"
        },
        "pipelineViewerRuleComponents":{
            "description":"Rule components",
            "title":"Components",
            "$ref":"#/definitions/pipelineViewerRuleComponents"
        }
    },
    "title":"Rule",
    "description":"Rule definition."
}

Nested Schema : Components

Type: object

Title: Components

Rule components

Show Source

• pipelineViewerRuleMainDoc: object Main document
  Title: Main document

  Rules in main document
• pipelineViewerRuleSubDoc: object Sub document
  Title: Sub document

  Rules in sub document

{
    "type":"object",
    "properties":{
        "pipelineViewerRuleMainDoc":{
            "description":"Rules in main document",
            "title":"Main document",
            "$ref":"#/definitions/pipelineViewerRuleMainDoc"
        },
        "pipelineViewerRuleSubDoc":{
            "description":"Rules in sub document",
            "title":"Sub document",
            "$ref":"#/definitions/pipelineViewerRuleSubDoc"
        }
    },
    "title":"Components",
    "description":"Rule components"
}

Nested Schema : Main document

Type: object

Title: Main document

Rules in main document

Show Source

• actions: array Actions
  Title: Actions

  Rules in actions
• attributes: array Attributes
  Title: Attributes

  Rules in attributes

{
    "type":"object",
    "properties":{
        "attributes":{
            "type":"array",
            "description":"Rules in attributes",
            "title":"Attributes",
            "items":{
                "type":"string",
                "description":"Rules in attributes",
                "title":"Attributes"
            }
        },
        "actions":{
            "type":"array",
            "description":"Rules in actions",
            "title":"Actions",
            "items":{
                "type":"string",
                "description":"Rules in actions",
                "title":"Actions"
            }
        }
    },
    "title":"Main document",
    "description":"Rules in main document"
}

Nested Schema : Sub document

Type: object

Title: Sub document

Rules in sub document

Show Source

• actions: array Actions
  Title: Actions

  Rules in actions
• attributes: array Attributes
  Title: Attributes

  Rules in attributes

{
    "type":"object",
    "properties":{
        "attributes":{
            "type":"array",
            "description":"Rules in attributes",
            "title":"Attributes",
            "items":{
                "type":"string",
                "description":"Rules in attributes",
                "title":"Attributes"
            }
        },
        "actions":{
            "type":"array",
            "description":"Rules in actions",
            "title":"Actions",
            "items":{
                "type":"string",
                "description":"Rules in actions",
                "title":"Actions"
            }
        }
    },
    "title":"Sub document",
    "description":"Rules in sub document"
}

Nested Schema : Actions

Type: array

Title: Actions

Rules in actions

Show Source

• Array of: string
  Title: Actions

  Rules in actions

{
    "type":"array",
    "description":"Rules in actions",
    "title":"Actions",
    "items":{
        "type":"string",
        "description":"Rules in actions",
        "title":"Actions"
    }
}

Nested Schema : Attributes

Type: array

Title: Attributes

Rules in attributes

Show Source

• Array of: string
  Title: Attributes

  Rules in attributes

{
    "type":"array",
    "description":"Rules in attributes",
    "title":"Attributes",
    "items":{
        "type":"string",
        "description":"Rules in attributes",
        "title":"Attributes"
    }
}

Nested Schema : Actions

Type: array

Title: Actions

Rules in actions

Show Source

• Array of: string
  Title: Actions

  Rules in actions

{
    "type":"array",
    "description":"Rules in actions",
    "title":"Actions",
    "items":{
        "type":"string",
        "description":"Rules in actions",
        "title":"Actions"
    }
}

Nested Schema : Attributes

Type: array

Title: Attributes

Rules in attributes

Show Source

• Array of: string
  Title: Attributes

  Rules in attributes

{
    "type":"array",
    "description":"Rules in attributes",
    "title":"Attributes",
    "items":{
        "type":"string",
        "description":"Rules in attributes",
        "title":"Attributes"
    }
}

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/v16/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