Dela via


Type - List Headers

Lista alla typdefinitioner som returneras som en lista över minimalt informationshuvud.

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-parametrar

Name I Obligatorisk Typ Description
endpoint
path True

string

api-version
query

string

Den API-version som ska användas för den här åtgärden.

includeTermTemplate
query

boolean

Om inkludera termtemplatedef när du returnerar alla typedefs. Detta är alltid sant när sökfiltertypen =term_template

type
query

TypeCategory

Typedef-namn som sökfilter när du hämtar typedefs.

Svar

Name Typ Description
200 OK

AtlasTypeDefHeader[]

Begäran har slutförts.

Other Status Codes

AtlasErrorResponse

Ett oväntat felsvar.

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

Type_ListHeaders

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AtlasErrorResponse

Ett felsvar från tjänsten

AtlasTypeDefHeader

Grundläggande information om typdefinitionen.

TypeCategory

Typkategori

AtlasErrorResponse

Ett felsvar från tjänsten

Name Typ Description
errorCode

string

Felkoden.

errorMessage

string

Felmeddelandet.

requestId

string

Begärans-ID: t.

AtlasTypeDefHeader

Grundläggande information om typdefinitionen.

Name Typ Description
category

TypeCategory

Uppräkning av typkategori.

guid

string

GUID för typdefinitionen.

name

string

Namnet på typdefinitionen.

TypeCategory

Typkategori

Name Typ Description
ARRAY

string

matris

CLASSIFICATION

string

klassificering

ENTITY

string

Enhet

ENUM

string

Enum

MAP

string

map

OBJECT_ID_TYPE

string

objekt-ID-typ

PRIMITIVE

string

Primitiva

RELATIONSHIP

string

Förhållande

STRUCT

string

Struct

TERM_TEMPLATE

string

termmall