Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Holiday

Get Holiday

Given a Holiday id, it returns all attributes of the Holiday (Resource Management Entity)

get/api/v2/resource_management/holidays/{holidayId}

Path parameters

holidayIdstring required

ID of a holiday in Eightfold

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

createdAtinteger nullable

Created timestamp for the holiday

updatedBystring nullable

User who updated the holiday

isArchivedboolean nullable

A flag indicating if holiday is archived

holidayDateinteger nullable required

Date of the holiday

createdBystring nullable

User who created the holiday

holidayNamestring nullable

Name of the holiday

archivedAtinteger nullable

Archived timestamp for the holiday

updatedAtinteger nullable

Updated timestamp for the holiday

holidayType'public_holiday' | 'optional_holiday' nullable required

Type of the holiday

regionstring nullable

Region of the holiday

holidayIdinteger nullable

Holiday id