openapi: 3.1.0
info:
  title: Workday Report Writer Workday Prism Analytics Buckets Query Execution API
  description: REST API for working with Workday Prism Analytics tables, datasets, and data change tasks. Enables programmatic loading of external data into Prism Analytics for advanced reporting and analytics that combines internal Workday data with external sources. Supports creating tables with schema definitions, uploading compressed data files via buckets, and executing data change tasks to apply inserts, updates, upserts, and deletes.
  version: v3
  contact:
    name: Workday Support
    url: https://www.workday.com/en-us/company/contact-us.html
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://{hostname}/api/prismAnalytics/v3/{tenant}
  description: Workday Prism Analytics Production
  variables:
    hostname:
      description: Workday data center hostname, varies by tenant deployment
      default: wd2-impl-services1.workday.com
    tenant:
      description: Workday tenant name
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Query Execution
  description: Execute WQL queries against Workday data sources and retrieve paginated results
paths:
  /data:
    get:
      operationId: executeWqlQuery
      summary: Workday Report Writer Execute a WQL Query
      description: Execute a Workday Query Language (WQL) query and retrieve paginated results. Supports SQL-like syntax with SELECT, FROM, WHERE, ORDER BY, and LIMIT clauses. WQL also supports special operators such as startsWith, contains, and endsWith for text filtering.
      tags:
      - Query Execution
      parameters:
      - name: query
        in: query
        required: true
        description: 'WQL query string using SQL-like syntax. Example: SELECT workdayID, fullName FROM workers WHERE supervisoryOrganization = ''IT Department'' ORDER BY fullName LIMIT 100'
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Query executed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WqlQueryResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: Maximum number of results to return per page
      schema:
        type: integer
        default: 20
        maximum: 100
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid, or the OAuth 2.0 token lacks the required Workday Query Language scope
    BadRequest:
      description: The WQL query was malformed, contained invalid syntax, or referenced a non-existent data source or field
  schemas:
    WqlQueryResult:
      type: object
      description: Result set from a WQL query execution containing the matched rows and pagination metadata
      properties:
        total:
          type: integer
          description: Total number of rows matching the query
        data:
          type: array
          items:
            type: object
            additionalProperties: true
          description: Array of result rows where each object contains key-value pairs corresponding to the selected fields in the WQL query
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from Workday token endpoint. Requires the Prism Analytics scope.
externalDocs:
  description: Workday Prism Analytics API Documentation
  url: https://doc.workday.com/admin-guide/en-us/workday-prism-analytics/workday-prism-analytics-api.html