Jump to

• Request
• Response

Get Menu Item Definitions

post

/config/sim/v1/menuItems/getMenuItemDefinitions

Gets all the Menu Item Definitions configured and hierarchy unit

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : MenuItemDefinitionGetRequestBody

Type: object

Show Source

• hierUnitId: integer
  Hierarchy unit unique reference

  Example: 1012
• include(optional): string
  Example: locations
• languages(optional): string
  If specified, limits translated strings returned.

  Example: en-US, es-SS,lt-LT
• limit(optional): integer
  Number of results returned in this page. Not required if paging parameters are not supported.

  Example: 10
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported

  Example: 2
• orderBy(optional): string
  Sorts the response by the specified field name and sort order.

  Example: comboMealGroups.objectNum
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "properties":{
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"comboMealGroups.objectNum",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-SS,lt-LT",
            "description":"If specified, limits translated strings returned."
        },
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy unit unique reference"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of menuItemDefintions for the Hierarchy

Body ()

Root Schema : MenuItemDefinition

Type: object

Show Source

• components(optional): array components
  An array of components associated with the menu item
• consumerAdvisoryDesc(optional): string
  The consumer advisory description of the menu item

  Example: Menu Item 1
• consumerItemDescription(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• consumerItemName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• customMenuLevels(optional): array customMenuLevels
  An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured
• dataExtensions(optional): array dataExtensions
  An array of data extensions for the menu item
• defaultCondiments(optional): array defaultCondiments
  An array of Default Condiment of a Menu Item
• defSequenceNum: integer
  Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64

  Example: 1
• firstName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• guestCount(optional): integer
  Guest count for the menu item to increment the check guest count when added.

  Example: 1
• hierUnitId: integer
  Hierarchy unit unique reference

  Example: 1012
• images(optional): array images
  An array of images associated with the menu item
• kdsPrepTime(optional): integer
  The number of minutes necessary to prepare this item

  Example: 10.3
• longDescriptor(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• mainLevel(optional): string
  Main Levels on which the definition is active.

  Example: 11001111
• mainLevelExt(optional): object MenuItem_mainLevelExt
  An object containing the descriptive options list associated with the Main level
• menuItemClassObjNum(optional): integer
  Object number of the menu item Class

  Example: 1
• menuItemDefinitionId: integer
  The unique reference for the Menu Item Definition

  Example: 1
• menuItemMasterId: integer
  The unique reference for the Menu Item Master

  Example: 1
• nluGroupObjNum(optional): integer
  Object number of the NLU Group associated with this menu item

  Example: 1
• nluNum(optional):
  Unique NLU number for this menu item (up to 12 digits).

  Example: 1
• nutrients(optional): array nutrients
  An array of nutrients of the menu item
• overrideAllergenClassObjNum(optional): integer
  Object number of the Allergen Class for the menu item definition to override its menu item class setting

  Example: 1
• overridePrintClassObjNum(optional): integer
  Object number of the Print Class

  Example: 1
• prefixLevelOverride(optional): integer
  Select to allow the condiment prefix to override the price level of the item it modifies.

  Example: 1
• productionItems(optional): array productionItems
  An array of production items associated with the menu item
• quantity(optional): integer
  Quantity of a Menu Item

  Example: 1
• secondName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• slu(optional): array slu
  Array of SLU keys and names to which the Menu Item Definition belongs
• sluSortPriority(optional): integer
  Use this field when Page Design Layout option

  Example: 0
• subLevel(optional): string
  Sub Levels on which the definition is active

  Example: 11001111
• subLevelExt(optional): object MenuItem_subLevelExt
  An object containing the descriptive options list associated with the Sub Level
• surcharge(optional): integer
  Surcharge for the menu item

  Example: 1
• tags(optional): array tags
  An array of tags associated with the menu item
• tareWeight(optional): integer
  Weight of the empty package for an item sold by weight

  Example: 1.23
• thirdName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

{
    "type":"object",
    "required":[
        "hierUnitId",
        "menuItemMasterId",
        "defSequenceNum",
        "menuItemDefinitionId"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy unit unique reference"
        },
        "menuItemMasterId":{
            "type":"integer",
            "example":1,
            "description":"The unique reference for the Menu Item Master"
        },
        "menuItemDefinitionId":{
            "type":"integer",
            "example":1,
            "description":"The unique reference for the Menu Item Definition"
        },
        "defSequenceNum":{
            "type":"integer",
            "example":1,
            "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64"
        },
        "firstName":{
            "description":"A group of string objects representing the name of the Menu Item in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "secondName":{
            "description":"A group of string objects representing the alternate name (Name 2) of the Menu Item in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "thirdName":{
            "description":"A group of string objects representing the alternate name (Name 3) of the Menu Item in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "longDescriptor":{
            "description":"A group of string objects representing the long descriptor of the Menu Item in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "menuItemClassObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu item Class"
        },
        "overridePrintClassObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Print Class"
        },
        "mainLevel":{
            "type":"string",
            "example":"11001111",
            "description":"Main Levels on which the definition is active."
        },
        "mainLevelExt":{
            "$ref":"#/definitions/MenuItem_mainLevelExt"
        },
        "subLevel":{
            "type":"string",
            "example":"11001111",
            "description":"Sub Levels on which the definition is active"
        },
        "subLevelExt":{
            "$ref":"#/definitions/MenuItem_subLevelExt"
        },
        "slu":{
            "type":"array",
            "description":"Array of SLU keys and names to which the Menu Item Definition belongs",
            "items":{
                "$ref":"#/definitions/MenuItem_slu"
            }
        },
        "sluSortPriority":{
            "type":"integer",
            "example":0,
            "description":"Use this field when Page Design Layout option"
        },
        "nluGroupObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the NLU Group associated with this menu item"
        },
        "nluNum":{
            "example":"1",
            "description":"Unique NLU number for this menu item (up to 12 digits)."
        },
        "tareWeight":{
            "type":"integer",
            "example":"1.23",
            "description":"Weight of the empty package for an item sold by weight"
        },
        "surcharge":{
            "type":"integer",
            "example":1,
            "description":"Surcharge for the menu item"
        },
        "quantity":{
            "type":"integer",
            "example":1,
            "description":"Quantity of a Menu Item"
        },
        "overrideAllergenClassObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting"
        },
        "kdsPrepTime":{
            "type":"integer",
            "example":"10.3",
            "description":"The number of minutes necessary to prepare this item"
        },
        "prefixLevelOverride":{
            "type":"integer",
            "example":1,
            "description":"Select to allow the condiment prefix to override the price level of the item it modifies."
        },
        "guestCount":{
            "type":"integer",
            "example":1,
            "description":"Guest count for the menu item to increment the check guest count when added."
        },
        "consumerAdvisoryDesc":{
            "type":"string",
            "example":"Menu Item 1",
            "description":"The consumer advisory description of the menu item"
        },
        "consumerItemName":{
            "description":"A group of string objects representing the consumer description in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "consumerItemDescription":{
            "description":"A group of string objects representing the consumer description in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "images":{
            "type":"array",
            "description":"An array of images associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_image"
            }
        },
        "customMenuLevels":{
            "type":"array",
            "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured",
            "items":{
                "$ref":"#/definitions/MenuItem_customMenuLevel"
            }
        },
        "defaultCondiments":{
            "type":"array",
            "description":"An array of Default Condiment of a Menu Item",
            "items":{
                "$ref":"#/definitions/MenuItem_defaultCondiment"
            }
        },
        "productionItems":{
            "type":"array",
            "description":"An array of production items associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_productionItem"
            }
        },
        "components":{
            "type":"array",
            "description":"An array of components associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_component"
            }
        },
        "tags":{
            "type":"array",
            "description":"An array of tags associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_tag"
            }
        },
        "nutrients":{
            "type":"array",
            "description":"An array of nutrients of the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_nutrient"
            }
        },
        "dataExtensions":{
            "type":"array",
            "description":"An array of data extensions for the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_dataExtensions"
            }
        }
    }
}

