Create a Holiday List
post
/primeapi/restapi/holidayList
Send a request to this endpoint to create a holiday list. An application object will be created using the JSON data provided in the request body.
Request
Supported Media Types
- application/json
Holiday List to be created.
Root Schema : ApiEntityHolidayGroup
Type:
Show Source
object
-
holidayGroupId:
integer(int64)
The unique identifier for the holiday list.
-
holidayGroupName:
string
The name of the holiday list.
-
holidays:
array holidays
Unique Items Required:
true
-
link(optional):
string(url)
Read Only:
true
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier for the holiday list.
Nested Schema : ApiEntityHoliday
Type:
Show Source
object
-
dayOfMonth:
integer(int32)
The day of the month the holiday is on.
-
dayOfWeek:
integer(int32)
The day of the week the holiday is on.
-
holidayDate:
string(date-time)
The date of the holiday.
-
holidayGroupId:
integer(int64)
The unique identifier for the holiday list.
-
holidayId:
integer(int64)
The unique identifier for the holiday.
-
holidayName:
string
The name of the holiday.
-
link(optional):
string(url)
Read Only:
true
-
month:
integer(int32)
The month the holiday is in.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
week:
integer(int32)
The week of the month the holiday is in.
-
workTime:
object DayWorkTime
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityHolidayGroup
Type:
Show Source
object
-
holidayGroupId:
integer(int64)
The unique identifier for the holiday list.
-
holidayGroupName:
string
The name of the holiday list.
-
holidays:
array holidays
Unique Items Required:
true
-
link(optional):
string(url)
Read Only:
true
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier for the holiday list.
Nested Schema : ApiEntityHoliday
Type:
Show Source
object
-
dayOfMonth:
integer(int32)
The day of the month the holiday is on.
-
dayOfWeek:
integer(int32)
The day of the week the holiday is on.
-
holidayDate:
string(date-time)
The date of the holiday.
-
holidayGroupId:
integer(int64)
The unique identifier for the holiday list.
-
holidayId:
integer(int64)
The unique identifier for the holiday.
-
holidayName:
string
The name of the holiday.
-
link(optional):
string(url)
Read Only:
true
-
month:
integer(int32)
The month the holiday is in.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
week:
integer(int32)
The week of the month the holiday is in.
-
workTime:
object DayWorkTime
400 Response
Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request.