Workday Report Writer Datasets API

openapi: 3.1.0
info:
  title: Workday Report Writer Workday Prism Analytics Buckets Datasets 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: Datasets
  description: Manage Prism Analytics datasets, which are read-only data collections used in Prism reports and dashboards
paths:
  /datasets:
    get:
      operationId: listDatasets
      summary: Workday Report Writer List Prism Analytics Datasets
      description: Retrieve a collection of Prism Analytics datasets. Datasets are read-only data collections derived from tables or Workday data sources used in Prism reports and dashboards.
      tags:
      - Datasets
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: name
        in: query
        description: Filter datasets by name
        schema:
          type: string
      responses:
        '200':
          description: Datasets retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: Total number of datasets
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Dataset'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /datasets/{datasetId}:
    get:
      operationId: getDataset
      summary: Workday Report Writer Get a Prism Analytics Dataset
      description: Retrieve details of a specific Prism Analytics dataset including its schema, row count, and last refresh timestamp.
      tags:
      - Datasets
      parameters:
      - $ref: '#/components/parameters/datasetId'
      responses:
        '200':
          description: Dataset details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dataset'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    limit:
      name: limit
      in: query
      description: Maximum number of results to return per page
      schema:
        type: integer
        default: 20
        maximum: 100
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
    datasetId:
      name: datasetId
      in: path
      required: true
      description: Unique identifier (WID) of the Prism Analytics dataset
      schema:
        type: string
  schemas:
    TableField:
      type: object
      description: A field definition within a Prism Analytics table schema
      properties:
        name:
          type: string
          description: Field name used in data files and queries
        displayName:
          type: string
          description: Display name shown in the Prism Analytics UI
        fieldId:
          type: string
          description: Unique identifier of the field
        ordinal:
          type: integer
          description: Position index of the field in the schema
        type:
          $ref: '#/components/schemas/FieldType'
        required:
          type: boolean
          description: Whether the field is required for data loading
        externalId:
          type: boolean
          description: Whether this field serves as a unique identifier for upsert and delete operations
        precision:
          type: integer
          description: Number of decimal places for numeric fields
    FieldType:
      type: object
      description: Data type specification for a table field
      properties:
        id:
          type: string
          description: Type identifier
          enum:
          - Text
          - Numeric
          - Date
          - Boolean
          - Instance
        descriptor:
          type: string
          description: Display name of the field type
    Dataset:
      type: object
      description: A read-only Prism Analytics dataset derived from tables or Workday data sources
      properties:
        id:
          type: string
          description: Unique identifier (WID) of the dataset
        displayName:
          type: string
          description: Display name of the dataset
        name:
          type: string
          description: API name of the dataset
        description:
          type: string
          description: Description of the dataset
        rowCount:
          type: integer
          description: Number of rows in the dataset
        fields:
          type: array
          items:
            $ref: '#/components/schemas/TableField'
          description: Schema field definitions
        createdOn:
          type: string
          format: date-time
          description: Timestamp when the dataset was created
        updatedOn:
          type: string
          format: date-time
          description: Timestamp when the dataset was last refreshed
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
    NotFound:
      description: The specified resource was not found
  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