FIfireblocks
Compliance Orchestrator (Beta)

Update a Compliance Orchestrator workflow's status

Moves a workflow between DRAFT and ACTIVE. A workflow must be ACTIVE before POST /v1/compliance/orchestrator/screenings will accept a screening against it. Returns the workflow's id and new status, not its full configuration.

patch/compliance/orchestrator/workflows/{workflowId}/status

Request

Path parameters

workflowIdstring required

The workflow's identifier.

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

status'ACTIVE' | 'DRAFT' required

A workflow's status, which controls whether it can be screened against.

  • DRAFT — the editing state. Rules can be changed while nothing is screening against them, so a screening never runs against a half-finished configuration.
  • ACTIVE — POST /v1/compliance/orchestrator/screenings accepts screenings against this workflow.

Example request

{
  "status": "ACTIVE"
}

Response

Workflow status updated

workflowIdstring required

Unique identifier of the workflow.

status'ACTIVE' | 'DRAFT' required

A workflow's status, which controls whether it can be screened against.

  • DRAFT — the editing state. Rules can be changed while nothing is screening against them, so a screening never runs against a half-finished configuration.
  • ACTIVE — POST /v1/compliance/orchestrator/screenings accepts screenings against this workflow.

Example response

{
  "workflowId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "ACTIVE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.