Pipeline Viewer - Transaction Line
post
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_pipelineViewer
Use this endpoint to display rules that are in effect for the current Commerce process. This action returns only 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.
-
docNumber(required): integer
Unique number to be used as the sub-document identifier.
-
id(required): integer
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
-
subDocVarName(required): string
The variable name for the sub-document.
Root Schema : TransactionLine-_pipelineViewerRequest
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/json
Default Response
Root Schema : TransactionLine-_pipelineViewerResponse
Type:
Show Source
object
-
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.
Nested Schema : Rules
Type:
array
Title:
Rules
Rules associated with the transaction.
Show Source
-
Array of:
object Rule
Title:
Rule
Rule definition.
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
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
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
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
Nested Schema : Actions
Type:
array
Title:
Actions
Rules in actions
Show Source
-
Array of:
string
Title:
Actions
Rules in actions
Nested Schema : Attributes
Type:
array
Title:
Attributes
Rules in attributes
Show Source
-
Array of:
string
Title:
Attributes
Rules in attributes
Nested Schema : Actions
Type:
array
Title:
Actions
Rules in actions
Show Source
-
Array of:
string
Title:
Actions
Rules in actions
Nested Schema : Attributes
Type:
array
Title:
Attributes
Rules in attributes
Show Source
-
Array of:
string
Title:
Attributes
Rules in attributes
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/lineItem/2actions/_pipelineViewer
Response Body Sample
{ "cacheInstanceId": "bDYxrCAnUwiVpYXUGDoT1GilCF0CFMPEGTcuKCPER3QFuxHJf33AYtAU1atZItpt" }
Response Body Sample
{ "pipelineViewerRules": [{ "name": "Hiding: Unhide Rules- Hiding Panel Subdoc", "type": "Hiding Rule", "components": { "mainDoc": { "attributes": [], "actions": [] }, "subDoc": { "attributes": [ "Hiding Tab 3 Attribute 1 Subdoc [hidingTab3Attribute1Subdoc]", "Hiding Tab 1 Attribute 2 Subdoc [hidingTab1Attribute2Subdoc]", "Hiding Tab 2 Attribute 2 Subdoc [hidingTab2Attribute2Subdoc]", "Hiding Tab 1 Attribute 1 Subdoc [hidingTab1Attribute1Subdoc]" ], "actions": [] } } }, { "name": "Composite Sub Hiding", "type": "Hiding Rule", "components": { "mainDoc": { ... }, "subDoc": { ... } } }, { "name": "Constrain Commerce BOM Attribute Mapping Rules - Float to Float", "type": "Constraint Rule", "components": { "mainDoc": { ... }, "subDoc": { ... } } } ] }