REST API Services for CPQ Cloud

Get PickList Options

post

/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_pickLists/pickListVarName/actions/getOptions

This action provides the dynamic values for the Pick List attribute available through a domain such as a Data Table or an Array. This endpoint consumes the filter value of the Pick List attribute and returns appropriate values in the response.

Request

Supported Media Types

application/json

Root Schema : pickListVarName-getOptionsRequest

Type: object

Show Source

cacheInstanceId: string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.

{
    "type":"object",
    "required":[
        "cacheInstanceId"
    ],
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        }
    }
}

Response

Supported Media Types

application/json

Default Response

Root Schema : pickListVarName-getOptionsResponse

Type: object

Show Source

cacheInstanceId(optional): string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.
items(optional): array items
variableName(optional): string

Title: Variable Name

It uniquely identifies the pick list.

{
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"It uniquely identifies the pick list.",
            "title":"Variable Name"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "title":"Value"
                    },
                    "displayValue":{
                        "type":"string",
                        "title":"Display Value"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

displayValue(optional): string

Title: Display Value
value(optional): string

Title: Value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "title":"Display Value"
        }
    }
}

Examples

The following example shows how to retrieve the dynamic values for the Pick List attribute through a domain by submitting a POST request to the REST resource using cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v7/configvision.laptops.ultra/_pickLists/cloudBackupSSPL/actions/getOptions

Request Body Sample

{
  "cacheInstanceId": "u0yaJyAJ3qAzSBtYde9XKNFLyN2D5SZtvILBLwYMTK0JSBwBHihPGLoMrOn4xo7e"
}

Response Body Sample

The following example shows the contents of the response body in JSON format:

{
  "cacheInstanceId": "u0yaJyAJ3qAzSBtYde9XKNFLyN2D5SZtvILBLwYMTK0JSBwBHihPGLoMrOn4xo7e",
  "variableName": "cloudBackupSSPL",
  "items": [{
      "value": "1 TB",
      "displayValue": "1 TB"
    }, {
      "value": "1 TB",
      "displayValue": "1 TB"
    }, {
      "value": "2 TB",
      "displayValue": "2 TB"
    }, {
      "value": "2 TB",
      "displayValue": "2 TB"
    }, {
      "value": "250 GB",
      "displayValue": "250 GB"
    }, {
      "value": "250 GB",
      "displayValue": "250 GB"
    }, {
      "value": "500 GB",
      "displayValue": "500 GB"
    }, {
      "value": "500 GB",
      "displayValue": "500 GB"
    }
  ],
  "links": [{
      "rel": "related",
      "href": "https://sitename.oracle.com/rest/v7/configvision.laptops.ultra/_pickLists/cloudBackupSSPL"
    }
  ]
}