API Reference
Collections
Records
Workflows
- GETDiscover Workflows
- GETGet Discoverable Workflow
- GETGet Discoverable Workflow Version
- POSTRun Discoverable Workflow
- POSTCancel a Discoverable Workflow Run
- GETGet Workflows
- GETGet a Workflow
- GETGet Workflow Runs
- POSTRun a Workflow
- POSTReplay a Workflow Run
- GETGet a Workflow Run
- POSTCancel a Workflow Run
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Get Discoverable Workflow
Retrieve a specific discoverable workflow by its ID.
Path Parameters
The ID of the app
The ID of the workflow
Response
Detailed information about a workflow
Creation date of the workflow
Indicates if the workflow is deleted
Description of the workflow
Unique identifier for the workflow
Input definition of the workflow
The file type allows users to upload files
The type of the input field
file Allowed mime types for the file field (e.g. image/*, application/pdf)
Indicates whether the input field can contain multiple values
Whether to make the field a configuration field (only visible in the configuration tab)
The description of the input field
10240Display options for the file field
Controls how the field container behaves in terms of width and positioning
grid, full, center Controls how the label and input field are arranged (inline or stacked)
inline, stacked Indicates whether the input field is hidden from the UI
The render type of the file field
button, dropzone Flag to extract contents from the file
Flag to extract images from the file
The name of the input field
1024Indicates whether the input field is optional
The order of the input field relative to other fields in the form
x > 0The placeholder of the input field
512Default config input values of the workflow
Input options of the workflow
Display options for the input fields
Controls how the field container behaves in terms of width and positioning
grid, full, center Controls how the label and input field are arranged (inline or stacked)
inline, stacked Indicates whether the input field is hidden from the UI
Unique key for the workflow version
Name of the workflow
Steps of the workflow at the time this version was deployed
A unique key for the step
1 - 128The note content (markdown supported)
The type of the step
note A condition to determine if the step should run
The step keys that this step connects to
Whether the step is connected to the input
A loop condition for the step to repeat running until the condition is met
The position of the step on the canvas
The size of the step on the canvas
Whether to throw an error if the step fails
Tags associated with the workflow
Identifier for the associated app
Color associated with the tag
Timestamp when the tag was created
Unique identifier for the tag
Name of the tag
Timestamp when the tag was last updated
Last update date of the workflow
Current version of the workflow
App id where the workflow version belongs to
Date when the version was deployed
Description of the workflow at the time this version was deployed
Unique identifier for the workflow version
Input definition of the workflow
The file type allows users to upload files
The type of the input field
file Allowed mime types for the file field (e.g. image/*, application/pdf)
Indicates whether the input field can contain multiple values
Whether to make the field a configuration field (only visible in the configuration tab)
The description of the input field
10240Display options for the file field
Controls how the field container behaves in terms of width and positioning
grid, full, center Controls how the label and input field are arranged (inline or stacked)
inline, stacked Indicates whether the input field is hidden from the UI
The render type of the file field
button, dropzone Flag to extract contents from the file
Flag to extract images from the file
The name of the input field
1024Indicates whether the input field is optional
The order of the input field relative to other fields in the form
x > 0The placeholder of the input field
512Default config input values of the workflow
Input options of the workflow
Display options for the input fields
Controls how the field container behaves in terms of width and positioning
grid, full, center Controls how the label and input field are arranged (inline or stacked)
inline, stacked Indicates whether the input field is hidden from the UI
Unique key for the workflow version
Release notes
Steps of the workflow at the time this version was deployed
A unique key for the step
1 - 128The note content (markdown supported)
The type of the step
note A condition to determine if the step should run
The step keys that this step connects to
Whether the step is connected to the input
A loop condition for the step to repeat running until the condition is met
The position of the step on the canvas
The size of the step on the canvas
Whether to throw an error if the step fails
Version number
Workflow id where the version belongs to
Version number from which this version was rolled back
Visibility of the workflow
PUBLIC, PRIVATE Statistics of the workflow tests
Number of cancelled workflow tests
Number of expectations failing in workflow tests
Number of expectations passing in workflow tests
Number of failing workflow tests
Number of passing workflow tests
Number of running workflow tests
Total number of workflow tests
Was this page helpful?