Aracılığıyla paylaş


Type - List Headers

En az bilgi üst bilgisi listesi olarak döndürülen tüm tür tanımlarını listeleyin.

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 Parametreleri

Name İçinde Gerekli Tür Description
endpoint
path True

string

api-version
query

string

Bu işlem için kullanılacak API sürümü.

includeTermTemplate
query

boolean

Tüm typedef'leri döndürünce termtemplatedef eklenip eklenmeyeceği. Arama filtresi type=term_template olduğunda bu her zaman geçerlidir

type
query

TypeCategory

Typedef'leri aldığınızda arama filtresi olarak typedef adı.

Yanıtlar

Name Tür Description
200 OK

AtlasTypeDefHeader[]

İstek başarılı oldu.

Other Status Codes

AtlasErrorResponse

Beklenmeyen bir hata yanıtı.

Güvenlik

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

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

Örnekler

Type_ListHeaders

Örnek isteği

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

Örnek yanıt

[
  {
    "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"
  }
]

Tanımlar

Name Description
AtlasErrorResponse

Hizmetten bir hata yanıtı

AtlasTypeDefHeader

Tür tanımının temel bilgileri.

TypeCategory

Tür Kategorisi

AtlasErrorResponse

Hizmetten bir hata yanıtı

Name Tür Description
errorCode

string

Hata kodu.

errorMessage

string

Hata iletisi.

requestId

string

İstek kimliği.

AtlasTypeDefHeader

Tür tanımının temel bilgileri.

Name Tür Description
category

TypeCategory

Kategori türü sabit listesi.

guid

string

Tür tanımının GUID'i.

name

string

Tür tanımının adı.

TypeCategory

Tür Kategorisi

Name Tür Description
ARRAY

string

array

CLASSIFICATION

string

sınıflandırma

ENTITY

string

varlık

ENUM

string

enum

MAP

string

map

OBJECT_ID_TYPE

string

nesne kimliği türü

PRIMITIVE

string

Ilkel

RELATIONSHIP

string

Ilişki

STRUCT

string

struct

TERM_TEMPLATE

string

terim şablonu