View a Holiday List by Name
get
/api/restapi/holidayList/name/{holidayGroupName}
This endpoint returns holiday lists that meet the following requirements:
- The object has a name that matches the value of the {holidayGroupName} path parameter.
Request
Path Parameters
-
holidayGroupName(required): string
Name of the holiday List to be found.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityHolidayGroup>
Type:
array
Title:
Show Source
List<ApiEntityHolidayGroup>
-
Array of:
object ApiEntityHolidayGroup
Title:
ApiEntityHolidayGroup
Nested 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.
204 Response
Successful operation with no content.
404 Response
The requested holiday list does not exist, or you do not have access to it.