Appearance
appdata.query.get ​
Read one saved query, optionally with every earlier version of it
One saved query, optionally with its version history.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-appdata |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | — |
actor_user_uuid | uuid | No | — | Platform user this query belongs to; authorship and private visibility key off it |
saved_query_uuid | uuid | Yes | — | — |
include_versions | boolean | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | — |
saved_query_uuid | uuid | No | — | — |
name | string | No | — | — |
description | string | No | — | — |
sql_text | string | No | — | — |
parameters | list | No | — | — |
tags | list | No | — | — |
folder_uuid | uuid | No | — | — |
folder_name | string | No | — | — |
visibility | string | No | — | — |
pinned | boolean | No | — | — |
version | integer | No | — | — |
created_by_user_uuid | uuid | No | — | — |
updated_by_user_uuid | uuid | No | — | — |
last_run_at | string | No | — | — |
created_at | string | No | — | — |
updated_at | string | No | — | — |
versions | list | No | — | — |
error | string | No | — | Error message when the read failed |
error_type | string | No | — | Error class name when the read failed |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
read | SUCCESS | Read one saved query, optionally with every earlier version of it | saved_query_uuid |
failed | FAILURE | Appdata workflow failed | failure_reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "appdata.query.get",
"initial_data": {
"organization_uuid": "value",
"identity_app_uuid": "value",
"saved_query_uuid": "value"
}
}