Jump to

• Request
• Response
• Examples

Get Product Family Attribute Menu Item Metadata

get

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

This service returns the metadata for a specific menu item for an array set attribute of a Product Family.

Request

Path Parameters

• attributeVarName(required): string
  Attribute variable name.
• menuItemId(required): integer
  Primary key of menu item.
• prodFamVarName(required): string
  Product family variable name.

Query Parameters

• excludeLinks: string
  Exclude links.
• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Menu item details of an attribute defined at product family level.

Body ()

Root 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"
        }
    }
}

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"
}

Back to Top

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/36673411

Translations

The following components can be appended to the end of this endpoint to return translation metadata:

• /translations - This returns all language translations for the requested entity.
• /translations/{langCode} - This returns a specific language translation for the requested entity. Example: /translations/es

Response Body Sample

{
  "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
}

Back to Top