Type - Get Entity Def By Guid

服务:

Purview

API 版本:

2023-09-01

获取给定 GUID 的实体定义。

GET {endpoint}/datamap/api/atlas/v2/types/entitydef/guid/{guid}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)
guid	path	True	string	实体的全局唯一标识符。

响应

名称	类型	说明
200 OK	AtlasEntityDef	请求已成功。
Other Status Codes	AtlasErrorResponse	意外的错误响应。

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://purview.azure.net/.default

示例

Type_GetEntityDefByGuid

示例请求

HTTP

GET {endpoint}/datamap/api/atlas/v2/types/entitydef/guid/4bc54c37-98a8-4de8-9ee8-182610859d43

示例响应

状态代码:

200

{
  "category": "ENTITY",
  "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553065960959,
  "updateTime": 1553065960959,
  "version": 1,
  "name": "DataSet",
  "description": "DataSet",
  "typeVersion": "1.1",
  "attributeDefs": [],
  "superTypes": [
    "Asset"
  ],
  "subTypes": [
    "rdbms_foreign_key",
    "azure_datalake_gen1_path",
    "hive_table",
    "mssql_column",
    "sqoop_dbdatastore",
    "hbase_column",
    "azure_sql_table",
    "rdbms_instance",
    "azure_datalake_gen2_path",
    "jms_topic",
    "falcon_feed",
    "hbase_table",
    "rdbms_table",
    "rdbms_column",
    "hbase_column_family",
    "hive_column",
    "azure_blob_container",
    "rdbms_db",
    "column",
    "azure_blob_path",
    "kafka_topic",
    "tabular_schema",
    "azure_datalake_gen2_filesystem",
    "rdbms_index",
    "azure_sql_column",
    "mssql_table",
    "avro_type",
    "fs_path"
  ]
}

定义

名称	说明
AtlasAttributeDef	捕获结构属性的详细信息的类。
AtlasConstraintDef	捕获约束详细信息的类。
AtlasEntityDef	捕获实体类型的详细信息的类。
AtlasErrorResponse	来自服务的错误响应
AtlasRelationshipAttributeDef	relationshipEndDef 表示关系的末尾。 关系的末尾由类型、属性名称、基数以及它是否为关系的容器端定义。
CardinalityValue	基数
DateFormat	日期格式。
NumberFormat	数字格式。
RoundingMode	舍入模式
TimeZone	时区信息。
TypeCategory	类型类别

AtlasAttributeDef

Object

捕获结构属性的详细信息的类。

名称	类型	说明
cardinality	CardinalityValue	单值属性或多值属性。
constraints	AtlasConstraintDef[]	约束数组。
defaultValue	string	特性的默认值。
description	string	特性的说明。
includeInNotification	boolean	确定它是否包含在通知中。
isIndexable	boolean	确定它是否可编制索引。
isOptional	boolean	确定它是否为可选。
isUnique	boolean	确定它是否唯一。
name	string	属性的名称。
options	object	属性的选项。
typeName	string	类型的名称。
valuesMaxCount	integer (int32)	值的最大计数。
valuesMinCount	integer (int32)	值的最小计数。

AtlasConstraintDef

Object

捕获约束详细信息的类。

名称	类型	说明
params		约束定义的参数。
type	string	约束的类型。

AtlasEntityDef

Object

捕获实体类型的详细信息的类。

名称	类型	说明
attributeDefs	AtlasAttributeDef[]	属性定义的数组。
category	TypeCategory	类别类型的枚举。
createTime	integer (int64)	记录的创建时间。
createdBy	string	创建记录的用户。
dateFormatter	DateFormat	日期格式。
description	string	类型定义的说明。
guid	string	类型定义的 GUID。
lastModifiedTS	string	用于并发控制的 ETag。
name	string	类型定义的名称。
options	object	类型定义的选项。
relationshipAttributeDefs	AtlasRelationshipAttributeDef[]	关系属性数组。
serviceType	string	服务类型。
subTypes	string[]	子类型的数组。
superTypes	string[]	超级类型的数组。
typeVersion	string	类型的版本。
updateTime	integer (int64)	记录的更新时间。
updatedBy	string	更新记录的用户。
version	integer (int64)	记录的版本。

AtlasErrorResponse

Object

来自服务的错误响应

名称	类型	说明
errorCode	string	错误代码。
errorMessage	string	错误消息。
requestId	string (uuid)	请求 ID。

AtlasRelationshipAttributeDef

Object

relationshipEndDef 表示关系的末尾。 关系的末尾由类型、属性名称、基数以及它是否为关系的容器端定义。

名称	类型	说明
cardinality	CardinalityValue	单值属性或多值属性。
constraints	AtlasConstraintDef[]	约束数组。
defaultValue	string	特性的默认值。
description	string	特性的说明。
includeInNotification	boolean	确定它是否包含在通知中。
isIndexable	boolean	确定它是否可编制索引。
isLegacyAttribute	boolean	确定它是否为旧属性。
isOptional	boolean	确定它是否为可选。
isUnique	boolean	确定它是否唯一。
name	string	属性的名称。
options	object	属性的选项。
relationshipTypeName	string	关系类型的名称。
typeName	string	类型的名称。
valuesMaxCount	integer (int32)	值的最大计数。
valuesMinCount	integer (int32)	值的最小计数。

CardinalityValue

枚举

基数

值	说明
LIST	列表
SET	set
SINGLE	单身

DateFormat

Object

日期格式。

名称	类型	说明
availableLocales	string[]	可用区域设置的数组。
calendar	number (float)	日历
dateInstance	DateFormat	日期格式。
dateTimeInstance	DateFormat	日期格式。
instance	DateFormat	日期格式。
lenient	boolean	确定日期格式的宽大。
numberFormat	NumberFormat	数字格式。
timeInstance	DateFormat	日期格式。
timeZone	TimeZone	时区信息。

NumberFormat

Object

数字格式。

名称	类型	说明
availableLocales	string[]	数字格式。
currency	string	货币。
currencyInstance	NumberFormat	数字格式。
groupingUsed	boolean	确定是否使用分组。
instance	NumberFormat	数字格式。
integerInstance	NumberFormat	数字格式。
maximumFractionDigits	integer (int32)	小数位数的最大值。
maximumIntegerDigits	integer (int32)	整数位数的最大值。
minimumFractionDigits	integer (int32)	小数位数的最小值。
minimumIntegerDigits	integer (int32)	整数位数的最小值。
numberInstance	NumberFormat	数字格式。
parseIntegerOnly	boolean	确定是否只分析整数。
percentInstance	NumberFormat	数字格式。
roundingMode	RoundingMode	舍入模式的枚举。

RoundingMode

枚举

舍入模式

值	说明
CEILING	天花板
DOWN	闭
FLOOR	地板
HALF_DOWN	半下
HALF_EVEN	半偶数
HALF_UP	上半
UNNECESSARY	必要
UP	向上

TimeZone

Object

时区信息。

名称	类型	说明
availableIds	string[]	可用 ID 数组。
default	TimeZone	时区信息。
displayName	string	时区的显示名称。
dstSavings	integer (int32)	夏令时的值。
id	string	时区的 ID。
rawOffset	integer (int32)	时区的原始偏移量。

TypeCategory

枚举

类型类别

值	说明
ARRAY	数组
CLASSIFICATION	分类
ENTITY	实体
ENUM	枚举
MAP	地图
OBJECT_ID_TYPE	对象 ID 类型
PRIMITIVE	原始
RELATIONSHIP	关系
STRUCT	结构
TERM_TEMPLATE	术语模板