Skip to main content
PATCH
TypeScript

Headers

Idempotency-Key
string

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.

Path Parameters

workflowId
string
required

The workflow's identifier.

Body

application/json

Request to change a workflow's status.

status
enum<string>
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.
  • ACTIVEPOST /v1/compliance/orchestrator/screenings accepts screenings against this workflow.
Available options:
ACTIVE,
DRAFT
Example:

"ACTIVE"

Response

Workflow status updated

The workflow's status after the update.

workflowId
string
required

Unique identifier of the workflow.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

status
enum<string>
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.
  • ACTIVEPOST /v1/compliance/orchestrator/screenings accepts screenings against this workflow.
Available options:
ACTIVE,
DRAFT
Example:

"ACTIVE"