다음을 통해 공유


Type - List Headers

최소 정보 헤더 목록으로 반환된 모든 형식 정의를 나열합니다.

GET {endpoint}/datamap/api/atlas/v2/types/typedefs/headers
GET {endpoint}/datamap/api/atlas/v2/types/typedefs/headers?api-version=2023-09-01&includeTermTemplate={includeTermTemplate}&type={type}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
path True

string

api-version
query

string

이 작업에 사용할 API 버전입니다.

includeTermTemplate
query

boolean

모든 typedef를 반환할 때 termtemplatedef를 포함할지 여부입니다. 검색 필터 유형=term_template 경우 항상 true입니다.

type
query

TypeCategory

typedef를 가져올 때 typedef 이름을 검색 필터로 지정합니다.

응답

Name 형식 Description
200 OK

AtlasTypeDefHeader[]

요청이 성공했습니다.

Other Status Codes

AtlasErrorResponse

예기치 않은 오류 응답입니다.

보안

OAuth2Auth

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

범위

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

예제

Type_ListHeaders

샘플 요청

GET {endpoint}/datamap/api/atlas/v2/types/typedefs/headers?api-version=2023-09-01&includeTermTemplate=True

샘플 응답

[
  {
    "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0",
    "name": "hive_principal_type",
    "category": "ENUM"
  },
  {
    "guid": "e5030e81-da05-4571-84f1-265ce20fa6d9",
    "name": "AtlasGlossaryTermRelationshipStatus",
    "category": "ENUM"
  },
  {
    "guid": "d776af9c-985c-4168-abb2-477523dbfc70",
    "name": "MS KPI",
    "category": "TERM_TEMPLATE"
  }
]

정의

Name Description
AtlasErrorResponse

서비스의 오류 응답

AtlasTypeDefHeader

형식 정의의 기본 정보입니다.

TypeCategory

형식 범주

AtlasErrorResponse

서비스의 오류 응답

Name 형식 Description
errorCode

string

오류 코드입니다.

errorMessage

string

오류 메시지입니다.

requestId

string

요청 ID입니다.

AtlasTypeDefHeader

형식 정의의 기본 정보입니다.

Name 형식 Description
category

TypeCategory

형식 범주의 열거형입니다.

guid

string

형식 정의의 GUID입니다.

name

string

형식 정의의 이름입니다.

TypeCategory

형식 범주

Name 형식 Description
ARRAY

string

array

CLASSIFICATION

string

분류

ENTITY

string

엔터티

ENUM

string

enum

MAP

string

map

OBJECT_ID_TYPE

string

개체 ID 형식

PRIMITIVE

string

기본

RELATIONSHIP

string

관계(relationship)

STRUCT

string

struct

TERM_TEMPLATE

string

용어 템플릿