Skip to content
LogoLogo

Preview moving statuses of a lifecycle definition

Preview moving statuses of a lifecycle definition

POST/api/v1/workspaces/{workspace_id}/lifecycle-definitions/{definition_id}/mapping-previews

Requires Workspace management authority. Validates that every source status has exactly one same-kind, same-Workspace, active destination that is not itself retired, and returns bounded per-status impact counts (capped at 10,000, truncated when reached) and the behavior keys whose value would change. If-Match binds the definition revision; a mismatch is 409 revision_conflict. Nothing is written. Pass the returned destination_revisions and source_revision back to apply.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
definition_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

If-MatchRequired
string

Entity tag containing the resource version last observed by the client.

Request Body

application/json
mappingsRequired
object

Source status ID to destination status ID. A source mapped to itself keeps its ID and entities. Sources are exactly the keys.

destination_revisions
object

Apply only. The destination_revisions returned by the preview.

acknowledged
boolean

Apply only. Required when the preview reports requires_acknowledgement.

Responses