Create a Holiday List
post
/api/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
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityHolidayGroupInput
Type:
object
Title:
ApiEntityHolidayGroupInput
This entity represents a HolidayGroup object, a unique HolidayGroup object can be identified by the following combinations of the fields.
Show Source
- holidayListId
- holidayGroupName,workspaceId
- holidayGroupName,workspaceCode
-
holidayGroupName(required): string
Maximum Length:
60
The name of the holiday list. -
holidayListId: integer
(int64)
The unique identifier for the holiday list. This value should not be provided in create operation request data, however, it is required for update requests.
-
holidays: array
holidays
The list of holidays associated with the holiday group.
-
link: string(url)Read Only:true
Deprecated. As of 24.4.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 24.4.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : holidays
Type:
array
The list of holidays associated with the holiday group.
Show Source
-
Array of:
object ApiEntityHolidayInput
Title:
ApiEntityHolidayInput
Nested Schema : ApiEntityHolidayInput
Type:
object
Title:
Show Source
ApiEntityHolidayInput
-
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(required): string
(date-time)
The date of the holiday.
-
holidayGroupName: stringRead Only:true
Maximum Length:60
Deprecated. As of 24.4.The name of the holiday list. -
holidayId: integer
(int64)
The unique identifier for the holiday.
-
holidayListId(required): integer
(int64)
The unique identifier for the holiday list.
-
holidayName(required): string
Maximum Length:
60
The name of the holiday. -
link: string(url)Read Only:true
Deprecated. As of 24.4.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
month: integer
(int32)
The month the holiday is in.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 24.4.Date when the record was last updated. -
week: integer
(int32)
The week of the month the holiday is in.
-
workspaceCode: stringRead Only:true
Minimum Length:0
Maximum Length:60
Deprecated. As of 24.4.The user-specified identifier of a workspace.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityHolidayGroup
Type:
object
Title:
Show Source
ApiEntityHolidayGroup
-
holidayGroupName: string
Maximum Length:
60
The name of the holiday list. -
holidayListId: integer
(int64)
The unique identifier for the holiday list. This value should not be provided in create operation request data, however, it is required for update requests.
-
holidays: array
holidays
The list of holidays associated with the holiday group.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : holidays
Type:
array
The list of holidays associated with the holiday group.
Show Source
-
Array of:
object ApiEntityHoliday
Title:
ApiEntityHoliday
Nested Schema : ApiEntityHoliday
Type:
object
Title:
Show Source
ApiEntityHoliday
-
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.
-
holidayGroupName: string
Maximum Length:
60
The name of the holiday list. -
holidayId: integer
(int64)
The unique identifier for the holiday.
-
holidayListId: integer
(int64)
The unique identifier for the holiday list.
-
holidayName: string
Maximum Length:
60
The name of the holiday. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
month: integer
(int32)
The month the holiday is in.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
week: integer
(int32)
The week of the month the holiday is in.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
400 Response
Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request.