Type - Get Struct Def By Name

참조

서비스:: Purview

API 버전:: 2023-09-01

구조체 정의를 이름(고유)으로 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string (uri)
name	path	True	string	구조체의 이름입니다.

응답

Name	형식	Description
200 OK	AtlasStructDef	요청이 성공했습니다.
Other Status Codes	AtlasErrorResponse	예기치 않은 오류 응답입니다.

보안

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
https://purview.azure.net/.default

예제

Type_GetStructDefByName

샘플 요청

HTTP

GET {endpoint}/datamap/api/atlas/v2/types/structdef/name/hive_order

샘플 응답

상태 코드:: 200

{
  "category": "STRUCT",
  "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553065968145,
  "updateTime": 1553065968145,
  "version": 1,
  "name": "hive_order",
  "description": "hive_order",
  "typeVersion": "1.0",
  "attributeDefs": [
    {
      "name": "order",
      "typeName": "int",
      "isOptional": false,
      "cardinality": "SINGLE",
      "valuesMinCount": 1,
      "valuesMaxCount": 1,
      "isUnique": false,
      "isIndexable": false,
      "includeInNotification": false
    },
    {
      "name": "col",
      "typeName": "string",
      "isOptional": false,
      "cardinality": "SINGLE",
      "valuesMinCount": 1,
      "valuesMaxCount": 1,
      "isUnique": false,
      "isIndexable": false,
      "includeInNotification": false
    }
  ]
}

정의

Name	Description
AtlasAttributeDef	구조체 특성의 세부 정보를 캡처하는 클래스입니다.
AtlasConstraintDef	제약 조건의 세부 정보를 캡처하는 클래스입니다.
AtlasErrorResponse	서비스의 오류 응답
AtlasStructDef	구조체 형식의 세부 정보를 캡처하는 클래스입니다.
CardinalityValue	카디널리티
DateFormat	날짜 형식입니다.
NumberFormat	숫자 형식입니다.
RoundingMode	반올림 모드
TimeZone	표준 시간대 정보입니다.
TypeCategory	형식 범주

AtlasAttributeDef

Object

구조체 특성의 세부 정보를 캡처하는 클래스입니다.

Name	형식	Description
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

제약 조건의 세부 정보를 캡처하는 클래스입니다.

Name	형식	Description
params		제약 조건 정의의 매개 변수입니다.
type	string	제약 조건의 형식입니다.

AtlasErrorResponse

Object

서비스의 오류 응답

Name	형식	Description
errorCode	string	오류 코드입니다.
errorMessage	string	오류 메시지입니다.
requestId	string (uuid)	요청 ID입니다.

AtlasStructDef

Object

구조체 형식의 세부 정보를 캡처하는 클래스입니다.

Name	형식	Description
attributeDefs	AtlasAttributeDef[]	특성 정의의 배열입니다.
category	TypeCategory	형식 범주의 열거형입니다.
createTime	integer (int64)	레코드의 만든 시간입니다.
createdBy	string	레코드를 만든 사용자입니다.
dateFormatter	DateFormat	날짜 형식입니다.
description	string	형식 정의에 대한 설명입니다.
guid	string	형식 정의의 GUID입니다.
lastModifiedTS	string	동시성 제어를 위한 ETag입니다.
name	string	형식 정의의 이름입니다.
options	object	형식 정의에 대한 옵션입니다.
serviceType	string	서비스 유형입니다.
typeVersion	string	형식의 버전입니다.
updateTime	integer (int64)	레코드의 업데이트 시간입니다.
updatedBy	string	레코드를 업데이트한 사용자입니다.
version	integer (int64)	레코드의 버전입니다.

CardinalityValue

열거형

카디널리티

값	Description
LIST	목록
SET	set
SINGLE	싱글

DateFormat

Object

날짜 형식입니다.

Name	형식	Description
availableLocales	string[]	사용 가능한 로캘 배열입니다.
calendar	number (float)	달력
dateInstance	DateFormat	날짜 형식입니다.
dateTimeInstance	DateFormat	날짜 형식입니다.
instance	DateFormat	날짜 형식입니다.
lenient	boolean	날짜 형식의 관용을 결정합니다.
numberFormat	NumberFormat	숫자 형식입니다.
timeInstance	DateFormat	날짜 형식입니다.
timeZone	TimeZone	표준 시간대 정보입니다.

NumberFormat

Object

숫자 형식입니다.

Name	형식	Description
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

열거형

반올림 모드

값	Description
CEILING	천장
DOWN	솜털
FLOOR	floor
HALF_DOWN	절반 아래로
HALF_EVEN	짝수 절반
HALF_UP	반 위로
UNNECESSARY	불필요한
UP	위로

TimeZone

Object

표준 시간대 정보입니다.

Name	형식	Description
availableIds	string[]	사용 가능한 ID의 배열입니다.
default	TimeZone	표준 시간대 정보입니다.
displayName	string	표준 시간대의 표시 이름입니다.
dstSavings	integer (int32)	일광 절약 시간 값입니다.
id	string	표준 시간대의 ID입니다.
rawOffset	integer (int32)	표준 시간대의 원시 오프셋입니다.

TypeCategory

열거형

형식 범주

값	Description
ARRAY	배열
CLASSIFICATION	분류
ENTITY	개체
ENUM	enum
MAP	지도
OBJECT_ID_TYPE	개체 ID 형식
PRIMITIVE	원시적인
RELATIONSHIP	관계
STRUCT	구조체 (struct)
TERM_TEMPLATE	용어 템플릿

다음을 통해 공유

Type - Get Struct Def By Name

URI 매개 변수

응답

보안

OAuth2Auth

범위

예제

Type_GetStructDefByName

샘플 요청

샘플 응답

정의

AtlasAttributeDef

AtlasConstraintDef

AtlasErrorResponse

AtlasStructDef

CardinalityValue

DateFormat

NumberFormat

RoundingMode

TimeZone

TypeCategory