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 agentDefinition API

To view and maintain Agent Definitions with the Agent System of Record.

Workday Report Writer agentDefinition 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 agentDefinition. 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 2 operations across 1 path, and defines 27 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}.

2 operations 1 paths 27 schemas 1 GET1 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 agentDefinition 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 2

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

agentDefinition 2

To view and maintain Agent Definitions with the Agent System of Record.

GET
/agentDefinition
This operation returns the specific Agent Definition including Skills and certain Tools used in those Skills.
→ 200400401403404default
POST
/agentDefinition
Based on the A2A Agent Card specification, this REST operation allows you to create an Agent Definition in Workday.
body → 201400401403404default

Schemas 27

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

outputModes_71f49719113310002d148ce3f5370000
agentSkill_881e3f87712810000d0bf06dae650000
provider_799da24a09dd10000b827743c6f40000
The service provider of the agent
agentCapabilites_799da24a09dd10000e37766515630000
workdayResource_2e69afd4e86c10001fae2831c6da0000
agent_resource_2e69afd4e86c10001ad2755763bc0000
The Workday Resource for this Tools if applicable.
agentSkillTag_71f49719113310002d130aa875ca0000
agentCardAndTools_a5967cb3b88b10001f7a6900b0d90000
VALIDATION_ERROR_MODEL_REFERENCE
workdayConfig_881e3f87712810000d1cfd55ee0d0001
workdayResources_881e3f877128100010fb617ba5260000
inputModes_71f49719113310002d148ce3f5370001
capabilities_799da24a09dd10000e3a424ec7340000
Optional capabilities supported by the agent.
executionMode_d785eba56e9c10003761356522e00000
The Execution Mode this Skill is operating in. Either Ambient, or Delegate.
workdayTool_a81e152b86021000158aa15c84900000
defaultOutputModes_71f497191133100013c9a17716d50001
tags_71f49719113310002d148ce3f5370002
tools_a81e152b86021000158c36e9bbdc0001
skills_881e3f87712810000d1cfd55ee0d0000
INSTANCE_MODEL_REFERENCE
object
3 properties 1 required
skillTools_881e3f877128100010f2ba3820a20000
defaultInputModes_71f497191133100013c9a17716d50000
agentPlatform_aa793a5c168d1000143f8b9f05c50000
ERROR_MODEL_REFERENCE
object
4 properties 1 required
agentSkillResource_881e3f87712810000d1ba8a0a0510000
mimeType_71f4971911331000139693324a560000
platform_ca94626efa9010003262e35486130000
The platform of the agent.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Workday Report Writer publishes across the network.

Workday Report Writer API
Workday Report Writer Buckets 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