Skip to main content

Get Workflow Definition

The API to retrieve a partticular workflow definition.

Input Payload

nameThe name of the workflow you want to retrieve definition of.
versionProvide the workflow version.
metadataProvide the metadata details.

API Endpoint

GET /api/metadata/workflow/{name}?version=<version>&metadata=false

Client SDK Methods

WorkflowDef OrkesMetadataClient.getWorkflowDef(String name, Integer version)
WorkflowDef OrkesMetadataClient.getWorkflowDefWithMetadata(String name, Integer version)