Get Workflow Definition

The API to retrieve a partticular workflow definition.

Input Payload

Attribute	Description
name	The name of the workflow you want to retrieve definition of.
version	Provide the workflow version.
metadata	Provide the metadata details.

API Endpoint

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

Client SDK Methods

Java

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

Go

func (a *MetadataResourceApiService) Get(ctx context.Context, name string, localVarOptionals *MetadataResourceApiGetOpts) (model.WorkflowDef, *http.Response, error)

Python

MetadataResourceApi.get(name, **kwargs)

C#

WorkflowDef MetadataResourceApi.Get(string name, int? version = null, bool? metadata = null)

JavaScript

MatadataResourceService.get(
    name: string,
    version?: number,
    metadata: boolean = false,
  ): CancelablePromise<WorkflowDef>

Typescript

MatadataResourceService.get(
    name: string,
    version?: number,
    metadata: boolean = false,
  ): CancelablePromise<WorkflowDef>

Clojure

(metadata/get-workflow-def options name version)