Jump to

• Request
• Response
• Examples

Get a Product Family Menu Item Definition

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}

Use this endpoint to retrieve a definition for the specified Product Family attribute menu item.

Request

Supported Media Types

• application/json

Path Parameters

• allProdFamsVarName(required): string
  Variable Name of All Product Families '_allProductFamilies'
• attributeVarName(required): string
  Variable Name of the Attribute
• menuItem_Id(required): integer
  Primary Key of the Resource
• prodFamVarName(required): string
  Variable Name of the Product Family.

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Config Menu Items

Type: object

Title: Config Menu Items

Show Source

• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  Primary Key of the Resource
• isOverride: string
  Title: Is Override

  Menu Item is on an overridden Config Attribute
• itemText: string
  Title: Menu Item Text

  Text of the Menu Item
• itemValue: string
  Title: Menu Item Value

  Value of the Menu Item
• orderNumber: integer
  Title: Order Number

  Order Number of Config Menu Item

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the Resource",
            "title":"Id"
        },
        "isOverride":{
            "type":"string",
            "description":"Menu Item is on an overridden Config Attribute",
            "title":"Is Override"
        },
        "itemText":{
            "type":"string",
            "description":"Text of the Menu Item",
            "title":"Menu Item Text"
        },
        "itemValue":{
            "type":"string",
            "description":"Value of the Menu Item",
            "title":"Menu Item Value"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order Number of Config Menu Item",
            "title":"Order Number"
        }
    },
    "title":"Config Menu Items"
}

Back to Top

Examples

The following example shows how to retrieve a catalog definition for the specified Product Family attribute menu item by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/attributes/processor/menuItems/36874194

Response Body Sample

{
  "orderNumber": 3,
  "itemValue": "Octa Core 2.3 GHz",
  "dateModified": "2019-05-07T15:19:44.000Z",
  "id": 36874194,
  "dateAdded": "2019-05-07T15:17:05.000Z",
  "itemText": "Octa Core 2.3 GHz",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/attributes/processor/menuItems/36874194"
    }, {
      "kind": "",
      "rel": "child",
      "name": "images",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/attributes/processor/menuItems/36874194/images"
    }, {
      "kind": "",
      "rel": "child",
      "name": "prices",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/attributes/processor/menuItems/36874194/prices"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/attributes/processor"
    }
  ]
}

Back to Top