Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workday Report Writer Buckets API

Manage file upload buckets for staging compressed data files before executing data change tasks against tables

Workday Report Writer Buckets API is one of 9 APIs that Workday Report Writer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Buckets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a GitHub repository, and 1 JSON Schema.

This API exposes 5 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version v3.

Requests are made against a single base URL, https://{hostname}/api/prismAnalytics/v3/{tenant}.

5 operations 4 paths 2 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://wd2-impl-services1.workday.com/ccx/service
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Workday Report Writer Buckets API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 bearer token obtained from Workday token endpoint. Requires the Prism Analytics scope.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Buckets 5

Manage file upload buckets for staging compressed data files before executing data change tasks against tables

GET
/buckets
Workday Report Writer List File Upload Buckets
listBuckets 2 params → 200401
POST
/buckets
Workday Report Writer Create a File Upload Bucket
createBucket body → 201400401
GET
/buckets/{bucketId}
Workday Report Writer Get a File Upload Bucket
getBucket 1 param → 200401404
POST
/buckets/{bucketId}/files
Workday Report Writer Upload a File to a Bucket
uploadFileToBucket 1 param body → 200400401404
POST
/buckets/{bucketId}/complete
Workday Report Writer Complete a Bucket and Trigger Data Change Task
completeBucket 1 param → 200400401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Bucket (7 properties), BucketCreateRequest (3 properties). Each schema is shown below with its type and property counts.

BucketCreateRequest
object
Request body for creating a new file upload bucket
3 properties 3 required
Bucket
object
A file upload bucket for staging data files before executing data change operations on a Prism Analytics table
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-report-writer-buckets-api-openapi.yml Raw ↑

Other APIs Workday Report Writer publishes across the network.

Workday Report Writer API
Workday Report Writer agentDefinition API
Workday Report Writer Custom Reports API
Workday Report Writer Data Change Tasks API
Workday Report Writer Data Sources API
Workday Report Writer Datasets API
Workday Report Writer Query Execution API
Workday Report Writer Tables API