Get a holiday
get
/services/rest/connect/v1.4/holidays/{id}
Request
Path Parameters
-
id(required): integer
The unique identifier of the holiday.
Response
Default Response
Root Schema : holidays
Type:
object
The list of holidays in your organization.
Show Source
-
adminVisibleInterfaces:
object namedIDs-holidays-adminVisibleInterfaces
The named ID that can be included in a list.
-
createdTime:
string
The date and time when the holiday was created. This attribute is read-only.
-
displayOrder:
integer
Minimum Value:
1
Maximum Value:2147483647
The display position relative to other holidays. -
holidayDate:
string
The date the holiday falls on. The maximum allowed value of the date is 12/31/2032.
-
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the holiday. -
lookupName:
string
Maximum Length:
255
The name used to look up the holiday. -
name:
string
Maximum Length:
40
Pattern:^[^ ]*$
The name of the holiday. -
updatedTime:
string
The date and time when the holiday was last updated. This attribute is read-only.
Nested Schema : namedIDs-holidays-adminVisibleInterfaces
Type:
object
The named ID that can be included in a list.
Show Source
-
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the object. This is the key for the list entry. -
lookupName:
string
Maximum Length:
255
The name used to look up the object.
Examples
Use GET with the following syntax to retrieve data for a holiday:
https://your_site_interface/services/rest/connect/version/holidays/holiday_id
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/holidays/2
Response body example
{
"id": 2,
"lookupName": "Thanksgiving Day",
"adminVisibleInterfaces": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/holidays/2/adminVisibleInterfaces"
}
]
},
"displayOrder": 4,
"holidayDate": "2016-11-24",
"name": "Thanksgiving Day",
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/holidays/2"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/holidays/2"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/holidays",
"mediaType": "application/schema+json"
}
]
}