Workday Reports API

openapi: 3.1.0
info:
  title: Workday Absence Management Absence Types Reports API
  description: Absence Management API for managing leave balances, time-off requests, leaves of absence, and eligible absence types for workers.
  version: v1
  contact:
    name: Workday Support
    email: support@workday.com
    url: https://www.workday.com/en-us/customer-service/support.html
  license:
    name: Proprietary
    url: https://www.workday.com/en-us/legal.html
servers:
- url: https://wd2-impl-services1.workday.com/ccx/api/absenceManagement/v1/{tenant}
  description: Workday REST API Server
  variables:
    tenant:
      default: tenant_name
      description: The Workday tenant identifier
security:
- OAuth2:
  - r_absence
  - w_absence
tags:
- name: Reports
  description: Endpoints for accessing custom report data via RaaS.
paths:
  /{reportOwner}/{reportName}:
    get:
      operationId: getCustomReport
      summary: Get Custom Report Data
      description: Returns data from a custom report published as a web service. The report owner and report name form the path to the report. Supports filtering via report-specific prompt parameters.
      tags:
      - Reports
      parameters:
      - name: reportOwner
        in: path
        required: true
        description: The username of the report owner (e.g., ISU_report_owner).
        schema:
          type: string
        example: example_value
      - name: reportName
        in: path
        required: true
        description: The name of the custom report.
        schema:
          type: string
        example: example_value
      - name: format
        in: query
        description: The output format for the report data. Supported values are json, csv, simplexml, and gdata.
        schema:
          type: string
          enum:
          - json
          - csv
          - simplexml
          - gdata
          default: json
        example: json
      - name: Worker!WID
        in: query
        description: Filter by worker Workday ID (example prompt parameter).
        schema:
          type: string
        example: '500123'
      - name: Effective_as_of_Date
        in: query
        description: Filter by effective date (example prompt parameter).
        schema:
          type: string
          format: date
        example: '2026-01-15'
      responses:
        '200':
          description: Successful response containing report data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportResponse'
              examples:
                Getcustomreport200Example:
                  summary: Default getCustomReport 200 response
                  x-microcks-default: true
                  value:
                    Report_Entry:
                    - {}
            text/csv:
              schema:
                type: string
                description: CSV-formatted report data.
              examples:
                Getcustomreport200Example:
                  summary: Default getCustomReport 200 response
                  x-microcks-default: true
                  value: example_value
            application/xml:
              schema:
                type: string
                description: XML-formatted report data.
              examples:
                Getcustomreport200Example:
                  summary: Default getCustomReport 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: The report was not found or is not published as a web service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getcustomreport404Example:
                  summary: Default getCustomReport 404 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    errors:
                    - error: example_value
                      field: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ReportResponse:
      type: object
      properties:
        Report_Entry:
          type: array
          items:
            type: object
            additionalProperties: true
            description: A report row with column names as keys. The actual fields depend on the report definition.
          description: The array of report data rows.
          example: []
      description: The report response containing an array of report entries. Column names correspond to the report field definitions.
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: example_value
        errors:
          type: array
          items:
            type: object
            properties:
              error:
                type: string
              field:
                type: string
          example: []
  responses:
    BadRequest:
      description: The request was invalid or malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication credentials were missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://wd2-impl-services1.workday.com/ccx/oauth2/{tenant}/authorize
          tokenUrl: https://wd2-impl-services1.workday.com/ccx/oauth2/{tenant}/token
          scopes:
            r_absence: Read absence data
            w_absence: Write absence data