REST API Services for CPQ Cloud

Get Menu Items Metadata

get

/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems

This service returns the metadata for all menu items defined for the specified Commerce attribute.

Request

Path Parameters

attributeVarName: string

Attribute Variable Name
docVarName: string

Document Variable Name
processVarName: string

Process Variable Name

Response

Default Response

Root Schema : CommerceMenuItems-collection

Type: object

Show Source

items(optional): array items

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

Nested Schema : items

Type: array

Show Source

Array of: object CommerceMenuItems

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

Nested Schema : CommerceMenuItems

Type: object

Show Source

dateModified(optional): string

Title: Date Modified

Date Modified
displayValue(optional): string

Title: Display Text

Display Text
id(optional): integer

Title: Id

Primary Key of Commerce Attributes Menu Items
links(optional): object menuItemLinks
orderNumber(optional): integer

Title: Order Number

Order Number
value(optional): string

Title: Variable Name

Variable Name

{
    "properties":{
        "dateModified":{
            "title":"Date Modified",
            "description":"Date Modified",
            "type":"string"
        },
        "displayValue":{
            "title":"Display Text",
            "description":"Display Text",
            "type":"string"
        },
        "id":{
            "title":"Id",
            "description":"Primary Key of Commerce Attributes Menu Items",
            "type":"integer"
        },
        "orderNumber":{
            "title":"Order Number",
            "description":"Order Number",
            "type":"integer"
        },
        "value":{
            "title":"Variable Name",
            "description":"Variable Name",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/menuItemLinks"
        }
    }
}

Nested Schema : menuItemLinks

Type: object

Show Source

parent(optional): string

Link to parent Commerce process document attribute.

{
    "properties":{
        "parent":{
            "description":"Link to parent Commerce process document attribute.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to retrieve menu item metadata for the specified attribute 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/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t/menuItems

Response Body Sample

{
   "id": 36244404,
   "dateModified": "2014-02-24",
   "links": [{
         "rel": "self",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t/menuItems/36244404"
      }, {
         "rel": "parent",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t"
      }, {
         "rel": "child",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t/menuItems/36244404/translations"
      }
   ],
   "displayValue": "Net 30",
   "value": "Net 30",
   "orderNumber": 1
}, {
   "id": 36244405,
   "dateModified": "2014-02-24",
   "links": [{
         "rel": "self",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t/menuItems/36244405"
      }, {
         "rel": "parent",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t"
      }, {
         "rel": "child",
         "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t/menuItems/36244405/translations"
      }
   ],
   "displayValue": "Net 60",
   "value": "Net 60",
   "orderNumber": 2
}
], "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/attributes/paymentTerms_t/menuItems"
   }
]
}