Glossary - Get Detailed

Referencia

Servicio:: Purview

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

Obtenga un glosario específico con información detallada. Esta API no es recomendable.

Se recomienda capturar los detalles de términos o 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/{glossaryId}/detailed

Con parámetros opcionales:

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed?api-version=2023-09-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string
glossaryId	path	True	string	Identificador único global del glosario.
api-version	query		string	Versión de API que se usará para la operación.

Respuestas

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

Solicitud de ejemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/detailed?api-version=2023-09-01

Respuesta de muestra

status code:: 200

{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "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",
      "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
    },
    {
      "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
    },
    {
      "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
    }
  ],
  "termInfo": {
    "54688d39-b298-4104-9e80-f2a16f44aaea": {
      "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
      "qualifiedName": "ExampleTerm1@Glossary",
      "name": "ExampleTerm1",
      "shortDescription": "Example Short Description",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "2",
      "abbreviation": "T1",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287247276,
      "updateTime": 1606290587593,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
      },
      "assignedEntities": [
        {
          "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
          "typeName": "hdfs_path",
          "entityStatus": "ACTIVE",
          "displayText": "1",
          "relationshipType": "AtlasGlossarySemanticAssignment",
          "relationshipGuid": "cf2e959c-05e6-4a9f-b106-b6475741c2ba",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "AtlasGlossarySemanticAssignment",
            "attributes": {
              "expression": "Example Expression",
              "createdBy": "ExampleCreator",
              "steward": "ExampleSteward",
              "confidence": 100,
              "description": "Example Description",
              "source": "Azure",
              "status": null
            }
          }
        }
      ],
      "categories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007"
        }
      ],
      "seeAlso": [
        {
          "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm2"
        }
      ],
      "synonyms": [
        {
          "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm2"
        }
      ],
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Steward": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Steward Info"
          }
        ]
      },
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    },
    "952c7ba4-4c89-42d8-a05a-7d2161be7008": {
      "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "qualifiedName": "ExampleTerm2@Glossary",
      "name": "ExampleTerm2",
      "shortDescription": "Example Short Description",
      "lastModifiedTS": "1",
      "abbreviation": "T2",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287312495,
      "updateTime": 1606287312495,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189"
      },
      "seeAlso": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm1"
        }
      ],
      "synonyms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm1"
        }
      ],
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    }
  },
  "categoryInfo": {
    "ed7458f0-9463-48a5-b5c6-4f785fb34e12": {
      "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory1",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "3",
      "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",
          "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
        }
      ],
      "terms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
          "displayText": "ExampleTerm1"
        }
      ]
    },
    "e47c4584-daca-4f9e-9092-194e04692c9a": {
      "guid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "qualifiedName": "ExampleCategory2@Glossary",
      "name": "ExampleCategory2",
      "lastModifiedTS": "1",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
      },
      "childrenCategories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
        }
      ]
    },
    "0d6766f6-f4b6-435b-bda2-d3edc358998e": {
      "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
      "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory3",
      "lastModifiedTS": "2",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
      },
      "parentCategory": {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
      }
    }
  }
}

Definiciones

Nombre	Description
AtlasClassification	Instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.
AtlasErrorResponse	Una respuesta de error del servicio
AtlasGlossaryCategory	Categoría del glosario.
AtlasGlossaryExtInfo	Información extendida del glosario.
AtlasGlossaryHeader	Encabezado del glosario con información básica.
AtlasGlossaryTerm	Término del glosario.
AtlasRelatedCategoryHeader	Encabezado de la categoría relacionada.
AtlasRelatedObjectId	Referencia a una instancia de objeto del tipo AtlasEntity usado en los valores de atributo de relación
AtlasRelatedTermHeader	Encabezado del término relacionado.
AtlasStruct	Captura los detalles del contenido de la estructura. No se crea una instancia directamente, solo se usa a través de AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader	Información básica de categorización de términos.
AtlasTermRelationshipStatus	Estado de la relación de términos atlas
EntityStatus	Estado: se puede activar o eliminar
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	Estado de la relación atlas
TermStatus	Estado del término
TimeBoundary	Captura los detalles del límite de tiempo.

AtlasClassification

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 las propagaciones se quitarán en la eliminación de entidades.
typeName	string	Nombre del tipo.
validityPeriods	TimeBoundary[]	Matriz de límites de tiempo que indican períodos de validez.

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.

AtlasGlossaryCategory

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	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 del 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.

AtlasGlossaryExtInfo

Información extendida del glosario.

Nombre	Tipo	Description
categories	AtlasRelatedCategoryHeader[]	Matriz de categorías.
categoryInfo	<string, AtlasGlossaryCategory>	Información de categoría del glosario.
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 del glosario.
shortDescription	string	Versión corta de la descripción.
termInfo	<string, AtlasGlossaryTerm>	Información del término del glosario.
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.

AtlasGlossaryHeader

Encabezado del glosario con información básica.

Nombre	Tipo	Description
displayText	string	Texto que se muestra.
glossaryGuid	string	GUID del glosario.
relationGuid	string	GUID de la relación.

AtlasGlossaryTerm

Término del glosario.

