{"openapi":"3.0.1","info":{"title":"holiday","description":"GET holidayEvents API","version":"v1","x-workday-internal-source":"xo","x-workday-internal-routing":"Public","x-workday-internal-protected-usage-enabled":false,"x-workday-internal-service-container-id":"b1f478bef08a1000074d4705003e00ea"},"tags":[{"name":"holidayEvents","description":"Returns the holiday events for the specified workers and time period. \nSecured by: Worker Data: Leave of Absence, Self-Service: Time Off, Self-Service: Leave of Absence, Worker Data: Time Off. \nScope: Time Off and Leave, Time Tracking."}],"components":{"schemas":{"INSTANCE_MODEL_REFERENCE":{"required":["id"],"type":"object","properties":{"id":{"pattern":"^(([0-9a-f]{32})|(\\S+=\\S+))$","type":"string","description":"Workday Id or Reference Id of the instance."},"descriptor":{"type":"string","description":"The display name of the instance","readOnly":true},"href":{"type":"string","description":"A link to the instance","readOnly":true}}},"ERROR_MODEL_REFERENCE":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A description of the error"},"code":{"type":"string","description":"The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change"},"field":{"type":"string","description":"The field related to the error"},"path":{"type":"string","description":"The path of the field related to the error"},"severity":{"type":"string","description":"Severity of the validation (e.g. Critical, Warning)."},"internalMessage":{"type":"string","description":"Internal message providing additional context for the validation (e.g. representation content validation details)."}}},"VALIDATION_ERROR_MODEL_REFERENCE":{"allOf":[{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A description of the error"},"errors":{"type":"array","description":"An array of validation errors","items":{"$ref":"#/components/schemas/ERROR_MODEL_REFERENCE"}}}}]},"FACETS_MODEL_REFERENCE":{"type":"array","items":{"type":"object","properties":{"descriptor":{"type":"string","description":"A description of the facet"},"facetParameter":{"type":"string","description":"The alias used to select the facet"},"values":{"type":"array","description":"the facet values","items":{"required":["id"],"type":"object","properties":{"count":{"type":"integer","description":"The number of instances returned by this facet","format":"int32"},"id":{"pattern":"^(([0-9a-f]{32})|(\\S+=\\S+))$","type":"string","description":"Workday Id or Reference Id of the instance."},"descriptor":{"type":"string","description":"A description of the facet"},"href":{"type":"string","description":"A link to the instance","readOnly":true}}}}},"description":"This object represents the possible facets for this resource","readOnly":true}},"MULTIPLE_INSTANCE_MODEL_REFERENCE":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/INSTANCE_MODEL_REFERENCE"}}}},"worker_b1f478bef08a100011f2bfd5569f0101":{"description":"Sample Returned Field","allOf":[{"$ref":"#/components/schemas/workerSummary_b1f478bef08a100011f18607286b00fe"},{"type":"object"}]},"holidayCalendar_4efe1016b8aa10001f302cb31f8d0000":{"description":"The holiday calendar for the derived holiday event.","allOf":[{"$ref":"#/components/schemas/INSTANCE_MODEL_REFERENCE"},{"type":"object"}]},"holidayEventsInstanceView_b1f478bef08a100011f2bfc7bf3a0100":{"allOf":[{"type":"object","properties":{"holidayName":{"type":"string","description":"The Name of a Holiday Event.","example":"Thanksgiving Day","x-workday-type":"Text"},"worker":{"$ref":"#/components/schemas/worker_b1f478bef08a100011f2bfd5569f0101"},"holidayCalendar":{"$ref":"#/components/schemas/holidayCalendar_4efe1016b8aa10001f302cb31f8d0000"},"date":{"type":"string","description":"The Date of a Holiday Event.","format":"date","x-workday-type":"Date"}}}]},"workerSummary_b1f478bef08a100011f18607286b00fe":{"allOf":[{"type":"object","properties":{"descriptor":{"type":"string","description":"The display name of the instance","example":"Lorem ipsum dolor sit ame"},"id":{"type":"string","description":"The id for \\~Worker\\~"}}}]}},"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://<tenantAuthorizationHostname>","scopes":{}}}}}},"servers":[{"url":"/api/purple-suite/{instanceId}/contracts/hris/workday","description":"PurpleSuite Workday-painted instance boundary","variables":{"instanceId":{"default":"INSTANCE_ID","description":"PurpleSuite instance identifier"}}}],"security":[{"OAuth2":[]}],"paths":{"/holiday/v1/holidayEvents":{"get":{"tags":["holidayEvents"],"description":"\n\n<b>Secured By Domain:</b> Self-Service: Leave of Absence, Self-Service: Time Off, Worker Data: Leave of Absence, Worker Data: Time Off\n\n<b>Scope:</b> Time Off and Leave","parameters":[{"name":"fromDate","in":"query","schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","description":"The maximum number of objects in a single response. The default is 20. The maximum is 100.","schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.","schema":{"type":"integer","format":"int64"}},{"name":"toDate","in":"query","schema":{"type":"string","format":"date"}},{"name":"worker","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response. A successful response can return no matched data.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/holidayEventsInstanceView_b1f478bef08a100011f2bfc7bf3a0100"}}}}}}},"400":{"description":"Invalid request. (https://community.workday.com/rest/error-messages)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"}}}},"401":{"description":"Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"}}}},"403":{"description":"User has insufficient permissions. (https://community.workday.com/rest/error-messages)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"}}}},"404":{"description":"Resource not found. (https://community.workday.com/rest/error-messages)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"}}}},"default":{"description":"An error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ERROR_MODEL_REFERENCE"}}}}},"x-workday-internal-try-enabled":"false","x-workday-operation-id":"b1f478bef08a100007c74872cc8a00f0","x-workday-secured-by-domains":["Self-Service: Leave of Absence","Self-Service: Time Off","Worker Data: Leave of Absence","Worker Data: Time Off"]}}},"x-purple-suite-contract":"full-service-repository-modeled-runtime","x-purple-suite-upstream-servers":[{"url":"https://<tenantHostname>/holiday/v1"}],"x-purple-suite-runtime-fidelity":{"capturedOperationIds":[],"modeledOperationIds":["workdayHolidayGetHolidayEvents"],"operations":[{"operationId":"workdayHolidayGetHolidayEvents","method":"get","path":"/holiday/v1/holidayEvents","upstreamPath":"/holidayEvents","fidelity":"modeled","xWorkdayOperationId":"b1f478bef08a100007c74872cc8a00f0"}]},"x-purple-suite-exclusions":["Workday Web Services (SOAP/WWS)","Workday Graph API","Workday Query Language (WQL), a separate Platform API family","Reports-as-a-Service (RaaS) and tenant custom reports","Finance, Payroll, Student, and non-HR Platform REST services","Experimental alpha, beta, and labs services","Tenant-configured actions absent from the pinned public artifacts"]}