Jump to

• Request
• Response

View a Holiday List

get

/api/restapi/holidayList/{holidayListId}

This endpoint returns holiday lists that meet the following requirements:

• The object has an ID that matches the value of the {holidayListId} path parameter.

Request

Path Parameters

• holidayListId(required): integer(int64)
  ID of the Holiday List to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityHolidayGroup

Type: object

Title: ApiEntityHolidayGroup

Show Source

• 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.

{
    "title":"ApiEntityHolidayGroup",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayListId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidays":{
            "type":"array",
            "description":"The list of holidays associated with the holiday group.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityHoliday",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "holidayGroupName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : holidays

Type: array

The list of holidays associated with the holiday group.

Show Source

• Array of: object ApiEntityHoliday
  Title: ApiEntityHoliday

{
    "type":"array",
    "description":"The list of holidays associated with the holiday group.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityHoliday",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityHoliday

Type: object

Title: ApiEntityHoliday

Show Source

• 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.

{
    "title":"ApiEntityHoliday",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dayOfMonth":{
            "type":"integer",
            "description":"The day of the month the holiday is on.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dayOfWeek":{
            "type":"integer",
            "description":"The day of the week the holiday is on.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "week":{
            "type":"integer",
            "description":"The week of the month the holiday is in.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The month the holiday is in.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayListId":{
            "type":"integer",
            "description":"The unique identifier for the holiday list.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayId":{
            "type":"integer",
            "description":"The unique identifier for the holiday.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayDate":{
            "type":"string",
            "description":"The date of the holiday.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "holidayGroupName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested holiday list does not exist, or you do not have access to it.

Back to Top