Jump to

• Request
• Response

Get Model Array Set Attribute Menu Items Metadata

get

/rest/v19/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems

This service returns the metadata for all menu items for an attribute of a Model.

Request

Path Parameters

• arraySetVarName(required): string
  Array Set variable name.
• attributeVarName(required): string
  Array attribute variable name.
• modelVarName(required): string
  Model variable name.
• prodFamVarName(required): string
  Product family variable name.
• prodLineVarName(required): string
  Product line 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

All menu items of an array attribute defined at model level.

Body ()

Root Schema : menuItem-collection

Type: object

Show Source

• items: array Menu Items
  Title: Menu Items

  List of menu items.
• links: array links

{
    "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 : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

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

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

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: array links
• orderNumber: integer
  Title: Order Number

  Order number.
• quantityAttributeVarName: string
  Title: Quantity Attribute VarName

  Linked quantity attribute's variable name
• 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"
                }
            }
        },
        "quantityAttributeVarName":{
            "type":"string",
            "description":"Linked quantity attribute's variable name",
            "title":"Quantity Attribute VarName"
        },
        "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: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

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

Back to Top