Configuration and Content API Guide

Get Menu Item Master Effectivity Groups

post

/config/sim/v1/menuItems/getMenuItemMasterEffectivity

Gets all the Menu Item Master Effectivity Groups 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

Objects included in the response.

Example: hierUnitId
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
languages: string

If specified, limits the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

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

Example: 0
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: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

Example: where equals(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":0,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of menuItem Master Effectivty Groups.

Root Schema : menuItemMasterEffectivityGetResponsev1

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 Master Effectivity 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 Master Effectivity objects of the organization.",
            "items":{
                "$ref":"#/definitions/menuItemMasterEffectivityResponsev1"
            }
        },
        "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 Master Effectivity objects of the organization.

Show Source

Array of: object menuItemMasterEffectivityResponsev1

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

Nested Schema : menuItemMasterEffectivityResponsev1

Type: object

Show Source

effectivityGroupName: object effectivityGroupName

Effectivity Group Name
effectivityGroupObjNum: integer

Menu item master effectivity group object number

Example: 1
hierUnitId: integer

Unique hierarchy unit reference

Example: 662
hierUnitName: object hierUnitName

Hier Unit Name
hierUnitObjNum: integer

hierarchy unit object number

Example: 1
menuItemMasterId: integer

Unique menu item master reference

Example: 1

{
    "type":"object",
    "properties":{
        "effectivityGroupObjNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item master effectivity group object number"
        },
        "hierUnitId":{
            "type":"integer",
            "example":662,
            "description":"Unique hierarchy unit reference"
        },
        "menuItemMasterId":{
            "type":"integer",
            "example":1,
            "description":"Unique menu item master reference"
        },
        "effectivityGroupName":{
            "type":"object",
            "description":"Effectivity Group Name",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"Cafe"
            }
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"hierarchy unit object number"
        },
        "hierUnitName":{
            "type":"object",
            "description":"Hier Unit Name",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"Cafe"
            }
        }
    }
}

Nested Schema : effectivityGroupName

Type: object

Effectivity Group Name

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}

Nested Schema : hierUnitName

Type: object

Hier Unit Name

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}