Jump to

• Request
• Response
• Examples

Get All Pick List Options

post

/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_pickLists/actions/getOptions

This action provides the dynamic values for all the Pick List attributes in a given configuration available through the domain such as a Data Table or an Array. This endpoint retrieves a collection of pick lists and returns appropriate values in the response.

Request

Supported Media Types

• application/json

Path Parameters

• modelVarName(required): string
  The variable name of a Model
• prodFamVarName(required): string
  The variable name of a Product Family
• prodLineVarName(required): string
  The variable name of a Product Line

Body ()

Root Schema : getOptionsRequest

Type: object

Show Source

• cacheInstanceId(required): 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : getOptionsResponse

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.
• items: array items

{
    "type":"object",
    "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"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/_pickList"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Pick List
  Title: Pick List

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/_pickList"
    }
}

Nested Schema : Pick List

Type: object

Title: Pick List

Show Source

• items: array items
• variableName: 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"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "title":"Value"
                    },
                    "displayValue":{
                        "type":"string",
                        "title":"Display Value"
                    }
                }
            }
        }
    },
    "title":"Pick List"
}

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: string
  Title: Display Value
• value: string
  Title: Value

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

Back to Top

Examples

The following example shows how to retrieve the dynamic values for all Pick List attributes in a configuration 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/v16/configvision.laptops.ultra/_pickLists/actions/getOptions

Request Body Sample

{
  "cacheInstanceId": "Uxs6rmxWky7QRMKEHxUK5IKv12GLTm2EeohummhWiiFFE76kxiYvil1tJfcTEbrjv"
}
         

Response Body Sample

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

{
  "cacheInstanceId": "Uxs6rmxWky7QRMKEHxUK5IKv12GLTm2EeohummhWiiFFE76kxiYvil1tJfcTEbrjv",
  "items": [{
      "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/v16/configvision.laptops.ultra/_pickLists/cloudBackupSSPL"
        }
      ]
    }, {
      "variableName": "hardDrives",
      "items": [{
          "value": "1 TB 10k HDD",
          "displayValue": "1 TB 10k HDD"
        }, {
          "value": "1 TB 7200 HDD",
          "displayValue": "1 TB 7200 HDD"
        }, {
          "value": "120 GB SSD",
          "displayValue": "120 GB SSD"
        }, {
          "value": "146 GB 15k HDD",
          "displayValue": "146 GB 15k HDD"
        }, {
          "value": "2 TB 7200 HDD",
          "displayValue": "2 TB 7200 HDD"
        }, {
          "value": "240 GB SSD",
          "displayValue": "240 GB SSD"
        }, {
          "value": "4 TB 7200 HDD",
          "displayValue": "4 TB 7200 HDD"
        }, {
          "value": "450 GB 15k HDD",
          "displayValue": "450 GB 15k HDD"
        }, {
          "value": "480 GB SSD",
          "displayValue": "480 GB SSD"
        }, {
          "value": "500 GB 10k HDD",
          "displayValue": "500 GB 10k HDD"
        }
      ],
      "links": [{
          "rel": "related",
          "href": "https://sitename.oracle.com/rest/v16/configvision.laptops.ultra/_pickLists/hardDrives"
        }
      ]
    }
  ],
  "links": [{
      "rel": "related",
      "href": "https://sitename.oracle.com/rest/v16/configvision.laptops.ultra/_pickLists"
    }
  ]
}

Back to Top