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 a Record
Retrieve a specific record by its ID.
Path Parameters
The ID of the app
The ID of the collection
The ID of the record
Query Parameters
Properties to include in the record response
all Response
Detailed information about a record with the details of the trigger entity and collection configuration
Unique identifier of the collection this record belongs to
Name of the collection this record belongs to
Timestamp when the configuration was created
Unique identifier for the collection configuration
List of rules associated with the collection with workflow details
Unique key of the rule within the collection
Name of the rule
Action to take if the rule fails
PASS, FAIL, WARN Action to take if the rule passes
PASS, FAIL, WARN 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
Default config input values of the workflow
Input options of the workflow
Display options for the input fields
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
Default config input values of the workflow
Input options of the workflow
Unique key for the workflow version
Release notes
Steps of the workflow at the time this version was deployed
Version number
Workflow id where the version belongs to
User who deployed the version
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
Unique identifier of the linked workflow
Should the rule use the latest version of the workflow?
Information about the workflow version
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
Default config input values of the workflow
Input options of the workflow
Display options for the input fields
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
Unique identifier of the specific workflow version to use
Whether the rule is disabled
When to run this rule compared to others
Timestamp when the configuration was last updated
Timestamp when the record was created
Detailed information about a trigger entity
Timestamp of when the trigger entity was created
Data associated with the trigger entity
Unique identifier of the external source in the connected service
Unique identifier for the trigger entity
Unique identifier of the record associated with the trigger entity
Current status of the trigger entity
SYNCED, SYNCING Unique identifier of the associated trigger
Type of the trigger
ENCOMPASS, PERSONA Timestamp of when the trigger entity was last updated
Unique identifier for the record
Name of the record
Rules associated with this record
Detailed information about a record rule
Timestamp when the record rule was created
Input values used for the rule execution
Unique key of the rule within the collection
Details of the rule execution workflow run
ID of the associated app where the run was triggered from
Timestamp of when the run was created
Timestamp of when the run ended
Unique identifier for the run
Input values used for the run
Origin of the run
WORKFLOW, RECORD, TEST, ENDPOINT Output of the run
Detailed information about the step run
Timestamp of when the run started
Status of the run
PENDING, RUNNING, CANCELLED, COMPLETED, SKIPPED, FAILED Timestamp of when the run was last updated
ID of the associated app where the workflow belongs to
ID of the associated workflow
Details of the workflow version used for the run
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
Default config input values of the workflow
Input options of the workflow
Unique key for the workflow version
Release notes
Steps of the workflow at the time this version was deployed
Version number
Workflow id where the version belongs to
User who deployed the version
Version number from which this version was rolled back
Draft version of the workflow
Input definition of the workflow
Default config input values of the workflow
Input options of the workflow
Unique key for the workflow version
Steps of the workflow at the time this version was deployed
ID of the associated collection
Error message if the run failed
ID of the associated record
Result of the run
Version number of the workflow
Current status of the record rule
DRAFT, RUNNING, PASSED, FAILED, WARN Timestamp when the record rule was last updated
Error message if the rule execution failed
Result of the rule execution
all Total number of rules of this record
Number of failed rules
Number of passed rules
Number of rules with warnings
Source from which the record was created
APP, API, TRIGGER Current status of the record
DRAFT, QUEUED, RUNNING, CANCELLED, COMPLETED, FAILED Tags associated with this record
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
Timestamp when the record was last updated
Was this page helpful?