Term

POST /api/v1/governance/termCreate a new termRequest 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 domain the object belongs to.

string

Workflow or lifecycle status.

array

Alternative names for the term.

array

Array of user IDs that own the 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/term" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Lifetime Value",
    "description": "Projected net revenue from a customer over the relationship",
    "domain_id": "4621afc0-0341-5daa-9be9-f08a475d6df1",
    "status": "draft",
    "synonyms": [
      "CLV",
      "LTV"
    ],
    "owner": [
      "3573f1d4-9b56-5007-b086-b977fe00f6f2"
    ]
  }'

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

Request body

{
  "name": "Customer Lifetime Value",
  "description": "Projected net revenue from a customer over the relationship",
  "domain_id": "4621afc0-0341-5daa-9be9-f08a475d6df1",
  "status": "draft",
  "synonyms": [
    "CLV",
    "LTV"
  ],
  "owner": [
    "3573f1d4-9b56-5007-b086-b977fe00f6f2"
  ]
}

Response

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

POST /api/v1/governance/term/exportReturns export data for terms. Send the same body as the term list endpoint with export set to true.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

object

Page settings.

integer

Page number, starting at 1.

integer

Records per page.

string

Free-text search term.

array

Array of filter objects.

array

Array of sort instructions.

boolean

Set to true to request export output.

string

Free-text search applied across all columns.

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/term/export" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": [],
    "export": true,
    "globalSearch": ""
  }'

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

Request body

{
  "pagination": {
    "page": 1,
    "pageSize": 20
  },
  "search": "",
  "filters": [],
  "sorting": [],
  "export": true,
  "globalSearch": ""
}

Response

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

GET /api/v1/governance/term/{termId}Get a term by IDPath Parameters

string

required

ID of the glossary term.

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: "Policy Status".

string

Example: "Current status of the insurance policy, such as active, expired, or cancelled.".

string

Example: "VERIFIED".

string

Example: "glossary.Business Data.Policy Status".

string

boolean

Example: false.

boolean

Example: false.

boolean

Example: false.

boolean

Example: false.

object[]

string

Example: "e2014484-08cb-5408-947c-a9390b4015bd".

string

Example: "user@example.com".

string

Example: "user@example.com".

string

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

integer

Example: 1.

boolean

Example: true.

boolean

Example: false.

string

Example: "4a1e5723-82d1-52e1-bbc6-2c2014bc4cc8".

integer

Example: 0.

string

Example: "9352b41c-37bf-5f20-be6b-1383d87d1d05".

string

Example: "2026-07-03T13:31:51.224987Z".

string

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

string

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

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

object[]

string

Example: "47196494-faf9-56c7-8e01-64c3564e9625".

string

Example: "glossary".

string

Example:

"A glossary is a curated collection of domain-specific terms and definitions relevant to the automotive industry within the organization."

string

Example: "glossary".

object

integer

Example: 0.

object[]

string

Example: "4a1e5723-82d1-52e1-bbc6-2c2014bc4cc8".

string

Example: "AUTOMOTIVE".

string

Example: "AUTOMOTIVE".

string

object[]

string

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

string

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

string

Example: "user@example.com".

string

Example: "47196494-faf9-56c7-8e01-64c3564e9625".

string

Example: "f24b528c-16af-550e-9f17-4bdc146c9af3".

integer

Example: 0.

string

object[]

object

string

Example

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

Response

{
  "success": true,
  "message": "Get a term by ID",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "name": "Policy Status",
    "description": "Current status of the insurance policy, such as active, expired, or cancelled.",
    "status": "VERIFIED",
    "derived_type": null,
    "source": null,
    "qualified_name": "glossary.Business Data.Policy Status",
    "thresold": null,
    "sensitivity": null,
    "min_length": null,
    "max_length": null,
    "min_value": null,
    "is_null": false,
    "is_blank": false,
    "is_unique": false,
    "is_primary_key": false,
    "enum": [],
    "contains": [],
    "synonyms": [],
    "owner": [
      {
        "id": "e2014484-08cb-5408-947c-a9390b4015bd",
        "name": "user@example.com",
        "label": "user@example.com"
      }
    ],
    "user": null,
    "score": null,
    "total_alerts": 0,
    "total_issues": 0,
    "linked_asset_count": 0,
    "total_views": 1,
    "is_active": true,
    "is_deleted": false,
    "domain_id": "4a1e5723-82d1-52e1-bbc6-2c2014bc4cc8",
    "total_conversations": 0,
    "total_likes": null,
    "total_dislikes": null,
    "definition": null,
    "context": null,
    "who_should_use_this": null,
    "id": "9352b41c-37bf-5f20-be6b-1383d87d1d05",
    "created_at": "2026-07-03T13:31:51.224987Z",
    "modified_at": "2026-09-21T06:39:16.458869Z",
    "created_by": "491be29a-189c-5539-b9c2-6f4f7dc7972a",
    "modified_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68",
    "parents": [
      {
        "id": "47196494-faf9-56c7-8e01-64c3564e9625",
        "name": "glossary",
        "description": "A glossary is a curated collection of domain-specific terms and definitions relevant to the automotive industry within the organization.",
        "type": "glossary"
      }
    ],
    "profile_metrics": {},
    "row_count": 0,
    "domain": [
      {
        "id": "4a1e5723-82d1-52e1-bbc6-2c2014bc4cc8",
        "name": "AUTOMOTIVE",
        "label": "AUTOMOTIVE"
      }
    ],
    "type": null,
    "product": [],
    "tag": [],
    "application": [],
    "viewers": [
      {
        "id": "b86c4d14-0768-5cde-a87e-43628f4ead14",
        "viewed_at": "2026-09-21T10:32:31.510311+00:00",
        "name": null,
        "email": "user@example.com"
      }
    ],
    "glossary_id": "47196494-faf9-56c7-8e01-64c3564e9625",
    "glossary_name": null,
    "glossary_category_id": "f24b528c-16af-550e-9f17-4bdc146c9af3",
    "total_metrics": 0,
    "recent_conversations": null,
    "term_metrics": [],
    "context_freshness": {
      "description": null,
      "owner_verified": null,
      "synonyms": null,
      "metric_updated": null
    }
  }
}

