Compartir a través de


Type - List Headers

Enumere todas las definiciones de tipo devueltas como una lista de encabezados de información mínimos.

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}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string

api-version
query

string

Versión de API que se usará para la operación.

includeTermTemplate
query

boolean

Si incluye termtemplatedef cuando se devuelven todas las definiciones de tipo. Esto siempre es true cuando el tipo de filtro de búsqueda=term_template

type
query

TypeCategory

Nombre de definición de tipo como filtro de búsqueda al obtener definiciones de tipo.

Respuestas

Nombre Tipo Description
200 OK

AtlasTypeDefHeader[]

La solicitud se ha realizado correctamente.

Other Status Codes

AtlasErrorResponse

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Type_ListHeaders

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AtlasErrorResponse

Una respuesta de error del servicio

AtlasTypeDefHeader

Información básica de la definición de tipo.

TypeCategory

Categoría de tipo

AtlasErrorResponse

Una respuesta de error del servicio

Nombre Tipo Description
errorCode

string

Código de error.

errorMessage

string

El mensaje de error.

requestId

string

El identificador de solicitud.

AtlasTypeDefHeader

Información básica de la definición de tipo.

Nombre Tipo Description
category

TypeCategory

Enumeración de tipo categoría.

guid

string

GUID de la definición de tipo.

name

string

Nombre de la definición de tipo.

TypeCategory

Categoría de tipo

Nombre Tipo Description
ARRAY

string

array

CLASSIFICATION

string

clasificación

ENTITY

string

Entidad

ENUM

string

enum

MAP

string

mapa

OBJECT_ID_TYPE

string

tipo de identificador de objeto

PRIMITIVE

string

primitivos

RELATIONSHIP

string

relación

STRUCT

string

struct

TERM_TEMPLATE

string

plantilla de términos