Get Kitchen Themes

post

/config/sim/v2/setup/getKitchenThemes

Gets Kitchen Themes

Request

Supported Media Types
Body ()
The input body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, objectNum, name, rvcTypeOptions, workstations, kdsClients, orderDevices, orderTypes
  • 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
  • If specified, limits translated strings returned
    Example: 263,302
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index.
    Example: 0
  • Sorts the response by the specified field name and sort order. Allowed fields are objectNum, hierUnitId, name, and rvcTypeOptions.
    Example: objectNum:asc
  • If specified, returns records that match the criteria. Search criteria is supported for objectNum, hierUnitId, name, and rvcTypeOptions.
    Example: where equals(objectNum, 973900)
Back to Top

Response

Supported Media Types

200 Response

A collection of Kitchen Themes.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Kitchen Theme objects.
Show Source
Nested Schema : KitchenTheme
Type: object
Kitchen Theme record
Show Source
Nested Schema : kdsClients
Type: array
Show Source
Nested Schema : name
Type: object
A group of string objects representing the name of the Kitchen Theme in configured languages.
Example:
{
    "263":"API KT 3",
    "302":"API KT 3 FR"
}
Nested Schema : orderDevices
Type: array
Order device records linked to the Kitchen Theme. KDS settings, KDS options, links, associations, and primaryDistributionGroup apply only when ordDeviceType is 1 and primaryDeviceType is 1.
Show Source
Nested Schema : orderTypes
Type: array
Show Source
Nested Schema : workstations
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : panelConfiguration
Type: array
Maximum Number of Items: 9
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : associations
Type: array
Show Source
Nested Schema : kdsSettings
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top