Records
Run a Record
API Reference
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
- POSTReplay a Workflow Run
- GETGet a Workflow Run
- POSTCancel a Workflow Run
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Records
Run a Record
Execute the rules associated with a specific record and get the report.
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"
}
Body
Response
200 - application/json
Available options:
DRAFT
, QUEUED
, RUNNING
, CANCELLED
, COMPLETED
, FAILED
Available options:
PASS
, FAIL
, WARN
Available options:
PASS
, FAIL
, WARN
Was this page helpful?
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"
}