WorkflowStructureResultResponse
0data objectrequired
structure objectrequired
Workflow/Conversation is declared by executor.projectType;Kanban is declared package.json.workflowCode.projectType declaration. This allows the host to choose a running or static preview interface.
Possible values: [workflow, conversation, kanban]
workflow objectrequired
definitions objectrequired
Project-level nodes, API calls, variables, and registry static definitions.
Project-level nodes, API calls, variables, and registry static definitions.
diagnostics objectrequired
Project-level warnings and violations.
Project-level warnings and violations.
Returns only Workflow; must hit one of entrypoints.
Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$
entrypoints object[]
Only Workflow returns the flat independent entry directory in the same order as the source declaration.
Possible values: >= 1
Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$
Possible values: non-empty
execution objectrequired
sequencelocation object
params object[]
Possible values: [string, number, boolean, positional, file]
Shared form control hint. Date-related controls keep string values: date uses YYYY-MM-DD, time uses HH:mm:ss, datetime uses local YYYY-MM-DDTHH:mm:ss, and date-range uses inclusive YYYY-MM-DD/YYYY-MM-DD. Date controls do not support panel=quick.
Possible values: [text, textarea, radio, select, checkboxes, date, time, datetime, date-range]
Possible values: [main, auxiliary, quick]
Whether main composer input changes trigger the selected entrypoint resolver (or the Conversation executor resolver). Defaults to false.
options object[]
Possible values: [json]
paramResolver object
truetokenUsage object
schedulePresets object[]
Only Workflow can declare the proposed plan; the host must be created by user confirmation after presentation and is not automatically enabled.
Possible values: <= 20
Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$
Possible values: non-empty and <= 100 characters
Possible values: <= 500 characters
Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$
trigger objectrequired
Possible values: [WorkflowScheduleWindowIntervalTrigger, WorkflowScheduleCronTrigger]
- WorkflowScheduleWindowIntervalTrigger
- WorkflowScheduleCronTrigger
Monday to Sunday correspond to 1 to 7.
Possible values: >= 1
windows object[]required
Local time windows that do not overlap, with start and end times included in the trigger range.
Possible values: >= 1, <= 12
Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$
Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$
Possible values: >= 1 and <= 1440
5 field Cron, interpreted timezone scheduled.
*/5 9-15 * * 1-5paramValues objectrequired
execution object
Conversation single-entry execution structure;Workflow does not return this top-level compatible field.
sequencelocation object
params object[]
Conversation executor parameters;Workflow parameters in each entrypoint.
Possible values: [string, number, boolean, positional, file]
Shared form control hint. Date-related controls keep string values: date uses YYYY-MM-DD, time uses HH:mm:ss, datetime uses local YYYY-MM-DDTHH:mm:ss, and date-range uses inclusive YYYY-MM-DD/YYYY-MM-DD. Date controls do not support panel=quick.
Possible values: [text, textarea, radio, select, checkboxes, date, time, datetime, date-range]
Possible values: [main, auxiliary, quick]
Whether main composer input changes trigger the selected entrypoint resolver (or the Conversation executor resolver). Defaults to false.
options object[]
Possible values: [json]
paramResolver object
Conversation executor tools;Workflow tools are located in each entrypoint.
tokenUsage object
kanban object
Kanban static artifact boundary.
Static product directory relative to the project root; old projects default ..
distRelative artifactDir HTML entry; default index.html.
index.htmlmanifest object
1params object[]required
Possible values: [string, number, boolean, positional, file]
Shared form control hint. Date-related controls keep string values: date uses YYYY-MM-DD, time uses HH:mm:ss, datetime uses local YYYY-MM-DDTHH:mm:ss, and date-range uses inclusive YYYY-MM-DD/YYYY-MM-DD. Date controls do not support panel=quick.
Possible values: [text, textarea, radio, select, checkboxes, date, time, datetime, date-range]
Possible values: [main, auxiliary, quick]
Whether main composer input changes trigger the selected entrypoint resolver (or the Conversation executor resolver). Defaults to false.
options object[]
Possible values: [json]
{
"errCode": 0,
"errMessage": "string",
"data": {
"workflowId": "string",
"workflowName": "string",
"target": "string",
"resolvedTarget": "string",
"structure": {
"projectType": "workflow",
"workflow": {},
"definitions": {},
"diagnostics": {},
"defaultEntrypoint": "string",
"entrypoints": [
{
"id": "string",
"title": "string",
"description": "string",
"workflowName": "string",
"execution": {
"kind": "sequence",
"location": {},
"children": [
{}
]
},
"params": [
{
"name": "string",
"flag": "string",
"shortFlag": "string",
"type": "string",
"required": true,
"label": "string",
"description": "string",
"defaultValue": "string",
"multiple": true,
"control": "text",
"panel": "main",
"resolveOnInput": true,
"options": [
{
"value": "string",
"label": "string",
"description": "string"
}
],
"accept": [
"string"
],
"format": "json"
}
],
"paramResolver": {
"enabled": true
},
"tools": [
{}
],
"tokenUsage": {},
"registry": [
{}
]
}
],
"schedulePresets": [
{
"id": "string",
"title": "string",
"description": "string",
"entrypointId": "string",
"timezone": "string",
"trigger": {
"kind": "window-interval",
"weekdays": [
0
],
"windows": [
{
"start": "string",
"end": "string"
}
],
"intervalMinutes": 0
},
"paramValues": {}
}
],
"execution": {
"kind": "sequence",
"location": {},
"children": [
{}
]
},
"params": [
{
"name": "string",
"flag": "string",
"shortFlag": "string",
"type": "string",
"required": true,
"label": "string",
"description": "string",
"defaultValue": "string",
"multiple": true,
"control": "text",
"panel": "main",
"resolveOnInput": true,
"options": [
{
"value": "string",
"label": "string",
"description": "string"
}
],
"accept": [
"string"
],
"format": "json"
}
],
"paramResolver": {},
"tools": [
{}
],
"tokenUsage": {},
"registry": [
{}
],
"kanban": {
"artifactDir": "dist",
"entry": "index.html",
"manifest": {
"version": 1,
"params": [
{
"name": "string",
"flag": "string",
"shortFlag": "string",
"type": "string",
"required": true,
"label": "string",
"description": "string",
"defaultValue": "string",
"multiple": true,
"control": "text",
"panel": "main",
"resolveOnInput": true,
"options": [
{
"value": "string",
"label": "string",
"description": "string"
}
],
"accept": [
"string"
],
"format": "json"
}
]
}
}
}
}
}