Configuration and Content API Guide

Get Condiment Groups

post

/config/sim/v1/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

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 Condiment Groups

Root Schema : CondimentGroupGetResponseV1

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

Model for Condiment Group Object

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

Nested Schema : CondimentGroupResponseV1

Type: object

Model for Condiment Group Object

Show Source

consumerDescription: object consumerDescription

Consumer Description
hierUnitId: integer

Unique reference of the hierarchy unit

Example: 1
hierUnitName: object hierUnitName

Hier Unit Name
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"
        },
        "hierUnitName":{
            "type":"object",
            "description":"Hier Unit Name",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        },
        "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 : 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"
}