data.appdata.document.delete

Soft-delete an end-user document by UUID (shared storage plane; an app served from its own instance reads and writes through the Data API instead)

Soft-delete a document the caller is allowed to remove.

Overview

Property	Value
Workflow type	Atomic
Library	App-appdata
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Authenticated organization UUID
identity_app_uuid	uuid	No	—	(server-resolved principal from the end-user token; input ignored unless it agrees)
end_user_uuid	uuid	No	—	(server-resolved principal from the end-user token; input ignored unless it agrees)
request_id	string	No	—	Caller request id for audit correlation
actor	string	No	—	Workflow caller or agent identifier
document_uuid	uuid	Yes	—	Document UUID

Output Schema

Field	Type	Required	Default	Description
document_uuid	uuid	Yes	—	Document UUID
deleted	boolean	Yes	—	True when the document was soft-deleted
deleted_at	string	No	—	ISO-8601 delete timestamp
failure_reason	string	No	—	Engine-stamped failure reason
failed_at_state	string	No	—	State when the workflow failed
failed_step	string	No	—	Failed DAG step name
failed_layer	integer	No	—	Failed DAG layer index
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	complete	Delete document
completed	No	Yes	Yes	—	Deleted
failed	No	Yes	No	—	Delete failed

State Diagram

Transitions

From	Action	To	Description
pending	complete	completed	—
pending	fail	failed	—

Outcomes

Outcome	Type	Description	State Data Keys
deleted	SUCCESS	Soft-delete an end-user document by UUID (shared storage plane; an app served from its own instance reads and writes through the Data API instead)	document_uuid
failed	FAILURE	Appdata workflow failed	failure_reason

API Usage

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

{
  "workflow_type": "data.appdata.document.delete",
  "initial_data": {
    "organization_uuid": "value",
    "document_uuid": "value"
  }
}