Configuration and Content API Guide

Get Menu Items 2

post

/config/sim/v2/menuItems/getMenuItem2

Gets all the Menu Items configured and hierarchy unit

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
menuItemMasterId(required): integer

Unique menu item master reference

Example: 1
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "required":[
        "menuItemMasterId"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        },
        "menuItemMasterId":{
            "type":"integer",
            "example":1,
            "description":"Unique menu item master reference"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Menu Item Defintions

Root Schema : schema

Type: object

Show Source

count: integer

Current response record count.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Menu Item objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Menu Item objects of the organization.",
            "items":{
                "$ref":"#/definitions/MenuItem2v2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Menu Item objects of the organization.

Show Source

Array of: object MenuItem2v2

{
    "type":"array",
    "description":"Array of Menu Item objects of the organization.",
    "items":{
        "$ref":"#/definitions/MenuItem2v2"
    }
}

Nested Schema : MenuItem2v2

Type: object

Show Source

definitions: array definitions

An Array of Menu Item Definitions
hierUnitId: integer

Unique hierarchy unit reference

Example: 2
menuItemMasterId: integer

Unique menu item master reference

Example: 1
objectNum: integer

Menu item master object number

Example: 1

{
    "type":"object",
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item master object number"
        },
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "menuItemMasterId":{
            "type":"integer",
            "example":1,
            "description":"Unique menu item master reference"
        },
        "definitions":{
            "type":"array",
            "description":"An Array of Menu Item Definitions",
            "items":{
                "$ref":"#/definitions/MenuItem_definitionv2"
            }
        }
    }
}

Nested Schema : definitions

Type: array

An Array of Menu Item Definitions

Show Source

Array of: object MenuItem_definitionv2

{
    "type":"array",
    "description":"An Array of Menu Item Definitions",
    "items":{
        "$ref":"#/definitions/MenuItem_definitionv2"
    }
}

Nested Schema : MenuItem_definitionv2

Type: object

Show Source

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
hierUnitId: integer

Menu Item definition Hierarchy Unit Id

Example: 1
menuItemDefinitionId: integer

Unique reference for the menu item definition

Example: 1
prices: array prices

An array of Menu Item Prices

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Menu Item definition Hierarchy Unit Id"
        },
        "menuItemDefinitionId":{
            "type":"integer",
            "example":1,
            "description":"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"
        },
        "prices":{
            "type":"array",
            "description":"An array of Menu Item Prices",
            "items":{
                "$ref":"#/definitions/MenuItem_menuItemPricev2"
            }
        }
    }
}

Nested Schema : prices

Type: array

An array of Menu Item Prices

Show Source

Array of: object MenuItem_menuItemPricev2

Model for Menu Item Price object

{
    "type":"array",
    "description":"An array of Menu Item Prices",
    "items":{
        "$ref":"#/definitions/MenuItem_menuItemPricev2"
    }
}

Nested Schema : MenuItem_menuItemPricev2

Type: object

Model for Menu Item Price object

Show Source

hierUnitId: integer

Hierarchy unit unique reference

Example: 1012
menuItemPriceId: number

Unique menu item price reference

Example: 5.16
priceSequenceNum: integer

Price record number

Example: 3

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy unit unique reference"
        },
        "priceSequenceNum":{
            "type":"integer",
            "example":3,
            "description":"Price record number"
        },
        "menuItemPriceId":{
            "type":"number",
            "example":5.16,
            "description":"Unique menu item price reference"
        }
    },
    "description":"Model for Menu Item Price object"
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details