Skip to main content
GET
Preview re-pinning a procedure's draft callers
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/previewProcedureRepin The API twin of the procedure page’s Used by re-pin preview. For each draft node that calls procedureId in a workflow you can read, it reports the contract deltas between the node’s current pin and version, and the downstream bindings that survive, have a rename to suggest, or break (consumerImpact). Each row names its workflowId, the id repinProcedure takes. Published versions are never listed: they are immutable. At most 200 nodes are scanned; meta.partial is true when the scan stopped there. A row whose consumerImpact.unavailable is true could not be walked (an unregistered target version, or the read budget), so its zero counts do not mean nothing breaks.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:read. Each row’s workflow must also be readable at its home; other rows are left out.

Query parameters

string
required
The procedure’s id.
string
required
The procedure version to re-pin to.

Responses

200 with data.items (the rows) and meta.partial.

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

procedureId
string
required

The procedure's id. Give it exactly once.

Minimum string length: 1

Query Parameters

version
string
required

The procedure version to re-pin to. Give it exactly once.

Minimum string length: 1

Response

The procedure's draft callers

data
object
required
meta
object
required