Get Condiment Groups

post

/config/sim/v1/menuItems/getcondimentgroups

Gets all the Condiment Groups

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • Objects included in the response.
    Example: hierUnitId
  • 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
  • If specified, limits the translated strings returned.
    Example: en-US, es-ES, es-MX
  • If using paging, number of results returned in this page.
    Example: 0
  • Starting resource record index. Not required if paging parameters are not supported.
    Example: 0
  • Sorts the response by the specified field name and sort order.
    Example: objectNum:asc
  • Search criteria to filter results based on field value.
    Example: where equals(objectNum,1)
Back to Top

Response

Supported Media Types

200 Response

A collection of Condiment Groups
Body ()
Root Schema : CondimentGroupGetResponseV1
Type: object
Show Source
Nested Schema : items
Type: array
Array of Condiment Group objects.
Show Source
Nested Schema : CondimentGroupResponseV1
Type: object
Model for Condiment Group Object
Show Source
Nested Schema : consumerDescription
Type: object
Consumer Description
Example:
{
    "1":"Family Group 1",
    "2":"Familiengruppe 1",
    "3":"Grupo familiar 1"
}
Nested Schema : hierUnitName
Type: object
Hier Unit Name
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : name
Type: object
Name
Example:
{
    "1":"Family Group 1",
    "2":"Familiengruppe 1",
    "3":"Grupo familiar 1"
}
Back to Top