Compartilhar via


Type - List Headers

Liste todas as definições de tipo retornadas como uma lista de cabeçalho de informações mínimas.

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 URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string

api-version
query

string

A versão da API a ser usada para esta operação.

includeTermTemplate
query

boolean

Se incluir termtemplatedef quando retornar todos os typedefs. Isso é sempre verdadeiro quando o filtro de pesquisa type=term_template

type
query

TypeCategory

Typedef name como filtro de pesquisa quando obter typedefs.

Respostas

Nome Tipo Description
200 OK

AtlasTypeDefHeader[]

A solicitação foi bem-sucedida.

Other Status Codes

AtlasErrorResponse

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Exemplos

Type_ListHeaders

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
AtlasErrorResponse

Uma resposta de erro do serviço

AtlasTypeDefHeader

As informações básicas da definição de tipo.

TypeCategory

Categoria do tipo

AtlasErrorResponse

Uma resposta de erro do serviço

Nome Tipo Description
errorCode

string

O código de erro.

errorMessage

string

A mensagem de erro.

requestId

string

A ID da solicitação.

AtlasTypeDefHeader

As informações básicas da definição de tipo.

Nome Tipo Description
category

TypeCategory

A enumeração de categoria de tipo.

guid

string

O GUID da definição de tipo.

name

string

O nome da definição de tipo.

TypeCategory

Categoria do tipo

Nome Tipo Description
ARRAY

string

array

CLASSIFICATION

string

classificação

ENTITY

string

entidade

ENUM

string

enum

MAP

string

mapa

OBJECT_ID_TYPE

string

tipo de ID de objeto

PRIMITIVE

string

Primitivo

RELATIONSHIP

string

relação

STRUCT

string

struct

TERM_TEMPLATE

string

modelo de termo