Skip to main content
PATCH
/
api
/
datasets
/
{dataset_id}
/
structure
Update Dataset Structure
curl --request PATCH \
  --url https://api.example.com/api/datasets/{dataset_id}/structure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "canonical_classes": [
    "<string>"
  ],
  "class_rules": [
    {
      "matcher_value": "<string>",
      "id": "<string>",
      "enabled": true,
      "matcher_type": "prefix",
      "target_class": "<string>",
      "exclude": false,
      "priority": 0
    }
  ],
  "ignored_paths": [
    "<string>"
  ],
  "engine_overrides": {},
  "folder_attribute_names": {},
  "segmentation_label_names": {}
}
'
{}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

dataset_id
string
required

Cookies

antidote_session
string | null

Body

application/json
canonical_classes
string[] | null
class_rules
DatasetStructureRulePatch · object[] | null
ignored_paths
string[] | null
engine_overrides
Engine Overrides · object
folder_attribute_names
Folder Attribute Names · object
segmentation_label_names
Segmentation Label Names · object

Response

Successful Response

The response is of type Response Update Dataset Structure Api Datasets Dataset Id Structure Patch · object.