REST API Services for Oracle CPQ

Get Product Family Attribute Menu Items Metadata

get

/rest/v16/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems

Get all menu items of an attribute defined at product family level.

Request

Path Parameters

attributeVarName(required): string

Attribute variable name.
prodFamVarName(required): string

Product family variable name.

Query Parameters

excludeLinks: string

Exclude links.
expand: string

Allows expansion of relationships.

Response

Supported Media Types

application/json

Default Response

All menu items of an attribute defined at product family level.

Root Schema : menuItem-collection

Type: object

Show Source

items: array Menu Items

Title: Menu Items

List of menu items.
links: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of menu items.",
            "title":"Menu Items",
            "items":{
                "$ref":"#/definitions/menuItem"
            }
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : Menu Items

Type: array

Title: Menu Items

List of menu items.

Show Source

Array of: object menuItem

{
    "type":"array",
    "description":"List of menu items.",
    "title":"Menu Items",
    "items":{
        "$ref":"#/definitions/menuItem"
    }
}

Nested Schema : Reference Links

Type: object

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

href: string

Title: href

URL to the related object
rel: string

Title: Link

Link relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relationship to the current object",
            "title":"Link"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"href"
        }
    },
    "title":"Reference Links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : menuItem

Type: object

Show Source

avp: object avp
dateModified: string

Title: Date Last Modified

System field indicating the date on which the object was last modified.
displayValue: string

Title: Display Text

Display text.
id: integer

Title: Id

Primary key of the menu item.
imageUrl: string

Title: Image Url

Image Url.
links: object Reference Links

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable
orderNumber: integer

Title: Order Number

Order number.
value: string

Title: Variable Name

Variable name.

{
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary key of the menu item.",
            "title":"Id "
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the object was last modified.",
            "title":"Date Last Modified"
        },
        "displayValue":{
            "type":"string",
            "description":"Display text.",
            "title":"Display Text"
        },
        "value":{
            "type":"string",
            "description":"Variable name.",
            "title":"Variable Name"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order number.",
            "title":"Order Number"
        },
        "imageUrl":{
            "type":"string",
            "description":"Image Url.",
            "title":"Image Url"
        },
        "avp":{
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "description":"Currency Code.",
                    "title":"Currency Code"
                },
                "value":{
                    "type":"string",
                    "description":"Price.",
                    "title":"Price"
                }
            }
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : avp

Type: object

Show Source

currency: string

Title: Currency Code

Currency Code.
value: string

Title: Price

Price.

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "description":"Currency Code.",
            "title":"Currency Code"
        },
        "value":{
            "type":"string",
            "description":"Price.",
            "title":"Price"
        }
    }
}

Examples

The following example shows how to retrieve the metadata for the specified Configuration item by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems

Response Body Sample

{
  "items": [{
      "id": 36673406,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673406"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673406/translations"
        }
      ],
      "displayValue": "All Operating Systems",
      "value": "All Operating Systems",
      "orderNumber": 1
    }, {
      "id": 36673407,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673407"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673407/translations"
        }
      ],
      "displayValue": "Oracle Linux",
      "value": "Oracle Linux",
      "orderNumber": 2
    }, {
      "id": 36673408,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673408"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673408/translations"
        }
      ],
      "displayValue": "Ubuntu Server Edition",
      "value": "Ubuntu Server Edition",
      "orderNumber": 3
    }, {
      "id": 36673409,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673409"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673409/translations"
        }
      ],
      "displayValue": "openSUSE Linux Enterprise Server",
      "value": "openSUSE Linux Enterprise Server",
      "orderNumber": 4
    }, {
      "id": 36673410,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673410"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673410/translations"
        }
      ],
      "displayValue": "Blue Hat Enterprise Premium",
      "value": "Blue Hat Enterprise Premium",
      "orderNumber": 5
    }, {
      "id": 36673411,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673411"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673411/translations"
        }
      ],
      "displayValue": "Blue Hat Enterprise Standard",
      "value": "Blue Hat Enterprise Standard",
      "orderNumber": 6
    }, {
      "id": 36673412,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673412"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673412/translations"
        }
      ],
      "displayValue": "Blue Hat Enterprise Self-Support",
      "value": "Blue Hat Enterprise Self-Support",
      "orderNumber": 7
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems"
    }
  ]
}