Workflow data models
getWorkflowNodeTypes — 200 response
Successfully retrieved the list of workflow node types.
Lightweight summary of a registered workflow node type, without its input and output schemas.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
description | string | No | Human-readable description of what the node does. | |
id | string | No | The unique identifier of the node type. |
getWorkflowNodeTypes — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypes — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypes — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypes — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypes — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypeSchema — 200 response
Successfully retrieved the node type definition.
| Property | Type | Required | Constraints | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
availableBranches | array<object> | No | min items: 1 | Branches this node may select. Present only for branching nodes; a workflow step using this node may define steps for any subset of these branch IDs, and for no ID outside them. | ||||||||||||||||||||
| ||||||||||||||||||||||||
description | string | No | Human-readable description of what the node does. | |||||||||||||||||||||
id | string | No | The unique identifier of the node type. | |||||||||||||||||||||
inputSchema | object | No | JSON Schema describing the expected input fields for this node. | |||||||||||||||||||||
outputSchema | object | No | JSON Schema describing the output fields produced by this node. | |||||||||||||||||||||
getWorkflowNodeTypeSchema — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypeSchema — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypeSchema — 404 response
The requested schema does not exist or is not accessible.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypeSchema — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypeSchema — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowNodeTypeSchema — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypes — 200 response
Successfully retrieved the list of workflow trigger types.
Lightweight summary of a supported workflow trigger type, without its input and output schemas.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
type | string | No | The trigger type identifier (e.g. 'cron'). |
getWorkflowTriggerTypes — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypes — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypes — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypes — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypes — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypeSchema — 200 response
Successfully retrieved the trigger type definition.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
inputSchema | object | No | JSON Schema describing the trigger configuration fields. | |
outputSchema | object | No | JSON Schema describing the output fields produced by this trigger. | |
type | string | No | The trigger type identifier (e.g. 'cron'). |
getWorkflowTriggerTypeSchema — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypeSchema — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypeSchema — 404 response
The requested schema does not exist or is not accessible.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypeSchema — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypeSchema — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getWorkflowTriggerTypeSchema — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |