PATCH
/
apps
/
{app_id}
/
collections
/
{collection_id}
/
records
/
{record_id}
curl --request PATCH \
  --url https://api.withcortex.ai/apps/{app_id}/collections/{collection_id}/records/{record_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "tags_ids": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "status": "DRAFT",
  "rules_count": 123,
  "rules_pass_count": 123,
  "rules_fail_count": 123,
  "rules_warn_count": 123,
  "config": {
    "id": "<string>",
    "mappings": [
      {
        "source_path": "<string>",
        "destination_paths": [
          "<string>"
        ]
      }
    ],
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "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,
        "workflow": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "app": {
            "id": "<string>",
            "name": "<string>",
            "verified": true
          },
          "visibility": "PUBLIC",
          "version": {
            "id": "<string>",
            "description": "<string>",
            "version": 123,
            "created_at": "2023-12-25",
            "key": "<string>",
            "input": {},
            "input_default": {},
            "steps": [
              {
                "type": "code",
                "key": "<string>",
                "conditional": "<string>",
                "loop": "<string>",
                "code": "<string>"
              }
            ]
          },
          "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",
          "key": "<string>",
          "input": {},
          "input_default": {},
          "steps": [
            {
              "type": "code",
              "key": "<string>",
              "conditional": "<string>",
              "loop": "<string>",
              "code": "<string>"
            }
          ]
        },
        "workflow_version": {
          "id": "<string>",
          "description": "<string>",
          "version": 123,
          "created_at": "2023-12-25",
          "key": "<string>",
          "input": {},
          "input_default": {},
          "steps": [
            {
              "type": "code",
              "key": "<string>",
              "conditional": "<string>",
              "loop": "<string>",
              "code": "<string>"
            }
          ]
        }
      }
    ]
  },
  "collection_name": "<string>",
  "collection_id": "<string>",
  "created_by": {
    "id": "<string>",
    "name": "<string>"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "app_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "record_rules": [
    {
      "status": "DRAFT",
      "rule_key": "<string>",
      "input": {},
      "run": {
        "id": "<string>",
        "input": {},
        "output": [
          {
            "status": "RUNNING",
            "key": "<string>",
            "output": "<any>",
            "start": 123
          }
        ],
        "status": "PENDING",
        "origin": "WORKFLOW",
        "started_at": "2023-12-25",
        "ended_at": "2023-12-25",
        "workflow_id": "<string>",
        "workflow_version_draft": {
          "key": "<string>",
          "input": {},
          "input_default": {},
          "steps": [
            {
              "type": "code",
              "key": "<string>",
              "conditional": "<string>",
              "loop": "<string>",
              "code": "<string>"
            }
          ]
        },
        "workflow_version": {
          "id": "<string>",
          "description": "<string>",
          "version": 123,
          "created_at": "2023-12-25",
          "key": "<string>",
          "input": {},
          "input_default": {},
          "steps": [
            {
              "type": "code",
              "key": "<string>",
              "conditional": "<string>",
              "loop": "<string>",
              "code": "<string>"
            }
          ]
        },
        "created_at": "2023-12-25",
        "updated_at": "2023-12-25"
      },
      "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

​
name
string | null
Maximum length: 128
​
tags_ids
string[]

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
​
tags
object[]
required
​
record_rules
object[]
required
​
created_at
string | null
required
​
updated_at
string | null
required

Was this page helpful?

Raise issue