Nested Schema : components

Type: array

An array of components associated with the menu item

Show Source

• Array of: object MenuItem_component

{
    "type":"array",
    "description":"An array of components associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_component"
    }
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\", \"ar-AR\": \"????????\" }`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "ar-AR":"????????"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "ar-AR":"????????"
}

Nested Schema : customMenuLevels

Type: array

An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured

Show Source

• Array of: object MenuItem_customMenuLevel

{
    "type":"array",
    "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured",
    "items":{
        "$ref":"#/definitions/MenuItem_customMenuLevel"
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the menu item

Show Source

• Array of: object MenuItem_dataExtensions

{
    "type":"array",
    "description":"An array of data extensions for the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_dataExtensions"
    }
}

Nested Schema : defaultCondiments

Type: array

An array of Default Condiment of a Menu Item

Show Source

• Array of: object MenuItem_defaultCondiment

{
    "type":"array",
    "description":"An array of Default Condiment of a Menu Item",
    "items":{
        "$ref":"#/definitions/MenuItem_defaultCondiment"
    }
}

Nested Schema : images

Type: array

An array of images associated with the menu item

Show Source

• Array of: object MenuItem_image

{
    "type":"array",
    "description":"An array of images associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_image"
    }
}

Nested Schema : MenuItem_mainLevelExt

