Appearance
roadmap.get ​
Read one roadmap with nodes (and optional events).
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-tickets |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | Yes | — | — |
roadmap_uuid | string | Yes | — | — |
include_nodes | boolean | No | — | — |
include_events | boolean | No | — | — |
event_limit | integer | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
roadmap | dict | No | — | — |
error | string | No | — | Error-as-field envelope populated when query() raises. |
error_type | string | No | — | Error-as-field envelope populated when query() raises. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "roadmap.get",
"initial_data": {
"organization_uuid": "value",
"roadmap_uuid": "value"
}
}