Configuration and Content API Guide

Get Condiment Groups

post

/config/sim/v2/menuItems/getCondimentGroups

Gets all the Condiment Groups

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

Response

Supported Media Types

application/json

200 Response

A collection of Condiment Groups

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 Condiment Group objects.
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 Condiment Group objects.",
            "items":{
                "$ref":"#/definitions/CondimentGroupV2"
            }
        },
        "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 Condiment Group objects.

Show Source

Array of: object CondimentGroupV2

Model for Condiment Group Object

{
    "type":"array",
    "description":"Array of Condiment Group objects.",
    "items":{
        "$ref":"#/definitions/CondimentGroupV2"
    }
}

Nested Schema : CondimentGroupV2

Type: object

Model for Condiment Group Object

Show Source

consumerDescription: object consumerDescription

Consumer Description
hierUnitId: integer

Unique reference of the hierarchy unit

Example: 1
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
name: object name

Name
objectNum: integer

Object number of the condiment Group

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the hierarchy unit"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the condiment Group"
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "1":"Family Group 1",
                "2":"Familiengruppe 1",
                "3":"Grupo familiar 1"
            }
        },
        "consumerDescription":{
            "type":"object",
            "description":"Consumer Description",
            "example":{
                "1":"Family Group 1",
                "2":"Familiengruppe 1",
                "3":"Grupo familiar 1"
            }
        }
    },
    "description":"Model for Condiment Group Object"
}

Nested Schema : consumerDescription

Type: object

Consumer Description

Example:

{
    "1":"Family Group 1",
    "2":"Familiengruppe 1",
    "3":"Grupo familiar 1"
}

Nested Schema : name

Type: object

Name

Example:

{
    "1":"Family Group 1",
    "2":"Familiengruppe 1",
    "3":"Grupo familiar 1"
}

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