Configuration and Content API Guide

Get Menu Item Master Effectivity Groups

post

/config/sim/v2/menuItems/getMenuItemMasterEffectivity

Gets all the Menu Item Master Effectivity Groups configured and hierarchy unit

Request

Supported Media Types

application/json
multipart/form-data

Request body

Root Schema : MenuItemMasterEffectivityGetRequestBodyv2

Type: object

Show Source

include: string

Example: locations
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
langIds: string

If specified, limits translated strings returned.

Example: 1,2,3
limit: integer

Number of results returned in this page. Not required if paging parameters are not supported.

Example: 10
offset: integer

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

Example: 2
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(hierUnitId,1012)

{
    "type":"object",
    "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":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId,1012)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "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"
        },
        "langIds":{
            "type":"string",
            "example":"1,2,3",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of menuItem Master Effectivty Groups for the Hierarchy

Root Schema : menuItemMasterEffectivityGetResponsev2

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/menuItemMasterEffectivityResponsev2"
            }
        },
        "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 menuItemMasterEffectivityResponsev2

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

Nested Schema : menuItemMasterEffectivityResponsev2

Type: object

Show Source

effectivityGroupObjNum: integer

Menu item master effectivity group object number

Example: 1
hierUnitId: integer

Unique hierarchy unit reference

Example: 662
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"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":"1",
            "description":"hierarchy unit object number"
        }
    }
}

400 Response

400 Bad Request

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

detail(required): string

A short, human-readable summary of the problem.

Example: Specified Data is invalid
errorDetails(required): string

A human-readable explanation specific to this occurrence of the problem.

Example: Entity Does Not Exist
o:errorCode(required): integer

Error code of the problem

Example: 55223
status(required): integer

HTTP status code.

Example: 400
title(required): string

A short, human-readable summary of the problem type.

Example: VALIDATION ERROR
type(required): 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",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "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