Prompt
openapi: 3.1.0
info:
title: Workday Employee API
description: API to manage worker details, absence types, and benefit plans in Workday.
version: 1.3.0
servers:
- url: https://wd5-impl-services1.workday.com/ccx
description: Workday Absence Management API Server
paths:
/service/customreport2/tenant/GPT_RAAS:
get:
operationId: getAuthenticatedUserIdRaaS
summary: Retrieve the Employee ID for the authenticated user.
description: Fetches the Employee ID for the authenticated user from Workday.
responses:
'200':
description: A JSON object containing the authenticated user's Employee ID.
content:
application/json:
schema:
type: object
properties:
employeeId:
type: string
description: The Employee ID of the authenticated user.
example: "5050"
'401':
description: Unauthorized - Invalid or missing Bearer token.
security:
- bearerAuth: []
/api/absenceManagement/v1/tenant/workers/Employee_ID={employeeId}/eligibleAbsenceTypes:
get:
operationId: getEligibleAbsenceTypes
summary: Retrieve eligible absence types by Employee ID.
description: Fetches a list of eligible absence types for a worker by their Employee ID, with a fixed category filter.
parameters:
- name: employeeId
in: path
required: true
description: The Employee ID of the worker (passed as `Employee_ID=3050` in the URL).
schema:
type: string
example: "5050"
- name: category
in: query
required: true
description: Fixed category filter for the request. This cannot be changed.
schema:
type: string
example: "17bd6531c90c100016d4b06f2b8a07ce"
responses:
'200':
description: A JSON array of eligible absence types.
content:
application/json:
schema:
type: object
properties:
absenceTypes:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
'401':
description: Unauthorized - Invalid or missing Bearer token.
'404':
description: Worker or absence types not found.
security:
- bearerAuth: []
/api/absenceManagement/v1/tenant/workers/Employee_ID={employeeId}:
get:
operationId: getWorkerById
summary: Retrieve worker details by Employee ID.
description: Fetches detailed information of a worker using their Employee ID.
parameters:
- name: employeeId
in: path
required: true
description: The Employee ID of the worker.
schema:
type: string
example: "5050"
responses:
'200':
description: A JSON object containing worker details.
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: object
properties:
firstName:
type: string
lastName:
type: string
position:
type: string
email:
type: string
'401':
description: Unauthorized - Invalid or missing Bearer token.
'404':
description: Worker not found.
security:
- bearerAuth: []
/api/absenceManagement/v1/tenant/workers/Employee_ID={employeeId}/requestTimeOff:
post:
operationId: requestTimeOff
summary: Request time off for a worker.
description: Allows a worker to request time off by providing the necessary details.
parameters:
- name: employeeId
in: path
required: true
description: The Employee ID of the worker requesting time off.
schema:
type: string
example: "5050"
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
days:
type: array
description: Array of days for which the time off is being requested.
items:
type: object
properties:
start:
type: string
format: date
description: The start date of the time off.
example: "2024-11-26"
date:
type: string
format: date
description: The specific date for the time off.
example: "2024-11-26"
end:
type: string
format: date
description: The end date of the time off.
example: "2024-11-26"
dailyQuantity:
type: number
description: The number of hours per day to take off.
example: 8
timeOffType:
type: object
description: Time off type with corresponding ID.
properties:
id:
type: string
description: The ID of the time off type.
example: "b35340ce4321102030f8b5a848bc0000"
enum:
- <flexible_time_off_id_from_workday> # Flexible Time Off ID (hexa format)
- <sick_leave_id_from_workday> # Sick Leave ID (hexa format)
responses:
'200':
description: Time off request created successfully.
'400':
description: Invalid input or missing parameters.
'401':
description: Unauthorized - Invalid or missing Bearer token.
'404':
description: Worker not found.
security:
- bearerAuth: []
/service/customreport2/tenant/GPT_Worker_Benefit_Data:
get:
operationId: getWorkerBenefitPlans
summary: Retrieve worker benefit plans enrolled by Employee ID.
description: Fetches the benefit plans in which the worker is enrolled using their Employee ID.
parameters:
- name: Worker!Employee_ID
in: query
required: true
description: The Employee ID of the worker.
schema:
type: string
example: "5020"
- name: format
in: query
required: true
description: The format of the response (e.g., `json`).
schema:
type: string
example: "json"
responses:
'200':
description: A JSON array of the worker's enrolled benefit plans.
content:
application/json:
schema:
type: object
properties:
benefitPlans:
type: array
items:
type: object
properties:
planName:
type: string
coverage:
type: string
startDate:
type: string
format: date
endDate:
type: string
format: date
'401':
description: Unauthorized - Invalid or missing Bearer token.
'404':
description: Worker or benefit plans not found.
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
worker:
type: object
properties:
id:
type: string
name:
type: object
properties:
firstName:
type: string
lastName:
type: string
position:
type: string
email:
type: string
absenceTypes:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
benefitPlans:
type: array
items:
type: object
properties:
planName:
type: string
coverage:
type: string
startDate:
type: string
format: date
endDate:
type: string
format: date
timeOffTypes:
type: object
description: Mapping of human-readable time off types to their corresponding IDs.
properties:
Flexible Time Off:
type: string
example: "b35340ce4321102030f8b5a848bc0000"
Sick Leave:
type: string
example: "21bd0afbfbf21011e6ccc4dc170e0000"