Skip to main content

Get Workflow Definition

Used to retrieve a workflow definition.

Input Payload

nameThe name of the workflow you want to retrieve definition of
versionChoose the workflow version
metadataGet with metadata

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)