appdata.query.update

Update a saved query; the previous text is kept as a version

Edit a saved query, keeping every earlier version.

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	—	—
name	string	No	—	—
sql_text	string	No	—	—
description	string	No	—	—
parameters	list	No	—	—
tags	list	No	—	—
folder_uuid	uuid	No	—	—
folder_name	string	No	—	—
visibility	string	No	—	—
pinned	boolean	No	—	—
mark_run	boolean	No	—	Stamp last_run_at instead of editing; bumps no version

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	—	—
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	Update requested
completed	No	Yes	Yes	—	Update done
failed	No	Yes	No	—	Update failed

State Diagram

Transitions

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

Outcomes

Outcome	Type	Description	State Data Keys
updated	SUCCESS	Update a saved query; the previous text is kept as a version	saved_query_uuid, version
failed	FAILURE	Appdata workflow failed	failure_reason

API Usage

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

{
  "workflow_type": "appdata.query.update",
  "initial_data": {
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "saved_query_uuid": "value"
  }
}