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 Business Processes Process Instances API

Manage running business process instances

Workday Business Processes Process Instances API is one of 4 APIs that Workday Business Processes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 14 JSON Schema definitions.

Tagged areas include Process Instances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a changelog, a support channel, and 14 JSON Schemas.

This API exposes 5 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version v41.1.

Requests are made against a single base URL, https://{tenant}.workday.com/api/businessProcess/v1.

5 operations 4 paths 6 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v41.1
Base URL
https://wd2-impl-services1.workday.com/ccx/service
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Workday Business Processes Process Instances API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 5

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

Process Instances 5

Manage running business process instances

GET
/processInstances
Workday List Process Instances
listProcessInstances 5 params → 200401403
POST
/processInstances
Workday Initiate Process
initiateProcess body → 201400401403
GET
/processInstances/{instanceId}
Workday Get Process Instance
getProcessInstance 1 param → 200401403404
POST
/processInstances/{instanceId}/cancel
Workday Cancel Process Instance
cancelProcessInstance 1 param body → 200400401403404
GET
/processInstances/{instanceId}/steps
Workday List Process Steps
listProcessSteps 1 param → 200401403404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ProcessInstance (11 properties), ProcessStep (8 properties), InitiateProcessRequest (4 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

InitiateProcessRequest
object
Request to initiate a new business process instance
4 properties 2 required
ProcessInstance
object
A running or completed business process instance
11 properties 5 required
ErrorResponse
object
Standard error response
3 properties 2 required
ProcessStepsResponse
object
Paginated response containing a list of process steps
2 properties 2 required
ProcessStep
object
A step within a running business process instance
8 properties 4 required
ProcessInstancesResponse
object
Paginated response containing a list of process instances
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-business-processes-process-instances-api-openapi.yml Raw ↑

Other APIs Workday Business Processes publishes across the network.

Workday Business Processes Approvals API
Workday Business Processes Business Process Definitions API
Workday Business Processes Inbox Items API