POST
/
apps
/
{app_id}
/
collections
/
{collection_id}
/
records
/
{record_id}
/
run
curl --request POST \
  --url https://api.withcortex.ai/apps/{app_id}/collections/{collection_id}/records/{record_id}/run \
  --header 'Content-Type: application/json' \
  --data '{
  "all": true
}'
{
  "id": "<string>",
  "name": "<string>",
  "status": "DRAFT",
  "rules_count": 123,
  "rules_pass_count": 123,
  "rules_fail_count": 123,
  "rules_warn_count": 123,
  "config": {
    "id": "<string>",
    "rules": [
      {
        "name": "<string>",
        "key": "<string>",
        "execution_order": "<string>",
        "on_success": "PASS",
        "on_fail": "PASS",
        "workflow_id": "<string>",
        "workflow_version_id": "<string>",
        "workflow_use_latest": true,
        "workflow_input_default": {},
        "disabled": true
      }
    ],
    "mappings": [
      {
        "source_path": "<string>",
        "destination_paths": [
          "<string>"
        ]
      }
    ],
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25"
  },
  "collection_name": "<string>",
  "collection_id": "<string>",
  "created_by": {
    "id": "<string>",
    "name": "<string>"
  },
  "entity": {
    "id": "<string>",
    "entity_id": "<string>",
    "trigger_id": "<string>",
    "record_id": "<string>",
    "data": {},
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "app_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

Path Parameters

app_id
string
required
collection_id
string
required
record_id
string
required

Body

all
boolean
required

Response

200 - application/json
id
string
required
name
string | null
required
status
enum<string>
required
Available options:
DRAFT,
QUEUED,
RUNNING,
CANCELLED,
COMPLETED,
FAILED
rules_count
number
required
rules_pass_count
number
required
rules_fail_count
number
required
rules_warn_count
number
required
config
object
required
collection_name
string
required
collection_id
string
required
created_by
object | null
required
entity
object | null
required
tags
object[]
required
created_at
string | null
required
updated_at
string | null
required