Type: object

An object containing the descriptive options list associated with the Main level

Show Source

• mainLevel1(optional): boolean
  Flag indicating if the menu item is active on Main Level 1

  Example: false
• mainLevel2(optional): boolean
  Flag indicating if the menu item is active on Main Level 2

  Example: false
• mainLevel3(optional): boolean
  Flag indicating if the menu item is active on Main Level 3

  Example: false
• mainLevel4(optional): boolean
  Flag indicating if the menu item is active on Main Level 4

  Example: false
• mainLevel5(optional): boolean
  Flag indicating if the menu item is active on Main Level 5

  Example: false
• mainLevel6(optional): boolean
  Flag indicating if the menu item is active on Main Level 6

  Example: false
• mainLevel7(optional): boolean
  Flag indicating if the menu item is active on Main Level 7

  Example: false
• mainLevel8(optional): boolean
  Flag indicating if the menu item is active on Main Level 8

  Example: false

{
    "type":"object",
    "properties":{
        "mainLevel1":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Main Level 1"
        },
        "mainLevel2":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Main Level 2"
        },
        "mainLevel3":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Main Level 3"
        },
        "mainLevel4":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Main Level 4"
        },
        "mainLevel5":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Main Level 5"
        },
        "mainLevel6":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Main Level 6"
        },
        "mainLevel7":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Main Level 7"
        },
        "mainLevel8":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Main Level 8"
        }
    },
    "description":"An object containing the descriptive options list associated with the Main level"
}

Nested Schema : nutrients

Type: array

An array of nutrients of the menu item

Show Source

• Array of: object MenuItem_nutrient

{
    "type":"array",
    "description":"An array of nutrients of the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_nutrient"
    }
}

Nested Schema : productionItems

Type: array

An array of production items associated with the menu item

Show Source

• Array of: object MenuItem_productionItem

{
    "type":"array",
    "description":"An array of production items associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_productionItem"
    }
}

Nested Schema : slu

Type: array

Array of SLU keys and names to which the Menu Item Definition belongs

Show Source

• Array of: object MenuItem_slu

{
    "type":"array",
    "description":"Array of SLU keys and names to which the Menu Item Definition belongs",
    "items":{
        "$ref":"#/definitions/MenuItem_slu"
    }
}

Nested Schema : MenuItem_subLevelExt

Type: object

An object containing the descriptive options list associated with the Sub Level

Show Source

• subLevel1(optional): boolean
  Flag indicating if the menu item is active on Sub Level 1

  Example: false
• subLevel2(optional): boolean
  Flag indicating if the menu item is active on Sub Level 2

  Example: false
• subLevel3(optional): boolean
  Flag indicating if the menu item is active on Sub Level 3

  Example: false
• subLevel4(optional): boolean
  Flag indicating if the menu item is active on Sub Level 4

  Example: false
• subLevel5(optional): boolean
  Flag indicating if the menu item is active on Sub Level 5

  Example: false
• subLevel6(optional): boolean
  Flag indicating if the menu item is active on Sub Level 6

  Example: false
• subLevel7(optional): boolean
  Flag indicating if the menu item is active on Sub Level 7

  Example: false
• subLevel8(optional): boolean
  Flag indicating if the menu item is active on Sub Level 8

  Example: false

{
    "type":"object",
    "properties":{
        "subLevel1":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Sub Level 1"
        },
        "subLevel2":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Sub Level 2"
        },
        "subLevel3":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Sub Level 3"
        },
        "subLevel4":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Sub Level 4"
        },
        "subLevel5":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Sub Level 5"
        },
        "subLevel6":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Sub Level 6"
        },
        "subLevel7":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Sub Level 7"
        },
        "subLevel8":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if the menu item is active on Sub Level 8"
        }
    },
    "description":"An object containing the descriptive options list associated with the Sub Level"
}

Nested Schema : tags

Type: array

An array of tags associated with the menu item

Show Source

• Array of: object MenuItem_tag

{
    "type":"array",
    "description":"An array of tags associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_tag"
    }
}

Nested Schema : MenuItem_component

Type: object

Show Source

• componentObjNum(optional): integer
  Object number of the component

  Example: 1

{
    "type":"object",
    "properties":{
        "componentObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the component"
        }
    }
}

Nested Schema : MenuItem_customMenuLevel

Type: object

Show Source

• customLevel(optional): string
  Flag indicating if the menu item is active on Custom Level

  Example: 11001111
• menuLevelObjNum(optional): integer
  Object number of the menu level

  Example: 3

