POST
/
apps
/
{app_id}
/
collections
/
{collection_id}
/
records
/
{record_id}
/
run
{
  "id": "<string>",
  "name": "Important Record",
  "status": "COMPLETED",
  "source": "API",
  "usage": {
    "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

​
app_id
string
required

The ID of the app

​
collection_id
string
required

The ID of the collection

​
record_id
string
required

The ID of the record

Body

​
mode
enum<string>
required

Specifies which rules to run

Available options:
all,
changed
Example:

"changed"

Response

200 - application/json

Detailed information about a record

​
id
string
required

Unique identifier for the record

​
name
string | null
required

Name of the record

Example:

"Important Record"

​
status
enum<string>
required

Current status of the record

Available options:
DRAFT,
QUEUED,
RUNNING,
CANCELLED,
COMPLETED,
FAILED
Example:

"COMPLETED"

​
source
enum<string>
required

Source from which the record was created

Available options:
APP,
API,
TRIGGER,
WORKFLOW
Example:

"API"

​
rules_count
number
required

Total number of rules of this record

​
rules_pass_count
number
required

Number of passed rules

​
rules_fail_count
number
required

Number of failed rules

​
rules_warn_count
number
required

Number of rules with warnings

​
rules
object
required

Rules associated with this record

​
config
object
required

Configuration of the collection this record belongs to

​
collection_name
string
required

Name of the collection this record belongs to

​
collection_id
string
required

Unique identifier of the collection this record belongs to

Example:

"col_xxx"

​
created_by
object
required

User who deployed the version User who created this record

Example:
{ "id": "user_xxx", "name": "John Doe" }
​
entity
object | null
required

Entity associated with this record

​
tags
object[]
required

Tags associated with this record

​
created_at
string<date> | null
required

Timestamp when the record was created

​
updated_at
string<date> | null
required

Timestamp when the record was last updated

​
link
string
required

Link to the record in the UI

​
usage
object

Credit usage information of the record