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
- GETGet a Workflow Run
- POSTReplay a Workflow Run
- POSTCancel a Workflow Run
- PATCHUpdate Run Data Retention Configuration
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Files
Create a Record
Create a new record in the specified collection.
{
"id": "<string>",
"name": "Important Record",
"status": "COMPLETED",
"source": "API",
"usage": {
"total": 123,
"calls": [
{
"id": "<string>",
"total": 123,
"calls": [
{}
]
}
],
"rules": {}
},
"rules_count": 123,
"rules_pass_count": 123,
"rules_fail_count": 123,
"rules_warn_count": 123,
"rules": {},
"collection_name": "<string>",
"collection_id": "col_xxx",
"created_by": {
"id": "user_xxx",
"name": "John Doe"
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"link": "<string>",
"config": {
"id": "<string>",
"mappings": [
{
"source_path": "LOAN_APPLICATION:income",
"destination_paths": [
"MONTHLY_INCOME:amount",
"ANNUAL_INCOME:amount"
]
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"rules": [
{
"name": "Check Business Name",
"key": "CHECK_BUSINESS_NAME",
"execution_order": "before-all",
"on_success": "PASS",
"on_fail": "WARN",
"step_key": "<string>",
"workflow_id": "work_xxx",
"workflow_version_id": "workv_xxx",
"workflow_use_latest": true,
"workflow_input_default": {
"business_name": "Example Corp"
},
"disabled": false,
"workflow": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"rollback_version": 123,
"notes": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"tests_stats": {
"total_count": 123,
"running_count": 123,
"cancelled_count": 123,
"passing_count": 123,
"failing_count": 123,
"expectations_failing_count": 123,
"expectations_passing_count": 123
},
"template_id": "<string>",
"runs_count": 0,
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"enabled": true,
"deleted": false,
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"workflow_version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"rollback_version": 123,
"notes": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
}
}
]
},
"entity": {
"id": "<string>",
"entity_id": "<string>",
"status": "SYNCED",
"type": "ENCOMPASS",
"trigger_id": "<string>",
"record_id": "<string>",
"data": {},
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
}
Path Parameters
The ID of the app
The ID of the collection
Query Parameters
Properties to include in the record response
["all"]
Body
Provide the necessary info to create the record.
Name of the record (up to 128 characters)
1 - 128
"New Important Record"
The rules to be applied to the record
When running the record, specify whether all rules should be executed or only the changed ones
all
, changed
"changed"
Tags to associate with the record (up to 20)
20
["tag_xxx", "tag_yyy"]
Response
You will receive the newly created record details.
Detailed information about a record with the details of the trigger entity and collection configuration
Unique identifier for the record
Name of the record
"Important Record"
Current status of the record
DRAFT
, QUEUED
, RUNNING
, CANCELLED
, COMPLETED
, FAILED
"COMPLETED"
Source from which the record was created
APP
, API
, TRIGGER
, WORKFLOW
"API"
Total number of rules of this record
Number of passed rules
Number of failed rules
Number of rules with warnings
Rules associated with this record
Name of the collection this record belongs to
Unique identifier of the collection this record belongs to
"col_xxx"
User who deployed the version User who created this record
{ "id": "user_xxx", "name": "John Doe" }
Tags associated with this record
Timestamp when the record was created
Timestamp when the record was last updated
Link to the record in the UI
Detailed information about a trigger entity
Credit usage information of the record
Was this page helpful?
{
"id": "<string>",
"name": "Important Record",
"status": "COMPLETED",
"source": "API",
"usage": {
"total": 123,
"calls": [
{
"id": "<string>",
"total": 123,
"calls": [
{}
]
}
],
"rules": {}
},
"rules_count": 123,
"rules_pass_count": 123,
"rules_fail_count": 123,
"rules_warn_count": 123,
"rules": {},
"collection_name": "<string>",
"collection_id": "col_xxx",
"created_by": {
"id": "user_xxx",
"name": "John Doe"
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"link": "<string>",
"config": {
"id": "<string>",
"mappings": [
{
"source_path": "LOAN_APPLICATION:income",
"destination_paths": [
"MONTHLY_INCOME:amount",
"ANNUAL_INCOME:amount"
]
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"rules": [
{
"name": "Check Business Name",
"key": "CHECK_BUSINESS_NAME",
"execution_order": "before-all",
"on_success": "PASS",
"on_fail": "WARN",
"step_key": "<string>",
"workflow_id": "work_xxx",
"workflow_version_id": "workv_xxx",
"workflow_use_latest": true,
"workflow_input_default": {
"business_name": "Example Corp"
},
"disabled": false,
"workflow": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"rollback_version": 123,
"notes": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"tests_stats": {
"total_count": 123,
"running_count": 123,
"cancelled_count": 123,
"passing_count": 123,
"failing_count": 123,
"expectations_failing_count": 123,
"expectations_passing_count": 123
},
"template_id": "<string>",
"runs_count": 0,
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"enabled": true,
"deleted": false,
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"workflow_version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"rollback_version": 123,
"notes": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
}
}
]
},
"entity": {
"id": "<string>",
"entity_id": "<string>",
"status": "SYNCED",
"type": "ENCOMPASS",
"trigger_id": "<string>",
"record_id": "<string>",
"data": {},
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
}