Glossary - List

Referencia

Servicio:: Purview

Versión de la API:: 2023-09-01

Obtenga todos los glosarios. Se recomienda usar límite/desplazamiento para obtener el resultado de la paginación. Se recomienda usar 'ignoreTermsAndCategories=true' y capturar términos/categorías por separado mediante 'GET /datamap/api/atlas/v2/glosario/{glosarioId}/terms' y 'GET '/datamap/api/atlas/v2/glosario/{glosarioId}/categories'.

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

Con parámetros opcionales:

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}&ignoreTermsAndCategories={ignoreTermsAndCategories}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string
api-version	query		string	Versión de la API que se va a usar para esta operación.
ignoreTermsAndCategories	query		boolean	Si se omiten términos y categorías
limit	query		integer int32	Tamaño de página: de forma predeterminada no hay paginación.
offset	query		integer int32	Desplazamiento con fines de paginación.
sort	query		string	Criterio de ordenación, ASC (valor predeterminado) o DESC.

Respuestas

Nombre	Tipo	Description
200 OK	AtlasGlossary[]	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_List

Solicitud de ejemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit=1&offset=0&sort=ASC

Respuesta de muestra

status code:: 200

[
  {
    "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "qualifiedName": "Glossary",
    "name": "Glossary",
    "shortDescription": "Example Short Description",
    "longDescription": "Example Long Description",
    "lastModifiedTS": "1",
    "language": "en",
    "usage": "Example Glossary",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1672892675688,
    "updateTime": 1672892675688,
    "terms": [
      {
        "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0",
        "displayText": "ExampleTerm1"
      },
      {
        "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189",
        "displayText": "ExampleTerm2"
      }
    ],
    "categories": [
      {
        "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
        "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2",
        "displayText": "ExampleCategory3"
      },
      {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0",
        "displayText": "ExampleCategory1"
      },
      {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d",
        "displayText": "ExampleCategory2"
      }
    ]
  }
]

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
AtlasGlossary	Objeto de glosario.
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

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

Respuesta de error del servicio

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

AtlasGlossary

Objeto de glosario.

Nombre	Tipo	Description
categories	AtlasRelatedCategoryHeader[]	Matriz de categorías.
classifications	AtlasClassification[]	Matriz de clasificaciones.
createTime	integer	Hora de creación del registro.
createdBy	string	Usuario que creó el registro.
guid	string	GUID del objeto.
language	string	Idioma del glosario.
lastModifiedTS	string	ETag para el control de simultaneidad.
longDescription	string	Descripción de la versión larga.
name	string	Nombre del objeto de glosario.
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	Hora de actualización del registro.
updatedBy	string	Usuario que actualizó el registro.
usage	string	Uso del glosario.

AtlasRelatedCategoryHeader

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

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

Estado de la relación de términos atlas

Nombre	Tipo	Description
ACTIVE	string	activo
DEPRECATED	string	obsolescente
DRAFT	string	corriente de aire
OBSOLETE	string	obsoleto
OTHER	string	Otro

EntityStatus

Estado: se puede activar o eliminar.

Nombre	Tipo	Description
ACTIVE	string	El estado está activo.
DELETED	string	El estado se elimina.

TimeBoundary

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.

Compartir a través de