openapi: 3.1.0
info:
  title: Workday Integration Workday Absence Management Absence Types Compensation 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: Compensation Reviews
paths:
  /compensationReviewEvents:
    get:
      operationId: getCompensationReviewEvents
      summary: Workday Integration Retrieve compensation review events
      description: Returns a collection of compensation review events including merit, bonus, and equity review cycles.
      tags:
      - Compensation Reviews
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with compensation review events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewEventsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /compensationReviewEvents/{ID}:
    get:
      operationId: getCompensationReviewEventById
      summary: Workday Integration Retrieve a specific compensation review event
      description: Returns the specified compensation review event with participants and status.
      tags:
      - Compensation Reviews
      parameters:
      - $ref: '#/components/parameters/ID'
      responses:
        '200':
          description: Successful response with the review event
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewEvent'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /compensationReviewEvents/{ID}/awards:
    get:
      operationId: getCompensationReviewAwards
      summary: Workday Integration Retrieve awards for a compensation review
      description: Returns the merit, bonus, and equity awards for participants in the specified compensation review event.
      tags:
      - Compensation Reviews
      parameters:
      - $ref: '#/components/parameters/ID'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with review awards
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwardsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ResourceReference:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        href:
          type: string
          format: uri
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
    ReviewEventsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReviewEvent'
    ReviewEvent:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        reviewType:
          type: string
        effectiveDate:
          type: string
          format: date
        status:
          type: string
    AwardsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              worker:
                $ref: '#/components/schemas/ResourceReference'
              awardType:
                type: string
              amount:
                type: number
              currency:
                $ref: '#/components/schemas/ResourceReference'
              percentage:
                type: number
  parameters:
    offset:
      name: offset
      in: query
      schema:
        type: integer
        default: 0
    ID:
      name: ID
      in: path
      required: true
      schema:
        type: string
    limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 20
        maximum: 100
  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