通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Type - Get Classification Def By Name

  • 参考
服务:
Purview
API 版本:
2023-09-01

按其名称（唯一）获取分类定义。

GET {endpoint}/datamap/api/atlas/v2/types/classificationdef/name/{name}

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string (uri)

name
 path True

string

分类的名称。

响应

名称 类型 说明
200 OK

AtlasClassificationDef

请求已成功。
Other Status Codes

AtlasErrorResponse

意外的错误响应。

安全性

OAuth2Auth

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

作用域

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

示例

Type_GetClassificationDefByName

示例请求

GET {endpoint}/datamap/api/atlas/v2/types/classificationdef/name/MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER

示例响应

状态代码:
200 
{
  "category": "CLASSIFICATION",
  "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553065966043,
  "updateTime": 1553065966043,
  "version": 1,
  "name": "MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER",
  "description": "Canada Social Insurance Number",
  "typeVersion": "1.0",
  "attributeDefs": [],
  "superTypes": [],
  "entityTypes": [],
  "subTypes": []
}

定义

名称 说明
AtlasAttributeDef

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

捕获分类类型的详细信息的类。
AtlasConstraintDef

捕获约束详细信息的类。
AtlasErrorResponse

来自服务的错误响应
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)

值的最小计数。

AtlasClassificationDef

Object

捕获分类类型的详细信息的类。

名称 类型 说明
attributeDefs

AtlasAttributeDef[]

属性定义的数组。
category

TypeCategory

类别类型的枚举。
createTime

integer (int64)

记录的创建时间。
createdBy

string

创建记录的用户。
dateFormatter

DateFormat

日期格式。
description

string

类型定义的说明。
entityTypes

string[]

在 classificationDef 中指定 entityType 名称列表可确保只能将分类应用于这些 entityType。

实体类型的任何子类型都继承限制。

任何 classificationDef 子类型都继承父实体类型限制。

任何 classificationDef 子类型都可以通过指定 entityType 的子集来进一步限制父实体类型限制。

如果没有父限制，则为空 entityTypes 列表意味着没有限制。

当存在父限制时，空 entityTypes 列表意味着子类型会选取父级限制。

如果提供了 entityType 列表，其中一个从另一个实体类型继承，则会被拒绝。 这应鼓励更清洁的 classificationsDefs。
guid

string

类型定义的 GUID。
lastModifiedTS

string

用于并发控制的 ETag。
name

string

类型定义的名称。
options

object

类型定义的选项。
serviceType

string

服务类型。
subTypes

string[]

子类型的数组。
superTypes

string[]

超级类型的数组。
typeVersion

string

类型的版本。
updateTime

integer (int64)

记录的更新时间。
updatedBy

string

更新记录的用户。
version

integer (int64)

记录的版本。

AtlasConstraintDef

Object

捕获约束详细信息的类。

名称 类型 说明
params

约束定义的参数。
type

string

约束的类型。

AtlasErrorResponse

Object

来自服务的错误响应

名称 类型 说明
errorCode

string

错误代码。
errorMessage

string

错误消息。
requestId

string (uuid)

请求 ID。

CardinalityValue

枚举

基数

值 说明
LIST

列表
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

术语模板