openapi: 3.1.0
info:
  title: Workday Integration Workday Absence Management Absence Types Reference Data API
  description: API for managing employee leave requests, absence types, and time-off balances. Retrieves eligible absence types for employees and supports validation of leave category selections.
  version: v1
  contact:
    name: Workday API Support
    email: api-support@workday.com
    url: https://community.workday.com
  license:
    name: Proprietary
    url: https://www.workday.com/en-us/legal/site-terms.html
servers:
- url: https://{baseUrl}/ccx/api/absenceManagement/v1/{tenant}
  description: Workday Absence Management REST API server
  variables:
    baseUrl:
      default: wd2-impl-services1.workday.com
      description: The Workday data center hostname
    tenant:
      default: tenant
      description: The Workday tenant name
security:
- OAuth2:
  - r:absenceManagement
  - w:absenceManagement
tags:
- name: Reference Data
paths:
  /values/leave/status:
    get:
      operationId: getLeaveStatusValues
      summary: Workday Integration Retrieve leave status values
      description: Returns the available leave of absence status values.
      tags:
      - Reference Data
      responses:
        '200':
          description: Successful response with leave status values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceValuesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /values/timeOff/status:
    get:
      operationId: getTimeOffStatusValues
      summary: Workday Integration Retrieve time off status values
      description: Returns the available time off request status values including Approved, Submitted, Not Submitted, and Sent Back.
      tags:
      - Reference Data
      responses:
        '200':
          description: Successful response with time off status values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceValuesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /benefitPlanTypes:
    get:
      operationId: getBenefitPlanTypes
      summary: Workday Integration Retrieve benefit plan types
      description: Returns the available benefit plan types configured in the tenant.
      tags:
      - Reference Data
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with benefit plan types
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceValuesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /jobChangeReasons:
    get:
      operationId: getJobChangeReasons
      summary: Workday Integration Retrieve job change reasons
      description: Returns the available job change reasons for staffing transactions.
      tags:
      - Reference Data
      parameters:
      - $ref: '#/components/parameters/limit_2'
      - $ref: '#/components/parameters/offset_2'
      responses:
        '200':
          description: Successful response with job change reasons
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobChangeReasonsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /currencies:
    get:
      operationId: getCurrencies
      summary: Workday Integration Retrieve currencies
      description: Returns the available currencies configured in the tenant.
      tags:
      - Reference Data
      parameters:
      - $ref: '#/components/parameters/limit_2'
      - $ref: '#/components/parameters/offset_2'
      responses:
        '200':
          description: Successful response with currencies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrenciesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /values/payrollInputsGroup/payComponents:
    get:
      operationId: getPayComponents
      summary: Workday Integration Retrieve pay components
      description: Returns the available pay components that can be used in payroll inputs.
      tags:
      - Reference Data
      parameters:
      - $ref: '#/components/parameters/limit_3'
      - $ref: '#/components/parameters/offset_3'
      responses:
        '200':
          description: Successful response with pay components
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceValuesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /values/runCategories:
    get:
      operationId: getRunCategories
      summary: Workday Integration Retrieve run categories
      description: Returns the available payroll run categories.
      tags:
      - Reference Data
      parameters:
      - $ref: '#/components/parameters/limit_3'
      - $ref: '#/components/parameters/offset_3'
      responses:
        '200':
          description: Successful response with run categories
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceValuesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /values/common/countries:
    get:
      operationId: getCountries
      summary: Workday Integration Retrieve available countries
      description: Returns the list of countries available for recruiting processes.
      tags:
      - Reference Data
      parameters:
      - $ref: '#/components/parameters/limit_4'
      - $ref: '#/components/parameters/offset_4'
      responses:
        '200':
          description: Successful response with countries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceValuesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    JobChangeReasonsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceReference_2'
    ResourceReference_2:
      type: object
      properties:
        id:
          type: string
          description: The Workday ID
        descriptor:
          type: string
          description: The display name
        href:
          type: string
          format: uri
          description: The API resource URL
    ResourceReference:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        href:
          type: string
          format: uri
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              error:
                type: string
              field:
                type: string
              message:
                type: string
    CurrenciesResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              descriptor:
                type: string
              currencyCode:
                type: string
    ReferenceValuesResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceReference'
  parameters:
    limit_3:
      name: limit
      in: query
      description: The maximum number of objects in a single response (default 20, maximum 100)
      schema:
        type: integer
        default: 20
        maximum: 100
    offset:
      name: offset
      in: query
      description: Zero-based index of the first object in a response collection
      schema:
        type: integer
        default: 0
    limit_2:
      name: limit
      in: query
      description: The maximum number of objects in a single response (default 20, maximum 100)
      schema:
        type: integer
        default: 20
        maximum: 100
    offset_4:
      name: offset
      in: query
      description: The zero-based index of the first object in a response collection
      schema:
        type: integer
        default: 0
    offset_3:
      name: offset
      in: query
      description: The zero-based index of the first object in a response collection
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: Maximum number of objects in a single response (default 20, maximum 100)
      schema:
        type: integer
        default: 20
        maximum: 100
    limit_4:
      name: limit
      in: query
      description: The maximum number of objects in a single response (default 20, maximum 100)
      schema:
        type: integer
        default: 20
        maximum: 100
    offset_2:
      name: offset
      in: query
      description: The zero-based index of the first object in a response collection
      schema:
        type: integer
        default: 0
  responses:
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{baseUrl}/authorize
          tokenUrl: https://{baseUrl}/oauth2/{tenant}/token
          refreshUrl: https://{baseUrl}/oauth2/{tenant}/token
          scopes:
            r:absenceManagement: Read absence data
            w:absenceManagement: Write absence data