Jump to

• Request
• Response

Go to the next page in a configuration session.

post

/ccstore/v1/cpq/configurations/next

This endpoint goes to the next page in a configuration session for a product and returns its state, layout, and corresponding attribute data.

Request

Supported Media Types

• application/json

Body ()

Root Schema : NextConfigurationRequest

Type: object

Show Source

• arraySetLimit: number
  The number of results to return per page for any array sets that may be present in the response.
• cacheInstanceId(required): string
  When the action is to obtain the previous page, the request must contain the cacheInstanceId
• criteria: object criteria
  This is being used as filter to be used on the CPQ payload
• expand: string
  It can be layoutCache or layout. Default value is layout.
• locale: string
  The locale of the data to be retrieved from CPQ. When this isn't supplied, the value will be retrieved from the request header. Default value is 'us'.
• model(required): string
  The model to be configured.
• productFamily(required): string
  The productFamily of the model to be configured.
• productLine(required): string
  The productLine of the model to be configured.

{
    "type":"object",
    "required":[
        "productFamily",
        "productLine",
        "model",
        "cacheInstanceId"
    ],
    "properties":{
        "productFamily":{
            "description":"The productFamily of the model to be configured.",
            "type":"string"
        },
        "productLine":{
            "description":"The productLine of the model to be configured.",
            "type":"string"
        },
        "expand":{
            "description":"It can be layoutCache or layout. Default value is layout.",
            "type":"string"
        },
        "criteria":{
            "description":"This is being used as filter to be used on the CPQ payload",
            "type":"object",
            "properties":{
                "childDefs":{
                    "description":"This property contains the filter value to be used at CPQ.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "description":"Name can contain the state property value that is required.",
                                "type":"string"
                            }
                        }
                    }
                },
                "state":{
                    "description":"In case the state is passed as true, the state of the configurable attributes is returned in the response. Otherwise the state of the configurable attributes is not returned in the response.",
                    "type":"boolean"
                }
            }
        },
        "cacheInstanceId":{
            "description":"When the action is to obtain the previous page, the request must contain the cacheInstanceId",
            "type":"string"
        },
        "model":{
            "description":"The model to be configured.",
            "type":"string"
        },
        "locale":{
            "description":"The locale of the data to be retrieved from CPQ. When this isn't supplied, the value will be retrieved from the request header. Default value is 'us'.",
            "type":"string"
        },
        "arraySetLimit":{
            "description":"The number of results to return per page for any array sets that may be present in the response.",
            "type":"number"
        }
    },
    "example":{
        "productFamily":"test1",
        "productLine":"productLine1",
        "excludeLayoutProperties":[
            "labelAlignment",
            "labelSeparator",
            "showLabel",
            "labelWidth",
            "labelWidthUnits",
            "valuePosition",
            "valueWidth",
            "valueWidthUnits",
            "valueAlignment",
            "helpIconAlignment",
            "msgPlacement",
            "msgWidthUnits",
            "msgWidth",
            "menuImagePosition",
            "pricePosition",
            "language",
            "fieldAutoWidth",
            "showCalculator",
            "showRecMsg",
            "showConMsg",
            "showPrevValueMsg",
            "showDataTooltip",
            "showMenuImage",
            "setTypeOverridden",
            "defaultValueOverridden",
            "displayTypeOverridden",
            "jetDisplayTypeOverridden",
            "helpIcon",
            "showHelpIcon",
            "columnWidths",
            "fieldAlignment",
            "showTitleIcon",
            "showDescription",
            "titleIcon",
            "cssClass"
        ],
        "model":"model1",
        "currency":"USD",
        "locale":"en_US"
    }
}

Example:

{
    "productFamily":"test1",
    "productLine":"productLine1",
    "excludeLayoutProperties":[
        "labelAlignment",
        "labelSeparator",
        "showLabel",
        "labelWidth",
        "labelWidthUnits",
        "valuePosition",
        "valueWidth",
        "valueWidthUnits",
        "valueAlignment",
        "helpIconAlignment",
        "msgPlacement",
        "msgWidthUnits",
        "msgWidth",
        "menuImagePosition",
        "pricePosition",
        "language",
        "fieldAutoWidth",
        "showCalculator",
        "showRecMsg",
        "showConMsg",
        "showPrevValueMsg",
        "showDataTooltip",
        "showMenuImage",
        "setTypeOverridden",
        "defaultValueOverridden",
        "displayTypeOverridden",
        "jetDisplayTypeOverridden",
        "helpIcon",
        "showHelpIcon",
        "columnWidths",
        "fieldAlignment",
        "showTitleIcon",
        "showDescription",
        "titleIcon",
        "cssClass"
    ],
    "model":"model1",
    "currency":"USD",
    "locale":"en_US"
}

Nested Schema : criteria

Type: object

This is being used as filter to be used on the CPQ payload

Show Source

• childDefs: array childDefs
  This property contains the filter value to be used at CPQ.
• state: boolean
  In case the state is passed as true, the state of the configurable attributes is returned in the response. Otherwise the state of the configurable attributes is not returned in the response.

{
    "description":"This is being used as filter to be used on the CPQ payload",
    "type":"object",
    "properties":{
        "childDefs":{
            "description":"This property contains the filter value to be used at CPQ.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Name can contain the state property value that is required.",
                        "type":"string"
                    }
                }
            }
        },
        "state":{
            "description":"In case the state is passed as true, the state of the configurable attributes is returned in the response. Otherwise the state of the configurable attributes is not returned in the response.",
            "type":"boolean"
        }
    }
}

Nested Schema : childDefs

Type: array

This property contains the filter value to be used at CPQ.

Show Source

• Array of: object items

