Jump to

• Request
• Response

External Configurator

post

/rest/v16/productFamilies/{pfVar}/productLines/{plVar}/models/{modelVar}/actions/_externalConfigurationSave

This service invokes the External Configurator Advanced Save function.

Request

Path Parameters

• modelVar(required): string
  The variable name of the model
• pfVar(required): string
  The variable name of the product family
• plVar(required): string
  The variable name of the product line

Body ()

Root Schema : externalConfigurationSave-Request

Type: object

Show Source

• bsId: integer
  Title: Buy-side ID

  CPQ transaction ID. Required for reconfiguration and add-from-catalog configuration.
• documentNumber: integer
  Title: Document Number

  The document number of a model line. Required for reconfiguration.
• reconfigActionVarName: string
  Title: Reconfiguration Action Variable Name

  For reconfiguration only. If absent, defaulting to _reconfigure_action.
• reconfigSource: string
  Title: Reconfiguration Source

  For reconfiguration only. The entity that the reconfiguration is invoked on. Valid values: Quote, Line Item. For reconfiguration only.

{
    "properties":{
        "bsId":{
            "title":"Buy-side ID",
            "description":"CPQ transaction ID. Required for reconfiguration and add-from-catalog configuration.",
            "type":"integer"
        },
        "documentNumber":{
            "title":"Document Number",
            "description":"The document number of a model line. Required for reconfiguration.",
            "type":"integer"
        },
        "reconfigActionVarName":{
            "title":"Reconfiguration Action Variable Name",
            "description":"For reconfiguration only. If absent, defaulting to _reconfigure_action.",
            "type":"string"
        },
        "reconfigSource":{
            "title":"Reconfiguration Source",
            "description":"For reconfiguration only. The entity that the reconfiguration is invoked on. Valid values: Quote, Line Item. For reconfiguration only.",
            "type":"string"
        }
    }
}

Back to Top

Response

Default Response

Body ()

Root Schema : externalConfigurationSave-Response

Type: object

Show Source

• bsId: integer
  Title: Buy-side ID

  The CPQ transaction ID. Present only if the status is save.
• documentNumber: integer
  Title: Document Number

  The document number of the model line that is saved. Present only if the status is save.
• href: string
  Title: Transaction Hyperlink

  The REST end point to retrieve the saved transaction (quote). Present only if the status is save.
• status: string
  Title: Status

  The status of the save action. Valid values: save, cancel, none.

{
    "properties":{
        "status":{
            "title":"Status",
            "description":"The status of the save action. Valid values: save, cancel, none.",
            "type":"string"
        },
        "bsId":{
            "title":"Buy-side ID",
            "description":"The CPQ transaction ID. Present only if the status is save.",
            "type":"integer"
        },
        "documentNumber":{
            "title":"Document Number",
            "description":"The document number of the model line that is saved. Present only if the status is save.",
            "type":"integer"
        },
        "href":{
            "title":"Transaction Hyperlink",
            "description":"The REST end point to retrieve the saved transaction (quote). Present only if the status is save.",
            "type":"string"
        }
    }
}

Back to Top