Skip to content

Unified Catalog Entity Type Details



GET /api/v1/unified_catalog/entity_type_cfg/get

Overview

Get details of a single unified catalog entity type.

Query Request Parameters

Parameter Name Type Required Description
entityTypeUUID string Entity Type UUID
Nullable: False
entityType string Entity Type Code
Nullable: False

Parameter Supplementary Notes

Request Parameter Description

Parameter Name type Required Description
entityTypeUUID string No Entity Type UUID
entityType string No Entity Type Code

Call Notes

  • At least one of entityTypeUUID and entityType must be provided.
  • If both parameters are provided, it is recommended to ensure they point to the same entity type.
  • The response includes schemaDefine, viewDefine, and extraConfig.

Request Example

curl 'https://openapi.truewatch.com/api/v1/unified_catalog/entity_type_cfg/get?entityType=service' \
-H 'DF-API-KEY: <DF-API-KEY>'

Response

{
    "code": 200,
    "content": {
        "uuid": "sys_service",
        "entityType": "service",
        "name": "service",
        "schemaDefine": "yaml text",
        "viewDefine": "yaml text",
        "extraConfig": {}
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}