Delen via


Type - List Headers

Geef een lijst weer van alle typedefinities die worden geretourneerd als een lijst met minimale informatieheader.

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

Name In Vereist Type Description
endpoint
path True

string

api-version
query

string

De API-versie die voor deze bewerking moet worden gebruikt.

includeTermTemplate
query

boolean

Of termtemplatedef wordt opgenomen bij het retourneren van alle typedefs. Dit geldt altijd wanneer zoekfiltertype=term_template

type
query

TypeCategory

Typdef-naam als zoekfilter bij het ophalen van typedefs.

Antwoorden

Name Type Description
200 OK

AtlasTypeDefHeader[]

De aanvraag is voltooid.

Other Status Codes

AtlasErrorResponse

Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

Type_ListHeaders

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AtlasErrorResponse

Een foutreactie van de service

AtlasTypeDefHeader

De basisinformatie van de typedefinitie.

TypeCategory

Typecategorie

AtlasErrorResponse

Een foutreactie van de service

Name Type Description
errorCode

string

De foutcode.

errorMessage

string

Het foutbericht.

requestId

string

De aanvraag-id.

AtlasTypeDefHeader

De basisinformatie van de typedefinitie.

Name Type Description
category

TypeCategory

De enum van typecategorie.

guid

string

De GUID van de typedefinitie.

name

string

De naam van de typedefinitie.

TypeCategory

Typecategorie

Name Type Description
ARRAY

string

matrix

CLASSIFICATION

string

classificatie

ENTITY

string

entiteit

ENUM

string

Enum

MAP

string

map

OBJECT_ID_TYPE

string

type object-id

PRIMITIVE

string

Primitieve

RELATIONSHIP

string

Relatie

STRUCT

string

Struct

TERM_TEMPLATE

string

termsjabloon