Glossary - Get Category

Servicio:

Purview

Versión de la API:

2023-09-01

Obtenga una categoría de glosario específica por su GUID.

GET {endpoint}/datamap/api/atlas/v2/glossary/category/{categoryId}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
categoryId	path	True	string	Identificador único global de la categoría.
endpoint	path	True	string (uri)

Respuestas

Nombre	Tipo	Description
200 OK	AtlasGlossaryCategory	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

Glossary_GetCategory

Solicitud de ejemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/category/ed7458f0-9463-48a5-b5c6-4f785fb34e12

Respuesta de muestra

status code:

200

{
  "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
  "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary",
  "name": "ExampleCategory1",
  "lastModifiedTS": "2",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
  },
  "parentCategory": {
    "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
    "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
  },
  "childrenCategories": [
    {
      "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
      "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f",
      "displayText": "ExampleCategory3"
    }
  ],
  "terms": [
    {
      "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
      "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
      "displayText": "ExampleTerm1"
    }
  ]
}

Definiciones

Nombre	Description
AtlasClassification	Una instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.
AtlasErrorResponse	Respuesta de error del servicio
AtlasGlossaryCategory	Categoría del glosario.
AtlasGlossaryHeader	Encabezado del glosario con información básica.
AtlasRelatedCategoryHeader	Encabezado de la categoría relacionada.
AtlasRelatedTermHeader	Encabezado del término relacionado.
AtlasTermRelationshipStatus	Estado de la relación de términos atlas
EntityStatus	Estado: se puede activar o eliminar.
TimeBoundary	Captura los detalles del límite de tiempo

AtlasClassification

Object

Una instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
entityGuid	string	GUID de la entidad.
entityStatus	EntityStatus	Estado de la entidad: se puede activar o eliminar. Las entidades eliminadas no se quitan.
lastModifiedTS	string	ETag para el control de simultaneidad.
removePropagationsOnEntityDelete	boolean	Determina si se quitarán las propagaciones en la eliminación de entidades.
typeName	string	Nombre del tipo.
validityPeriods	TimeBoundary[]	Matriz de límites de tiempo que indica períodos de validez.

AtlasErrorResponse

Object

Respuesta de error del servicio

Nombre	Tipo	Description
errorCode	string	Código de error.
errorMessage	string	Mensaje de error.
requestId	string (uuid)	Identificador de solicitud.

AtlasGlossaryCategory

Object

Categoría del glosario.

Nombre	Tipo	Description
anchor	AtlasGlossaryHeader	Encabezado del glosario con información básica.
childrenCategories	AtlasRelatedCategoryHeader[]	Matriz de categorías secundarias.
classifications	AtlasClassification[]	Matriz de clasificaciones.
createTime	integer (int64)	Hora de creación del registro.
createdBy	string	Usuario que creó el registro.
guid	string	GUID del objeto.
lastModifiedTS	string	ETag para el control de simultaneidad.
longDescription	string	Descripción de la versión larga.
name	string	Nombre del objeto de glosario.
parentCategory	AtlasRelatedCategoryHeader	Encabezado de la categoría relacionada.
qualifiedName	string	Nombre completo del objeto de glosario.
shortDescription	string	Versión corta de la descripción.
terms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados.
updateTime	integer (int64)	Hora de actualización del registro.
updatedBy	string	Usuario que actualizó el registro.

AtlasGlossaryHeader

Object

Encabezado del glosario con información básica.

Nombre	Tipo	Description
displayText	string	Texto para mostrar.
glossaryGuid	string	GUID del glosario.
relationGuid	string	GUID de la relación.

AtlasRelatedCategoryHeader

Object

Encabezado de la categoría relacionada.

Nombre	Tipo	Description
categoryGuid	string	Guid de la categoría.
description	string	Descripción del encabezado de categoría.
displayText	string	Texto para mostrar.
parentCategoryGuid	string	GUID de la categoría primaria.
relationGuid	string	GUID de la relación.

AtlasRelatedTermHeader

Object

Encabezado del término relacionado.

Nombre	Tipo	Description
description	string	Descripción del término relacionado.
displayText	string	Texto para mostrar.
expression	string	Expresión del término.
relationGuid	string	GUID de la relación.
status	AtlasTermRelationshipStatus	Estado de la relación de términos.
steward	string	El administrador del término.
termGuid	string	GUID del término.

AtlasTermRelationshipStatus

Enumeración

Estado de la relación de términos atlas

Valor	Description
ACTIVE	activo
DEPRECATED	obsolescente
DRAFT	corriente de aire
OBSOLETE	obsoleto
OTHER	Otro

EntityStatus

Enumeración

Estado: se puede activar o eliminar.

Valor	Description
ACTIVE	El estado está activo.
DELETED	El estado se elimina.

TimeBoundary

Object

Captura los detalles del límite de tiempo

Nombre	Tipo	Description
endTime	string	Fin del límite de tiempo.
startTime	string	Inicio del límite de hora.
timeZone	string	Zona horaria del límite horario.