Skip to content
Proud to collaborate with Microsoft for Startups

data.appdata.transaction.apply ​

Apply an ordered batch of appdata record operations atomically in one session and one commit (routes to the app's storage plane: the shared appdata store, or the app's own Postgres instance when it has one)

Apply an ordered batch of appdata record operations in one session/one commit.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-appdata
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Authenticated organization UUID
identity_app_uuiduuidNo—(server-resolved principal from the end-user token; input ignored unless it agrees)
end_user_uuiduuidNo—(server-resolved principal from the end-user token; input ignored unless it agrees)
request_idstringNo—Caller request id for audit correlation
actorstringNo—Workflow caller or agent identifier
operationslistYes—Ordered list of record operations applied atomically. Each item is an object {op: 'create'
idempotency_keystringNo—Optional batch-level idempotency key; a replay with the same key returns the prior result

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID echoed from input
identity_app_uuiduuidYes—Identity app UUID echoed from input
appliedbooleanYes—True when the whole batch committed
countintegerYes—Number of operations applied in the batch
resultslistYes—Per-operation result summaries in input order
replayedbooleanYes—True when returned from an idempotent replay
failure_reasonstringNo—Engine-stamped failure reason
failed_at_statestringNo—State when the workflow failed
failed_stepstringNo—Failed DAG step name
failed_layerintegerNo—Failed DAG layer index
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeApply record batch
completedNoYesYes—Applied
failedNoYesNo—Batch failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
appliedSUCCESSApply an ordered batch of appdata record operations atomically in one session and one commit (routes to the app's storage plane: the shared appdata store, or the app's own Postgres instance when it has one)count
failedFAILUREAppdata workflow failedfailure_reason

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.appdata.transaction.apply",
  "initial_data": {
    "organization_uuid": "value",
    "operations": "value"
  }
}