{
    "description":"This property contains the filter value to be used at CPQ.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Name can contain the state property value that is required.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Name can contain the state property value that is required.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Name can contain the state property value that is required.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

State, layout, and attribute data for a particular product.

Body ()

Root Schema : NextConfigurationRequest

Type: object

Show Source

• arraySetLimit: number
  The number of results to return per page for any array sets that may be present in the response.
• cacheInstanceId(required): string
  When the action is to obtain the previous page, the request must contain the cacheInstanceId
• criteria: object criteria
  This is being used as filter to be used on the CPQ payload
• expand: string
  It can be layoutCache or layout. Default value is layout.
• locale: string
  The locale of the data to be retrieved from CPQ. When this isn't supplied, the value will be retrieved from the request header. Default value is 'us'.
• model(required): string
  The model to be configured.
• productFamily(required): string
  The productFamily of the model to be configured.
• productLine(required): string
  The productLine of the model to be configured.

{
    "type":"object",
    "required":[
        "productFamily",
        "productLine",
        "model",
        "cacheInstanceId"
    ],
    "properties":{
        "productFamily":{
            "description":"The productFamily of the model to be configured.",
            "type":"string"
        },
        "productLine":{
            "description":"The productLine of the model to be configured.",
            "type":"string"
        },
        "expand":{
            "description":"It can be layoutCache or layout. Default value is layout.",
            "type":"string"
        },
        "criteria":{
            "description":"This is being used as filter to be used on the CPQ payload",
            "type":"object",
            "properties":{
                "childDefs":{
                    "description":"This property contains the filter value to be used at CPQ.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "description":"Name can contain the state property value that is required.",
                                "type":"string"
                            }
                        }
                    }
                },
                "state":{
                    "description":"In case the state is passed as true, the state of the configurable attributes is returned in the response. Otherwise the state of the configurable attributes is not returned in the response.",
                    "type":"boolean"
                }
            }
        },
        "cacheInstanceId":{
            "description":"When the action is to obtain the previous page, the request must contain the cacheInstanceId",
            "type":"string"
        },
        "model":{
            "description":"The model to be configured.",
            "type":"string"
        },
        "locale":{
            "description":"The locale of the data to be retrieved from CPQ. When this isn't supplied, the value will be retrieved from the request header. Default value is 'us'.",
            "type":"string"
        },
        "arraySetLimit":{
            "description":"The number of results to return per page for any array sets that may be present in the response.",
            "type":"number"
        }
    },
    "example":{
        "productFamily":"test1",
        "productLine":"productLine1",
        "excludeLayoutProperties":[
            "labelAlignment",
            "labelSeparator",
            "showLabel",
            "labelWidth",
            "labelWidthUnits",
            "valuePosition",
            "valueWidth",
            "valueWidthUnits",
            "valueAlignment",
            "helpIconAlignment",
            "msgPlacement",
            "msgWidthUnits",
            "msgWidth",
            "menuImagePosition",
            "pricePosition",
            "language",
            "fieldAutoWidth",
            "showCalculator",
            "showRecMsg",
            "showConMsg",
            "showPrevValueMsg",
            "showDataTooltip",
            "showMenuImage",
            "setTypeOverridden",
            "defaultValueOverridden",
            "displayTypeOverridden",
            "jetDisplayTypeOverridden",
            "helpIcon",
            "showHelpIcon",
            "columnWidths",
            "fieldAlignment",
            "showTitleIcon",
            "showDescription",
            "titleIcon",
            "cssClass"
        ],
        "model":"model1",
        "currency":"USD",
        "locale":"en_US"
    }
}

Example:

{
    "productFamily":"test1",
    "productLine":"productLine1",
    "excludeLayoutProperties":[
        "labelAlignment",
        "labelSeparator",
        "showLabel",
        "labelWidth",
        "labelWidthUnits",
        "valuePosition",
        "valueWidth",
        "valueWidthUnits",
        "valueAlignment",
        "helpIconAlignment",
        "msgPlacement",
        "msgWidthUnits",
        "msgWidth",
        "menuImagePosition",
        "pricePosition",
        "language",
        "fieldAutoWidth",
        "showCalculator",
        "showRecMsg",
        "showConMsg",
        "showPrevValueMsg",
        "showDataTooltip",
        "showMenuImage",
        "setTypeOverridden",
        "defaultValueOverridden",
        "displayTypeOverridden",
        "jetDisplayTypeOverridden",
        "helpIcon",
        "showHelpIcon",
        "columnWidths",
        "fieldAlignment",
        "showTitleIcon",
        "showDescription",
        "titleIcon",
        "cssClass"
    ],
    "model":"model1",
    "currency":"USD",
    "locale":"en_US"
}

Nested Schema : criteria

Type: object

This is being used as filter to be used on the CPQ payload

Show Source

• childDefs: array childDefs
  This property contains the filter value to be used at CPQ.
• state: boolean
  In case the state is passed as true, the state of the configurable attributes is returned in the response. Otherwise the state of the configurable attributes is not returned in the response.

{
    "description":"This is being used as filter to be used on the CPQ payload",
    "type":"object",
    "properties":{
        "childDefs":{
            "description":"This property contains the filter value to be used at CPQ.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Name can contain the state property value that is required.",
                        "type":"string"
                    }
                }
            }
        },
        "state":{
            "description":"In case the state is passed as true, the state of the configurable attributes is returned in the response. Otherwise the state of the configurable attributes is not returned in the response.",
            "type":"boolean"
        }
    }
}

Nested Schema : childDefs

Type: array

This property contains the filter value to be used at CPQ.

Show Source

• Array of: object items

{
    "description":"This property contains the filter value to be used at CPQ.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Name can contain the state property value that is required.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Name can contain the state property value that is required.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Name can contain the state property value that is required.",
            "type":"string"
        }
    }
}

400 Response

Bad request input data

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top