Run a Record

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

Response

200 - application/json

Detailed information about a record

collection_id

string

required

Unique identifier of the collection this record belongs to

collection_name

string

required

Name of the collection this record belongs to

config

object

required

Configuration of the collection this record belongs to

created_at

string | null

required

Timestamp when the record was created

created_by

object

required

User who created this record

entity

object | null

required

Entity associated with this record

string

required

Unique identifier for the record

name

string | null

required

Name of the record

rules

object

required

Rules associated with this record

rules.{key}

object

Detailed information about a record rule

rules.{key}.created_at

string | null

required

Timestamp when the record rule was created

rules.{key}.input

object | null

required

Input values used for the rule execution

rules.{key}.key

string

required

Unique key of the rule within the collection

rules.{key}.run

object | null

required

Details of the rule execution workflow run

rules.{key}.run.app_id

string

required

ID of the associated app where the run was triggered from

rules.{key}.run.created_at

string | null

required

Timestamp of when the run was created

rules.{key}.run.ended_at

string | null

required

Timestamp of when the run ended

rules.{key}.run.id

string

required

Unique identifier for the run

rules.{key}.run.input

object | null

required

Input values used for the run

rules.{key}.run.origin

enum<string>

required

Origin of the run

Available options:

WORKFLOW,

RECORD,

TEST,

ENDPOINT

rules.{key}.run.output

object | null

required

Output of the run

rules.{key}.run.started_at

string | null

required

Timestamp of when the run started

rules.{key}.run.status

enum<string>

required

Status of the run

Available options:

PENDING,

RUNNING,

CANCELLED,

COMPLETED,

SKIPPED,

FAILED

rules.{key}.run.updated_at

string | null

required

Timestamp of when the run was last updated

rules.{key}.run.workflow_app_id

string

required

ID of the associated app where the workflow belongs to

rules.{key}.run.workflow_id

string

required

ID of the associated workflow

rules.{key}.run.workflow_version

object | null

required

Details of the workflow version used for the run

rules.{key}.run.workflow_version_draft

object | null

required

Draft version of the workflow

rules.{key}.run.collection_id

string

ID of the associated collection

rules.{key}.run.error

string

Error message if the run failed

rules.{key}.run.record_id

string

ID of the associated record

rules.{key}.run.result

any | null

Result of the run

rules.{key}.run.usage

object

Credits usage of the run

rules.{key}.run.version

number

Version number of the workflow

rules.{key}.status

enum<string>

required

Current status of the record rule

Available options:

DRAFT,

RUNNING,

PASSED,

FAILED,

WARN

rules.{key}.updated_at

string | null

required

Timestamp when the record rule was last updated

rules.{key}.error

string

Error message if the rule execution failed

rules.{key}.result

any | null

Result of the rule execution

rules.{key}.verbose

enum<string>[]

Available options:

all

rules_count

number

required

Total number of rules of this record

rules_fail_count

number

required

Number of failed rules

rules_pass_count

number

required

Number of passed rules

rules_warn_count

number

required

Number of rules with warnings

source

enum<string>

required

Source from which the record was created

Available options:

APP,

API,

TRIGGER

status

enum<string>

required

Current status of the record

Available options:

DRAFT,

QUEUED,

RUNNING,

CANCELLED,

COMPLETED,

FAILED

API Reference

Collections

Records

Workflows

Tests

Variables

Files

Webhooks

Path Parameters

Body

Response