Skip to main content
GET
Get the Architect's build progress
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/getArchitectProgress Returns what the Console situation rail shows while the Workflow Architect builds a draft: the build manifest (one row per plan step, with a state derived from the plan, synthesis batches, synthesis requests and graph nodes) and the synthesis drive (one outcome per synthesis request). Nothing is written.

Authentication

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

Query parameters

string
required
The workflow ID. Give it exactly once.

Responses

string
The workflow ID.
string
The draft’s ID.
object[]
At most 200 rows. Each has stepId, name, kind, state (planned, catalog, needs_you, confirmed, building, awaiting_review, awaiting_approval, ready, live, blocked or failed) and findingCount, and when known rationale, coherenceStatus, synthesisRequestId, nodeId and failureReason.
object[]
At most 200 outcomes. Each has procedureId, version, disposition, respecable, attempt and maxAttempts, and when present requestId, finalPrimitiveId, judgeVerdict, heldToolApprovals (the approvals a parked build waits on), credentialRequirement (the host and scheme a build needs a credential for, never a value), reason and detail.
boolean
true when a list or a source was cut: each source (synthesis batches, synthesis requests, graph nodes) is read for at most its newest 200 rows, and each list returns at most 200.

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

workflowId
string
required

Workflow document id. Give it exactly once.

Minimum string length: 1

Response

Get the Architect's build progress

data
object
required
meta
object
required