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 Reporting Report Metadata API

Retrieve metadata about report fields, prompts, and filter parameters

Workday Reporting Report Metadata API is one of 7 APIs that Workday Reporting publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Report Metadata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://wd2-impl-services1.workday.com/ccx/service/customreport2/{tenant}.

1 operations 1 paths 4 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://wd2-impl-services1.workday.com/ccx/service/{tenant}/Reporting
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Workday Reporting Report Metadata API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using Workday integration system user credentials (ISU username and password).
  • bearerAuth — OAuth 2.0 bearer token obtained via Workday authentication for report access.

Paths & Operations 1

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

Report Metadata 1

Retrieve metadata about report fields, prompts, and filter parameters

GET
/{reportOwner}/{reportName}/fields
Workday Reporting Get report field metadata
getReportMetadata 2 params → 200401404

Schemas 4

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

ReportMetadata
object
Metadata describing the structure of a Workday report, including its output fields and available prompt parameters for filtering.
4 properties
ReportField
object
Definition of a single report output column
3 properties
ReportPrompt
object
Definition of a report prompt parameter that can be used for filtering report data when executing the report via the API
4 properties
Error
object
Error response returned by the Workday RaaS API
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-reporting-report-metadata-api-openapi.yml Raw ↑

Other APIs Workday Reporting publishes across the network.

Workday Custom Reports API
Workday Advanced Reports API
Workday Prism Analytics REST API
Workday Prism Analytics SOAP Web Service
Workday WQL API
Workday Reporting Reports API