workflow-play-state

Commit Workflow Play State

post/api/workflow-play/state/commit

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/workflow-play/state/commit
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Request body

base_generationinteger required

Committed state generation from which staging began.

patch_artifact_idstring nullable

Optional immutable artifact carrying the complete committed patch.

require_effects_succeededstring[]

Semantic effect keys that must be durably succeeded before commit.

schema_digeststring required

Revision-owned schema digest for the new state.

Response

Successful Response

base_generationinteger required

Generation read before staging.

commit_idstring required

Stable id of the atomic state commit.

committed_atstring required

ISO 8601 state commit time.

delete_countinteger required

Tombstones committed.

new_generationinteger required

Generation created by this commit.

patch_artifact_idstring nullable required

Immutable full-patch artifact id when one was attached.

required_effect_keysstring[] required

Semantic effects proven succeeded before commit.

revision_idstring required

Immutable Play revision that authored the state.

run_idstring required

Workflow run that committed the state.

schema_digeststring required

Revision-owned schema digest committed with state.

signal_countinteger required

Change signals emitted by the commit.

staged_digeststring required

Canonical digest of the committed staged mutations.

state_digeststring required

Canonical digest of the complete committed state.

upsert_countinteger required

Values inserted or replaced.

Changes

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