{
    "type":"object",
    "properties":{
        "menuLevelObjNum":{
            "type":"integer",
            "example":3,
            "description":"Object number of the menu level"
        },
        "customLevel":{
            "type":"string",
            "example":"11001111",
            "description":"Flag indicating if the menu item is active on Custom Level"
        }
    }
}

Nested Schema : MenuItem_dataExtensions

Type: object

Show Source

• columnName(optional): string
  Name of the extention field

  Example: extension column 1
• value(optional): string
  Value of the extention field

  Example: value 1

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "example":"extension column 1",
            "description":"Name of the extention field"
        },
        "value":{
            "type":"string",
            "example":"value 1",
            "description":"Value of the extention field"
        }
    }
}

Nested Schema : MenuItem_defaultCondiment

Type: object

Show Source

• condimentSetObjNum(optional): integer
  Object number of the condiment set

  Example: 1
• options(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the default condiments of the menu item

  Example: 1000000
• sortGroup(optional): integer
  Sort group of the condiment set

  Example: 1

{
    "type":"object",
    "properties":{
        "condimentSetObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the condiment set"
        },
        "sortGroup":{
            "type":"integer",
            "example":1,
            "description":"Sort group of the condiment set"
        },
        "options":{
            "type":"string",
            "example":"1000000",
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the default condiments of the menu item"
        }
    }
}

Nested Schema : MenuItem_image

Type: object

Show Source

• altText(optional): string
  The image alternative text of the menu item

  Example: pizza
• description(optional): string
  The description text of the menu item

  Example: pizza description
• imageIndex(optional): integer
  Image Number for reference

  Example: 1
• isCloudImage(optional): boolean
  Flag indicating if the image is stored on the Cloud

  Example: true
• size(optional): string
  The size of the image

  Example: 1
• url(optional): string
  The URL of the image of the menu item

  Example: https://oracleObjectStore.com/images/coffee822815.jpg

{
    "type":"object",
    "properties":{
        "imageIndex":{
            "type":"integer",
            "example":1,
            "description":"Image Number for reference"
        },
        "url":{
            "type":"string",
            "example":"https://oracleObjectStore.com/images/coffee822815.jpg",
            "description":"The URL of the image of the menu item"
        },
        "altText":{
            "type":"string",
            "example":"pizza",
            "description":"The image alternative text of the menu item"
        },
        "description":{
            "type":"string",
            "example":"pizza description",
            "description":"The description text of the menu item"
        },
        "isCloudImage":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if the image is stored on the Cloud"
        },
        "size":{
            "type":"string",
            "example":"1",
            "description":"The size of the image"
        }
    }
}

Nested Schema : MenuItem_nutrient

Type: object

Show Source

• menuItemNutrientSetId(optional): integer
  Unique reference of the menu item nutrient

  Example: 1
• nutrientSetObjNum(optional): integer
  Object number of the nutrient set

  Example: 1

{
    "type":"object",
    "properties":{
        "nutrientSetObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the nutrient set"
        },
        "menuItemNutrientSetId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the menu item nutrient"
        }
    }
}

Nested Schema : MenuItem_productionItem

Type: object

Show Source

• productionItemCount(optional): integer
  The number of portions required to complete the menu item.

  Example: 1.4
• productionItemObjNum(optional): integer
  Object number of the production item

  Example: false

{
    "type":"object",
    "properties":{
        "productionItemObjNum":{
            "type":"integer",
            "example":"false",
            "description":"Object number of the production item"
        },
        "productionItemCount":{
            "type":"integer",
            "example":"1.4",
            "description":"The number of portions required to complete the menu item."
        }
    }
}

Nested Schema : MenuItem_slu

Type: object

Show Source

• sluName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• sluObjNum(optional): integer
  Object number of the SLU key to which the Menu Item Definition belongs

  Example: 1
• sluSeqNum(optional): integer
  SLU sequence to which the Menu Item Definition belongs. This value ranges between 1-8

  Example: 1

{
    "type":"object",
    "properties":{
        "sluSeqNum":{
            "type":"integer",
            "example":1,
            "description":"SLU sequence to which the Menu Item Definition belongs. This value ranges between 1-8"
        },
        "sluObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the SLU key to which the Menu Item Definition belongs"
        },
        "sluName":{
            "description":"A group of string objects representing the name of SLU in configured languages",
            "$ref":"#/definitions/TranslatedString"
        }
    }
}

Nested Schema : MenuItem_tag

Type: object

Show Source

• tagName(optional): string
  The name of Tag associated with the menu item

  Example: Tag

{
    "type":"object",
    "properties":{
        "tagName":{
            "type":"string",
            "example":"Tag",
            "description":"The name of Tag associated with the menu item"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top