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
Cancel a Record Run
Cancel the ongoing execution of a record.
curl --request POST \
--url https://api.withcortex.ai/apps/{app_id}/collections/{collection_id}/records/{record_id}/cancel{
"id": "<string>",
"name": "Important Record",
"status": "COMPLETED",
"source": "API",
"usage": {
"total": 123,
"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",
"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"
}Path Parameters
The ID of the app
The ID of the collection
The ID of the record
Response
Detailed information about a record
Unique identifier for the record
Name of the record
Current status of the record
DRAFT, QUEUED, RUNNING, CANCELLED, COMPLETED, FAILED Source from which the record was created
APP, API, TRIGGER Total number of rules of this record
Number of passed rules
Number of failed rules
Number of rules with warnings
Rules associated with this record
Detailed information about a record rule
Current status of the record rule
DRAFT, RUNNING, PASSED, FAILED, WARN Unique key of the rule within the collection
Input values used for the rule execution
Details of the rule execution workflow run
Unique identifier for the run
Input values used for the run
Output of the run
Detailed information about the step run
Status of the run
PENDING, RUNNING, CANCELLED, COMPLETED, SKIPPED, FAILED Origin of the run
WORKFLOW, RECORD, TEST, ENDPOINT Timestamp of when the run started
Timestamp of when the run ended
ID of the associated app where the run was triggered from
ID of the associated app where the workflow belongs to
ID of the associated workflow
Draft version of the workflow
Unique key for the workflow version
Input definition of the workflow
Default config input values of the workflow
Input options of the workflow
Steps of the workflow at the time this version was deployed
Details of the workflow version used for the run
Unique identifier for the workflow version
App id where the workflow version belongs to
Workflow id where the version belongs to
Description of the workflow at the time this version was deployed
Version number
Release notes
Date when the version was deployed
Unique key for the workflow version
Input definition of the workflow
Default config input values of the workflow
Input options of the workflow
Steps of the workflow at the time this version was deployed
Version number from which this version was rolled back
User who deployed the version
Timestamp of when the run was created
Timestamp of when the run was last updated
Result of the run
Error message if the run failed
ID of the associated collection
ID of the associated record
Version number of the workflow
Timestamp when the record rule was created
Timestamp when the record rule was last updated
all Result of the rule execution
Error message if the rule execution failed
Configuration of the collection this record belongs to
Unique identifier for the collection configuration
List of rules associated with the collection
Name of the rule
Unique key of the rule within the collection
Action to take if the rule passes
PASS, FAIL, WARN Action to take if the rule fails
PASS, FAIL, WARN Unique identifier of the linked workflow
Unique identifier of the specific workflow version to use
Should the rule use the latest version of the workflow?
When to run this rule compared to others
Default config input values to execute the workflow with
Whether the rule is disabled
Timestamp when the configuration was created
Timestamp when the configuration was last updated
Name of the collection this record belongs to
Unique identifier of the collection this record belongs to
Entity associated with this record
SYNCED, SYNCING ENCOMPASS, PERSONA Tags associated with this record
Unique identifier for the tag
Name of the tag
Color associated with the tag
Identifier for the associated app
Timestamp when the tag was created
Timestamp when the tag was last updated
Timestamp when the record was created
Timestamp when the record was last updated
Was this page helpful?
curl --request POST \
--url https://api.withcortex.ai/apps/{app_id}/collections/{collection_id}/records/{record_id}/cancel{
"id": "<string>",
"name": "Important Record",
"status": "COMPLETED",
"source": "API",
"usage": {
"total": 123,
"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",
"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"
}