Skip to content
Proud to collaborate with Microsoft for Startups

data.appdata.record.query ​

Query owner-scoped appdata records through the table query policy (routes to the app's storage plane: the shared appdata store, or the app's own Postgres instance when it has one)

Query owner-scoped appdata records through allowed filters and sorts.

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)
database_slugstringNo—Virtual database slug. Optional when the authenticated app has exactly one serving database; required when the app has zero or many.
table_slugstringYes—Virtual table slug
end_user_uuiduuidNo—(server-resolved principal from the end-user token; input ignored unless it agrees)
app_organization_uuiduuidNo—(server-resolved active workspace for organization-mode tables; input rejected if it disagrees)
resource_refstringNo—Optional resource identifier for fine-grained workspace capability checks (ns:verb:resource_ref)
request_idstringNo—Caller request id for audit correlation
actorstringNo—Workflow caller or agent identifier
filtersdictNo—Allowed indexed filters only, plus record_uuid. Value: scalar, list, or {eq
sortlistNo—Allowed indexed sort descriptors only
limitintegerNo—Result limit capped by query policy
offsetintegerNo—Pagination offset

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID echoed from input
identity_app_uuiduuidYes—Identity app UUID echoed from input
database_slugstringYes—Virtual database slug
table_slugstringYes—Virtual table slug
recordslistYes—Scoped result records: record_uuid, created_at, updated_at + selectable fields
countintegerYes—Number of returned records
totalintegerNo—Matching records before limit/offset
has_morebooleanNo—True when more records exist past this page
limitintegerYes—Applied result limit
offsetintegerYes—Applied offset
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
doneYesYesYes——

Outcomes ​

OutcomeTypeDescriptionState Data Keys
queriedSUCCESSQuery owner-scoped appdata records through the table query policy (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.record.query",
  "initial_data": {
    "organization_uuid": "value",
    "table_slug": "value"
  }
}