openapi: 3.1.0
info:
  title: Workday Integration Workday Absence Management Absence Types Time Reviews 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: Time Reviews
paths:
  /workers/{ID}/timeReviewEvents:
    post:
      operationId: createTimeReviewEvent
      summary: Workday Integration Create a time review event for a worker
      description: Initiates a time review event for the specified worker to approve or adjust time entries.
      tags:
      - Time Reviews
      parameters:
      - $ref: '#/components/parameters/ID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TimeReviewEventRequest'
      responses:
        '201':
          description: Time review event created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeReviewEvent'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    TimeReviewEventRequest:
      type: object
      required:
      - reviewPeriodStartDate
      - reviewPeriodEndDate
      properties:
        reviewPeriodStartDate:
          type: string
          format: date
        reviewPeriodEndDate:
          type: string
          format: date
    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
    TimeReviewEvent:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        worker:
          $ref: '#/components/schemas/ResourceReference'
        reviewPeriodStartDate:
          type: string
          format: date
        reviewPeriodEndDate:
          type: string
          format: date
        status:
          type: string
  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'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    ID:
      name: ID
      in: path
      required: true
      description: The Workday ID of the resource
      schema:
        type: string
  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