Workday Report Writer Data Change Tasks API

openapi: 3.1.0
info:
  title: Workday Report Writer Workday Prism Analytics Buckets Data Change Tasks 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: Data Change Tasks
  description: Execute data change tasks to load, update, or delete data in Prism Analytics tables using files uploaded to buckets
paths:
  /dataChangeTasks:
    get:
      operationId: listDataChangeTasks
      summary: Workday Report Writer List Data Change Tasks
      description: Retrieve a collection of data change tasks. Data change tasks represent operations that modify data in Prism Analytics tables, including inserts, updates, upserts, and deletes.
      tags:
      - Data Change Tasks
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Data change tasks retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: Total number of data change tasks
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DataChangeTask'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /dataChangeTasks/{taskId}:
    get:
      operationId: getDataChangeTask
      summary: Workday Report Writer Get a Data Change Task
      description: Retrieve details of a specific data change task including its status, operation type, row counts, and any error information.
      tags:
      - Data Change Tasks
      parameters:
      - $ref: '#/components/parameters/taskId'
      responses:
        '200':
          description: Data change task details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataChangeTask'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
    taskId:
      name: taskId
      in: path
      required: true
      description: Unique identifier of the data change task
      schema:
        type: string
    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
    NotFound:
      description: The specified resource was not found
  schemas:
    DataChangeTask:
      type: object
      description: A data change task that processes uploaded files and applies data modifications to a Prism Analytics table
      properties:
        id:
          type: string
          description: Unique identifier of the data change task
        displayName:
          type: string
          description: Display name of the task
        status:
          type: string
          description: Current execution status of the task
          enum:
          - Queued
          - Processing
          - Success
          - Error
        operation:
          type: string
          description: Type of data operation performed
          enum:
          - TruncateAndInsert
          - Insert
          - Update
          - Upsert
          - Delete
        targetTable:
          type: object
          properties:
            id:
              type: string
              description: ID of the target table
            descriptor:
              type: string
              description: Display name of the target table
          description: The table that was modified
        rowsInserted:
          type: integer
          description: Number of rows inserted
        rowsUpdated:
          type: integer
          description: Number of rows updated
        rowsDeleted:
          type: integer
          description: Number of rows deleted
        rowsFailed:
          type: integer
          description: Number of rows that failed to process
        startedOn:
          type: string
          format: date-time
          description: Timestamp when the task started processing
        completedOn:
          type: string
          format: date-time
          description: Timestamp when the task completed
        errorMessage:
          type: string
          description: Error details if the task failed
  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