Jump to

• Request
• Response

Reconfigure Transaction Line - Inbound

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_reconfigure_inbound_action

Use this endpoint to return to the transaction after editing a configuration. The functionality attached to this action won't fire until the user has returned to the transaction.

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.

Body ()

Root Schema : TransactionLine-ReconfigureInboundRequest

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.
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.
• selectionMode: string
  Title: Selection Mode

  Indicating how selections content should be interpreted, supported values are: 1) '' - content of 'selections' param OR 2) 'ResultSetExceptSelected' - all entries in result set except those listed in 'selections' param
• selections: array selections
• skipIntegration: boolean
  Title: skipIntegration

  If value for 'skipIntegration' is true, integration tab logic is skipped, otherwise(value is false or absent) it is executed.

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "selections":{
            "$ref":"#/definitions/selections"
        },
        "skipIntegration":{
            "type":"boolean",
            "description":"If value for 'skipIntegration' is true, integration tab logic is skipped, otherwise(value is false or absent) it is executed.",
            "title":"skipIntegration"
        },
        "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"
        },
        "selectionMode":{
            "type":"string",
            "description":"Indicating how selections content should be interpreted, supported values are: 1) '' - content of 'selections' param OR 2) 'ResultSetExceptSelected' - all entries in result set except those listed in 'selections' param",
            "title":"Selection Mode"
        }
    }
}

Nested Schema : selections

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : TransactionLine-ReconfigureInboundResponse

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.
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.
• warnings: object warnings
  Title: warnings

  warning messages

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "warnings":{
            "$ref":"#/definitions/warnings"
        },
        "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 : warnings

Type: object

Title: warnings

warning messages

Show Source

• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.

{
    "type":"object",
    "properties":{
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"warning message."
            }
        }
    },
    "title":"warnings",
    "description":"warning messages"
}

Nested Schema : Messages

Type: array

Title: Messages

Array of messages that have been generated for a specific object.

Show Source

• Array of: string
  warning message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"warning message."
    }
}

Back to Top