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
Records
Update Record Rules
Update the rules associated with a specific record.
POST
/
apps
/
{app_id}
/
collections
/
{collection_id}
/
records
/
{record_id}
/
update-rules
{
"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": {},
"config": {
"id": "<string>",
"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
}
],
"mappings": [
{
"source_path": "LOAN_APPLICATION:income",
"destination_paths": [
"MONTHLY_INCOME:amount",
"ANNUAL_INCOME:amount"
]
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
},
"collection_name": "<string>",
"collection_id": "col_xxx",
"created_by": {
"id": "user_xxx",
"name": "John Doe"
},
"entity": {
"id": "<string>",
"entity_id": "<string>",
"status": "SYNCED",
"type": "ENCOMPASS",
"trigger_id": "<string>",
"record_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
},
"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>"
}
Path Parameters
The ID of the app
The ID of the collection
The ID of the record
Response
200 - application/json
Detailed information about a 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": {},
"config": {
"id": "<string>",
"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
}
],
"mappings": [
{
"source_path": "LOAN_APPLICATION:income",
"destination_paths": [
"MONTHLY_INCOME:amount",
"ANNUAL_INCOME:amount"
]
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
},
"collection_name": "<string>",
"collection_id": "col_xxx",
"created_by": {
"id": "user_xxx",
"name": "John Doe"
},
"entity": {
"id": "<string>",
"entity_id": "<string>",
"status": "SYNCED",
"type": "ENCOMPASS",
"trigger_id": "<string>",
"record_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
},
"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>"
}