Get Kitchen Theme Periods
post
/config/sim/v2/setup/getKitchenThemePeriods
Gets Kitchen Theme Periods.
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name, kitchenThemeObjNum, effectivity -
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:
263,302 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, objectNum, name, and kitchenThemeObjNum.Example:
objectNum:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Search criteria is supported for hierUnitId, objectNum, name, and kitchenThemeObjNum.Example:
where equals(objectNum, 1)
Response
Supported Media Types
- application/json
200 Response
A collection of Kitchen Theme Periods.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Kitchen Theme Period objects.
-
limit:
integer
Server page size.Example:
10 -
offset:
integer
Starting resource record index.Example:
0 -
totalResults:
integer
Total number of rows.Example:
100
Nested Schema : items
Type:
arrayArray of Kitchen Theme Period objects.
Show Source
-
Array of:
object items
Kitchen Theme Period record.
Nested Schema : items
Type:
objectKitchen Theme Period record.
Show Source
-
effectivity:
object effectivity
Effectivity schedule for the Kitchen Theme Period.
-
hierUnitId:
integer
Unique hierarchy unit value of the revenue center where the Kitchen Theme Period is configured.Example:
10091 -
kitchenThemeObjNum:
integer
Object number of the Kitchen Theme.Example:
100 -
name:
object name
A group of string objects representing the name of the Kitchen Theme Period in configured languages.
-
objectNum:
integer
Object number of the Kitchen Theme Period.Example:
1
Nested Schema : effectivity
Type:
objectEffectivity schedule for the Kitchen Theme Period.
Show Source
-
activeEndTime:
string
Active end time in 24-hour HH:MM format.Example:
17:00 -
activeStartTime:
string
Active start time in 24-hour HH:MM format.Example:
09:00 -
endDateTime:
string
End date and time of the effectivity.Example:
2026-12-31T23:59:59 -
recurrenceDayOfWeek:
string
Minimum Length:
7Maximum Length:7A string of values 0s and 1s of length 7 representing the days of the week when the effectivity is active, starting with Sunday.Example:1111111 -
recurrenceDayOfWeekExt:
object recurrenceDayOfWeekExt
An object containing the descriptive recurrence days of week.
-
startDateTime:
string
Start date and time of the effectivity.Example:
2026-01-01T00:00:00
Nested Schema : name
Type:
objectA group of string objects representing the name of the Kitchen Theme Period in configured languages.
Example:
{
"263":"Lunch Theme Period",
"302":"Periode theme dejeuner"
}Nested Schema : recurrenceDayOfWeekExt
Type:
objectAn object containing the descriptive recurrence days of week.
Show Source
-
activeOnFriday:
boolean
A boolean flag representing the 6th option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Friday.Example:
true -
activeOnMonday:
boolean
A boolean flag representing the 2nd option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Monday.Example:
true -
activeOnSaturday:
boolean
A boolean flag representing the 7th option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Saturday.Example:
true -
activeOnSunday:
boolean
A boolean flag representing the 1st option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Sunday.Example:
true -
activeOnThursday:
boolean
A boolean flag representing the 5th option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Thursday.Example:
true -
activeOnTuesday:
boolean
A boolean flag representing the 3rd option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Tuesday.Example:
true -
activeOnWednesday:
boolean
A boolean flag representing the 4th option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Wednesday.Example:
true