Skip to main content
GET
Get a published workflow version's nodes and edges
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/getVersionGraph?id=<versionId> Returns the nodes and edges frozen into one published version, in the same shapes as getDraftGraph. Compare it with the draft graph to see what changed since that version. A version’s graph cannot be edited. nodeId and edgeId name the version’s own rows, so the draft graph edit routes answer 404 for them. Rolling back to a version and resetting the draft to one are done by a person in the Forge Console.

Authentication

External App credential or platform API key. Requires permission workflows:read, held at the home org unit of the version’s workflow. The org unit a request acts from is not the workflow’s home.

Query parameters

string
required
The version ID from listVersions. Give it exactly once.

Responses

string
The workflow ID.
string
The version’s ID.
integer
The version number.
WorkflowDraftGraphNode[]
The version’s nodes in creation order, in the getDraftGraph node shape: config holds only the machine-readable fields that are set, and consoleOnlyConfig names the Console-only fields that are set, never their values.
WorkflowDraftGraphEdge[]
The version’s edges in creation order, in the getDraftGraph edge shape.
boolean
true when the version holds more than 200 nodes or 400 edges, and only the first 200 and 400 are returned.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

versionId
string
required

Version id from listVersions. Give it exactly once.

Minimum string length: 1

Response

The version graph; meta.partial is true when it was cut at a limit.

data
object
required

GET /api/v2/workflows/getVersionGraph: one version's frozen nodes and edges in creation order, in the same shapes as WorkflowDraftGraph, at most 200 nodes and 400 edges (meta.partial is true when more exist). nodeId and edgeId name version rows and are not edit handles.

meta
object
required