Nombre	Tipo	Description
abbreviation	string	Abreviatura del término.
anchor	AtlasGlossaryHeader	Encabezado del glosario con información básica.
antonyms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados como antonios.
assignedEntities	AtlasRelatedObjectId[]	Matriz de identificadores de objeto relacionados.
attributes	object	Atributos personalizados del término , que es la cadena de asignación<, la cadena de asignación<, el objeto>> . La clave del primer mapa de capas es el nombre de la plantilla de términos.
categories	AtlasTermCategorizationHeader[]	Matriz de encabezados de categorización de términos.
classifications	AtlasClassification[]	Matriz de clasificaciones.
classifies	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados.
contacts	object	Diccionario de contactos para los términos. La clave podría ser experto o administrador.
createTime	integer	Hora de creación del registro.
createdBy	string	Usuario que creó el registro.
examples	string[]	Matriz de ejemplos.
guid	string	GUID del objeto .
hierarchyInfo	PurviewObjectId[]	Información de jerarquía del término.
isA	AtlasRelatedTermHeader[]	Matriz de encabezados de término relacionados que indican que es una relación.
lastModifiedTS	string	ETag para el control de simultaneidad.
longDescription	string	Descripción de la versión larga.
name	string	Nombre del objeto de glosario.
nickName	string	Nombre nick del término.
preferredTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados preferidos.
preferredToTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados a los que se prefiere.
qualifiedName	string	Nombre completo del objeto del glosario.
replacedBy	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados que se reemplazan por.
replacementTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados para su reemplazo.
resources	ResourceLink[]	Matriz de vínculo de recursos para el término
seeAlso	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados para ver también.
shortDescription	string	Versión corta de la descripción.
status	TermStatus	Estado del AtlasGlossaryTerm
synonyms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados como sinónimos.
templateName	TemplateName[]	Nombre de la plantilla.
translatedTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados traducidos.
translationTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados para la traducción.
updateTime	integer	Hora de actualización del registro.
updatedBy	string	Usuario que actualizó el registro.
usage	string	Uso del término .
validValues	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados como valores válidos.
validValuesFor	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados como valores válidos para otros registros.

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 que se muestra.
parentCategoryGuid	string	GUID de la categoría primaria.
relationGuid	string	GUID de la relación.

AtlasRelatedObjectId

Referencia a una instancia de objeto del tipo AtlasEntity usado en los valores de atributo de relación

Nombre	Tipo	Description
displayText	string	Texto que se muestra.
entityStatus	EntityStatus	Estado de la entidad: se puede activar o eliminar. Las entidades eliminadas no se quitan.
guid	string	GUID del objeto .
relationshipAttributes	AtlasStruct	Captura los detalles del contenido de la estructura. No se crea una instancia directamente, solo se usa a través de AtlasEntity, AtlasClassification.
relationshipGuid	string	GUID de la relación.
relationshipStatus	StatusAtlasRelationship	Enumeración del estado de la relación.
relationshipType	string	Tipo de relación
typeName	string	Nombre del tipo.
uniqueAttributes		Atributos únicos del objeto .

AtlasRelatedTermHeader

Encabezado del término relacionado.

Nombre	Tipo	Description
description	string	Descripción del término relacionado.
displayText	string	Texto que se muestra.
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	Administrador del término.
termGuid	string	GUID del término.

AtlasStruct

Captura los detalles del contenido de la estructura. No se crea una instancia directamente, solo se usa a través de AtlasEntity, AtlasClassification.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
lastModifiedTS	string	ETag para el control de simultaneidad.
typeName	string	Nombre del tipo.

AtlasTermCategorizationHeader

Información básica de categorización de términos.

Nombre	Tipo	Description
categoryGuid	string	GUID de la categoría.
description	string	Descripción del registro.
displayText	string	Texto que se muestra.
relationGuid	string	GUID de la relación.
status	AtlasTermRelationshipStatus	Estado de la relación de términos.

AtlasTermRelationshipStatus

Estado de la relación de términos atlas

Nombre	Tipo	Description
ACTIVE	string	active
DEPRECATED	string	deprecated
DRAFT	string	corriente de aire
OBSOLETE	string	obsoletas
OTHER	string	Otros

EntityStatus

Estado: se puede activar o eliminar

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

PurviewObjectId

Nombre	Tipo	Description
displayText	string	Display text
guid	string	GUID del objeto .
itemPath	string	Ruta de acceso del elemento
name	string	Nombre
properties		Diccionario de
resourceId	string	Id. de recurso
typeName	string	Nombre del tipo.
uniqueAttributes		Atributos únicos del objeto .

ResourceLink

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la dirección URL.
url	string	dirección URL web. http o https

StatusAtlasRelationship

Estado de la relación atlas

Nombre	Tipo	Description
ACTIVE	string	active
DELETED	string	deleted

TermStatus

Estado del término

Nombre	Tipo	Description
Alert	string	alerta
Approved	string	Aprobado
Draft	string	corriente de aire
Expired	string	caducado

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 tiempo.
timeZone	string	Zona horaria del límite de tiempo.

Compartir a través de