GET /api/v1/governance/term/active/listGet all active termsResponse

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: "Policy Status".

string

Example: "Current status of the insurance policy, such as active, expired, or cancelled.".

string

Example: "VERIFIED".

string

Example: "glossary.Business Data.Policy Status".

string

boolean

Example: false.

boolean

Example: false.

boolean

Example: false.

boolean

Example: false.

object[]

string

Example: "e2014484-08cb-5408-947c-a9390b4015bd".

string

Example: "user@example.com".

string

Example: "user@example.com".

string

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

string

boolean

Example: true.

boolean

Example: false.

string

Example: "4a1e5723-82d1-52e1-bbc6-2c2014bc4cc8".

integer

Example: 0.

string

Example: "9352b41c-37bf-5f20-be6b-1383d87d1d05".

string

Example: "2026-07-03T13:31:51.224987Z".

string

Example: "2026-09-20T05:55:02.447781Z".

string

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

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

string

object[]

string

object[]

string

Example: "47196494-faf9-56c7-8e01-64c3564e9625".

string

Example: "f24b528c-16af-550e-9f17-4bdc146c9af3".

integer

Example: 0.

string

Example

curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/governance/term/active/list" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Get all active terms",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

POST /api/v1/governance/term/listGet terms 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: "Sales Glossary".

string

Example: "PENDING".

object[]

integer

Example: 0.

string

Example: "2f235088-c79e-57fc-9eec-28d4183ae0e9".

integer

Example: 0.

integer

Example: 0.

integer

Example: 0.

string

Example: "a2087701-7e44-57ec-a9a4-87f53737f2e8".

string

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

string

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

object[]

string

Example: "2f235088-c79e-57fc-9eec-28d4183ae0e9".

string

Example: "Finance Domain".

string

Example: "Finance Domain".

string

Example: "Glossary".

object[]

string

Example: "Sales Glossary".

integer

Example: 0.

integer

Example: 1771.

object[]

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/governance/term/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 terms with optional filtering",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "data": [
      {
        "name": "Sales Glossary",
        "description": null,
        "status": "PENDING",
        "enum": [],
        "contains": [],
        "synonyms": [],
        "total_views": 0,
        "domain_id": "2f235088-c79e-57fc-9eec-28d4183ae0e9",
        "total_conversations": 0,
        "total_likes": 0,
        "total_dislikes": 0,
        "id": "a2087701-7e44-57ec-a9a4-87f53737f2e8",
        "created_at": "2026-09-20T17:02:48.308484Z",
        "modified_at": "2026-09-20T17:02:48.308526Z",
        "domain": [
          {
            "id": "2f235088-c79e-57fc-9eec-28d4183ae0e9",
            "name": "Finance Domain",
            "label": "Finance Domain"
          }
        ],
        "type": "Glossary",
        "product": [],
        "tag": [],
        "application": [],
        "viewers": [],
        "glossary_name": "Sales Glossary",
        "total_metrics": 0
      }
    ],
    "total_count": 1771,
    "metrics": []
  }
}

PUT /api/v1/governance/term/{termId}Update a termRequest BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

Free-text description.

string

Workflow or lifecycle status.

Path Parameters

string

required

ID of the glossary term.

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/term/{termId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Projected net revenue from a customer over the entire relationship",
    "status": "approved"
  }'

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

Request body

{
  "description": "Projected net revenue from a customer over the entire relationship",
  "status": "approved"
}

Response

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

DELETE /api/v1/governance/term/{termId}Delete a termPath Parameters

string

required

ID of the glossary term.

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/term/{termId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Delete a term",
  "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