Skip to main content
POST
/
utils
/
metadata
/
catalog-tag-categories
Create or update a catalog tag category
curl --request POST \
  --url https://api.example.com/utils/metadata/catalog-tag-categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category_type": "Classification",
  "description": "Personally Identifiable Information classification",
  "fully_qualified_name": "PII",
  "mutually_exclusive": false,
  "name": "PII"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "fully_qualified_name": "<string>",
  "organization_id": "<string>",
  "version": 123,
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "asset_type": "catalog_tag_category",
  "description": "<string>",
  "category_type": "<string>",
  "mutually_exclusive": false,
  "owners": [
    {}
  ],
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body for creating a catalog tag category.

name
string
required

Category name (e.g., 'PII', 'Sensitivity')

Required string length: 1 - 255
fully_qualified_name
string
required

Single-segment FQN (e.g., 'PII'). Must not contain dots.

Required string length: 1 - 512
description
string | null

Optional category description

Maximum string length: 2000
category_type
enum<string> | null

Category type: 'Classification' or 'Descriptive'

Available options:
Classification,
Descriptive
mutually_exclusive
boolean
default:false

Whether tags in this category are mutually exclusive

owners
Owners · object[] | null

Ownership information

Response

Updated

Full catalog tag category representation.

id
string
required
name
string
required
fully_qualified_name
string
required
organization_id
string
required
version
integer
required
created_by
string
required
updated_by
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
asset_type
string
default:catalog_tag_category
description
string | null
category_type
string | null
mutually_exclusive
boolean
default:false
owners
Owners · object[] | null
deleted_at
string<date-time> | null