Jump to

• Request
• Response

Performs a get picklist options action for a particular configuration.

post

/ccstore/v1/cpq/configurations/pickListOptions

This endpoint performs a get picklist options action for a particular configuration.

Request

Supported Media Types

• application/json

Body ()

Root Schema : PickListOptionsRequest

Type: object

Show Source

• cacheInstanceId(required): string
  The cache Instance Id of the current configuration
• model(required): string
  The model of the model to be configured.
• pickListVarName: string
  The variable name of the picklist options to be retrieved.
• 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"
        },
        "pickListVarName":{
            "description":"The variable name of the picklist options to be retrieved.",
            "type":"string"
        },
        "cacheInstanceId":{
            "description":"The cache Instance Id of the current configuration",
            "type":"string"
        },
        "model":{
            "description":"The model of the model to be configured.",
            "type":"string"
        }
    },
    "example":{
        "productFamily":"visionVehicles",
        "productLine":"consumerVehicles",
        "cacheInstanceId":"guVTIijM2GvWEGaiE3pRij7wleLOIFLczSqL7c8j3ANSIOBB9JVd3AzRUVkoKCLt",
        "model":"sUV"
    }
}

Example:

{
    "productFamily":"visionVehicles",
    "productLine":"consumerVehicles",
    "cacheInstanceId":"guVTIijM2GvWEGaiE3pRij7wleLOIFLczSqL7c8j3ANSIOBB9JVd3AzRUVkoKCLt",
    "model":"sUV"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The options associated to a particular picklist.

Body ()

Root Schema : PickListOptionsResponse

Type: object

Show Source

• cacheInstanceId: string
  The cache Instance Id of the current configuration
• items: array items

{
    "type":"object",
    "properties":{
        "cacheInstanceId":{
            "description":"The cache Instance Id of the current configuration",
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "variableName":{
                        "description":"Name of the picklist.",
                        "type":"string"
                    },
                    "items":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "displayValue":{
                                    "type":"string"
                                },
                                "value":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "example":{
        "cacheInstanceId":"guVTIijM2GvWEGaiE3pRij7wleLOIFLczSqL7c8j3ANSIOBB9JVd3AzRUVkoKCLt",
        "items":[
            {
                "variableName":"picklist1",
                "items":[
                    {
                        "displayValue":"",
                        "value":""
                    },
                    {
                        "displayValue":"a",
                        "value":"a"
                    },
                    {
                        "displayValue":"b",
                        "value":"b"
                    },
                    {
                        "displayValue":"c d e",
                        "value":"c d e"
                    },
                    {
                        "displayValue":"f",
                        "value":"f"
                    }
                ]
            },
            {
                "variableName":"currency",
                "items":[
                    {
                        "displayValue":"",
                        "value":""
                    },
                    {
                        "displayValue":"Canadian Dollar",
                        "value":"Canadian Dollar"
                    },
                    {
                        "displayValue":"Dollar",
                        "value":"Dollar"
                    },
                    {
                        "displayValue":"Euro",
                        "value":"Euro"
                    },
                    {
                        "displayValue":"INR",
                        "value":"INR"
                    }
                ]
            }
        ]
    }
}

Example:

{
    "cacheInstanceId":"guVTIijM2GvWEGaiE3pRij7wleLOIFLczSqL7c8j3ANSIOBB9JVd3AzRUVkoKCLt",
    "items":[
        {
            "variableName":"picklist1",
            "items":[
                {
                    "displayValue":"",
                    "value":""
                },
                {
                    "displayValue":"a",
                    "value":"a"
                },
                {
                    "displayValue":"b",
                    "value":"b"
                },
                {
                    "displayValue":"c d e",
                    "value":"c d e"
                },
                {
                    "displayValue":"f",
                    "value":"f"
                }
            ]
        },
        {
            "variableName":"currency",
            "items":[
                {
                    "displayValue":"",
                    "value":""
                },
                {
                    "displayValue":"Canadian Dollar",
                    "value":"Canadian Dollar"
                },
                {
                    "displayValue":"Dollar",
                    "value":"Dollar"
                },
                {
                    "displayValue":"Euro",
                    "value":"Euro"
                },
                {
                    "displayValue":"INR",
                    "value":"INR"
                }
            ]
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "variableName":{
                "description":"Name of the picklist.",
                "type":"string"
            },
            "items":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "displayValue":{
                            "type":"string"
                        },
                        "value":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• items: array items
• variableName: string
  Name of the picklist.

{
    "type":"object",
    "properties":{
        "variableName":{
            "description":"Name of the picklist.",
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayValue":{
                        "type":"string"
                    },
                    "value":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayValue":{
                "type":"string"
            },
            "value":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayValue: string
• value: string

{
    "type":"object",
    "properties":{
        "displayValue":{
            "type":"string"
        },
        "value":{
            "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