Glossary Category

Create Glossary Category
Get Glossary Category
Get Glossary Categories
Update Glossary Category
Delete Glossary Category

POST /api/v1/governance/glossary-categoryCreate a new glossary categoryRequest BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

Display name.

string

Free-text description.

string

ID of the glossary the object belongs to.

string

ID of the parent object, or null for a top-level object.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/glossary-category" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Lifecycle",
    "description": "Terms describing customer stages",
    "glossary_id": "6bec0bfd-d228-593f-bff0-4b52308f0489",
    "parent_id": null
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "name": "Customer Lifecycle",
  "description": "Terms describing customer stages",
  "glossary_id": "6bec0bfd-d228-593f-bff0-4b52308f0489",
  "parent_id": null
}

Response

{
  "success": true,
  "message": "Create a new glossary category",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

GET /api/v1/governance/glossary-category/{glossaryCategoryId}Get a glossary category by IDPath Parameters

string

required

ID of the glossary category.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

string

Example: "Vendor Attributes".

string

Example: "Name of the Original Equipment Manufacturer responsible for the asset or product.".

string

Example: "41678e8a-e917-5c80-b24c-918e7f180416".

string

Example: "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2".

string

Example: "PENDING".

integer

Example: 0.

string

integer

Example: 1.

boolean

Example: true.

boolean

Example: false.

string

Example: "26b0ae7c-5573-5081-b0ee-4d127e8b8389".

string

Example: "2026-09-20T08:11:10.293430Z".

string

Example: "2026-09-21T06:39:16.470323Z".

string

Example: "491be29a-189c-5539-b9c2-6f4f7dc7972a".

string

object[]

string

Example: "41678e8a-e917-5c80-b24c-918e7f180416".

string

Example: "Default Glossary".

string

Example: "glossary".

object[]

string

Example: "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2".

string

Example: "Customer Domain".

string

Example: "Customer Domain".

object[]

string

Example: "b86c4d14-0768-5cde-a87e-43628f4ead14".

string

Example: "2026-09-21T10:32:25.372466+00:00".

string

Example: "user@example.com".

object

string

Example

curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/governance/glossary-category/{glossaryCategoryId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Get a glossary category by ID",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "name": "Vendor Attributes",
    "description": "Name of the Original Equipment Manufacturer responsible for the asset or product.",
    "source": null,
    "parent_id": null,
    "glossary_id": "41678e8a-e917-5c80-b24c-918e7f180416",
    "domain_id": "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2",
    "qualified_name": null,
    "status": "PENDING",
    "total_conversations": 0,
    "total_likes": null,
    "total_dislikes": null,
    "owner": null,
    "total_views": 1,
    "is_active": true,
    "is_deleted": false,
    "definition": null,
    "context": null,
    "who_should_use_this": null,
    "id": "26b0ae7c-5573-5081-b0ee-4d127e8b8389",
    "created_at": "2026-09-20T08:11:10.293430Z",
    "modified_at": "2026-09-21T06:39:16.470323Z",
    "created_by": "491be29a-189c-5539-b9c2-6f4f7dc7972a",
    "modified_by": null,
    "parents": [
      {
        "id": "41678e8a-e917-5c80-b24c-918e7f180416",
        "name": "Default Glossary",
        "description": null,
        "type": "glossary"
      }
    ],
    "domain": [
      {
        "id": "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2",
        "name": "Customer Domain",
        "label": "Customer Domain"
      }
    ],
    "viewers": [
      {
        "id": "b86c4d14-0768-5cde-a87e-43628f4ead14",
        "viewed_at": "2026-09-21T10:32:25.372466+00:00",
        "name": null,
        "email": "user@example.com"
      }
    ],
    "context_freshness": {
      "description": null,
      "owner_verified": null
    },
    "recent_conversations": null
  }
}

POST /api/v1/governance/glossary-category/listGet glossary categories with optional filteringRequest Body

object

integer

Example: 1.

integer

Example: 10.

object[]

string

Example: "".

boolean

Example: false.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

object[]

string

Example: "Vendor Attributes".

string

Example: "Name of the Original Equipment Manufacturer responsible for the asset or product.".

string

Example: "41678e8a-e917-5c80-b24c-918e7f180416".

string

Example: "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2".

string

Example: "PENDING".

integer

Example: 0.

integer

Example: 0.

boolean

Example: true.

boolean

Example: false.

string

Example: "26b0ae7c-5573-5081-b0ee-4d127e8b8389".

string

Example: "2026-09-20T08:11:10.293430Z".

string

Example: "2026-09-20T17:02:48.315889Z".

string

Example: "491be29a-189c-5539-b9c2-6f4f7dc7972a".

object[]

string

Example: "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2".

string

Example: "Customer Domain".

string

Example: "Customer Domain".

object[]

integer

Example: 396.

object[]

string

Example: "ALL".

integer

Example: 396.

string

Example: "up".

string

Example: "0".

string

Example: "glossary_category".

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/glossary-category/list" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "pagination": {
    "page": 1,
    "pageSize": 10
  },
  "sorting": [],
  "filters": [],
  "search": "",
  "export": false
}'

Response

{
  "success": true,
  "message": "Get glossary categories with optional filtering",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "data": [
      {
        "name": "Vendor Attributes",
        "description": "Name of the Original Equipment Manufacturer responsible for the asset or product.",
        "glossary_id": "41678e8a-e917-5c80-b24c-918e7f180416",
        "domain_id": "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2",
        "status": "PENDING",
        "total_conversations": 0,
        "total_views": 0,
        "is_active": true,
        "is_deleted": false,
        "id": "26b0ae7c-5573-5081-b0ee-4d127e8b8389",
        "created_at": "2026-09-20T08:11:10.293430Z",
        "modified_at": "2026-09-20T17:02:48.315889Z",
        "created_by": "491be29a-189c-5539-b9c2-6f4f7dc7972a",
        "domain": [
          {
            "id": "e3593dd6-3ef5-54d1-938a-4a97c1e1d9c2",
            "name": "Customer Domain",
            "label": "Customer Domain"
          }
        ],
        "viewers": []
      }
    ],
    "total_count": 396,
    "metrics": [
      {
        "title": "ALL",
        "value": 396,
        "trend": "up",
        "trendValue": "0",
        "type": "glossary_category"
      }
    ]
  }
}

PUT /api/v1/governance/glossary-category/{glossaryCategoryId}Update a glossary categoryRequest BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

Display name.

string

Free-text description.

Path Parameters

string

required

ID of the glossary category.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X PUT "https://<your-workspace>.prizmdata.ai/api/v1/governance/glossary-category/{glossaryCategoryId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Lifecycle",
    "description": "Terms describing acquisition, retention and churn"
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "name": "Customer Lifecycle",
  "description": "Terms describing acquisition, retention and churn"
}

Response

{
  "success": true,
  "message": "Update a glossary category",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

DELETE /api/v1/governance/glossary-category/{glossaryCategoryId}Delete a glossary categoryPath Parameters

string

required

ID of the glossary category.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X DELETE "https://<your-workspace>.prizmdata.ai/api/v1/governance/glossary-category/{glossaryCategoryId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Delete a glossary category",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

Get Started

Core

Metrics

Schedule

Notification

Integrations

Governance

Logging