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 Data Sources API

Discover available data sources (tables) that can be queried using WQL, including their fields and filter definitions

Workday Report Writer Data Sources 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 Data Sources. 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 4 operations across 4 paths, and defines 3 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}.

4 operations 4 paths 3 schemas 4 GET

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 Data Sources 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 4

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

Data Sources 4

Discover available data sources (tables) that can be queried using WQL, including their fields and filter definitions

GET
/dataSources
Workday Report Writer List Available Data Sources
listDataSources 2 params → 200401
GET
/dataSources/{dataSourceId}
Workday Report Writer Get a Data Source
getDataSource 1 param → 200401404
GET
/dataSources/{dataSourceId}/fields
Workday Report Writer List Data Source Fields
listDataSourceFields 3 params → 200401404
GET
/dataSources/{dataSourceId}/filters
Workday Report Writer List Data Source Filters
listDataSourceFilters 3 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DataSourceField (6 properties), DataSourceFilter (5 properties), DataSource (3 properties). Each schema is shown below with its type and property counts.

DataSource
object
A queryable data source (table) in the Workday data model that can be used in WQL FROM clauses
3 properties
DataSourceFilter
object
A filter definition for a data source that can be used as a parameter in WQL WHERE clauses
5 properties
DataSourceField
object
A field (column) within a data source that can be used in WQL SELECT, WHERE, and ORDER BY clauses
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-report-writer-data-sources-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 Buckets API
Workday Report Writer Custom Reports API
Workday Report Writer Data Change Tasks API
Workday Report Writer Datasets API
Workday Report Writer Query Execution API
Workday Report Writer Tables API