Jump to

• Request
• Response

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

Body ()

Request body

Root Schema : MenuItemMasterEffectivityGetRequestBody

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
• languages: string
  If specified, limits translated strings returned.

  Example: en-US, de-DE, es-MX
• 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
• 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",
            "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"
        },
        "languages":{
            "type":"string",
            "example":"en-US, de-DE, es-MX",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of menuItem Master Effectivty Groups for the Hierarchy

Body ()

Root Schema : menuItemMasterEffectivityGetResponse

Type: object

Show Source

• effectivityGroupName(required): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• effectivityGroupObjNum(required): integer
  Menu item master effectivity group object number

  Example: 1
• hierUnitId(required): integer
  Unique hierarchy unit reference

  Example: 662
• hierUnitName(required): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• hierUnitObjNum(required): integer
  hierarchy unit object number

  Example: 1
• menuItemMasterId(required): integer
  Unique menu item master reference

  Example: 1

{
    "type":"object",
    "required":[
        "effectivityGroupObjNum",
        "hierUnitId",
        "menuItemMasterId",
        "effectivityGroupName",
        "hierUnitObjNum",
        "hierUnitName"
    ],
    "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":{
            "$ref":"#/definitions/TranslatedString"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"hierarchy unit object number"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString"
        }
    }
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A string that contains translations into multiple languages",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "es-MX":"Cafe"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages

Example:

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

400 Response

400 Bad Request

Body ()

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

Back to Top