Glossary - Create Terms
Cree términos de glosario de forma masiva.
POST {endpoint}/datamap/api/atlas/v2/glossary/terms
POST {endpoint}/datamap/api/atlas/v2/glossary/terms?api-version=2023-09-01&includeTermHierarchy={includeTermHierarchy}
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. |
|
include
|
query |
boolean |
Si se incluye la jerarquía de términos |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
body |
Matriz de definiciones de términos de glosario que se van a crear de forma masiva. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La solicitud se ha realizado correctamente. |
|
Other Status Codes |
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_CreateTerms
Solicitud de ejemplo
POST {endpoint}/datamap/api/atlas/v2/glossary/terms?api-version=2023-09-01
[
{
"anchor": {
"glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
},
"name": "ExampleTerm2",
"status": "Approved",
"shortDescription": "Example Short Description",
"longDescription": "Example Long Description",
"abbreviation": "T2",
"resources": [
{
"displayName": "Example Display Name",
"url": "Example Url"
}
]
},
{
"anchor": {
"glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
},
"name": "ExampleTerm3",
"status": "Approved",
"shortDescription": "Example Short Description",
"longDescription": "Example Long Description",
"abbreviation": "T3",
"resources": [
{
"displayName": "Example Display Name",
"url": "Example Url"
}
]
}
]
Respuesta de muestra
[
{
"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"
},
"resources": [
{
"displayName": "Example Display Name",
"url": "Example Url"
}
]
},
{
"guid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18",
"qualifiedName": "ExampleTerm3@Glossary",
"name": "ExampleTerm3",
"shortDescription": "Example Short Description",
"lastModifiedTS": "1",
"abbreviation": "T3",
"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": "f4de4878-3e43-4f8b-b090-07a233bb0ce6"
},
"resources": [
{
"displayName": "Example Display Name",
"url": "Example Url"
}
]
}
]
Definiciones
Nombre | Description |
---|---|
Atlas |
Instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad. |
Atlas |
Una respuesta de error del servicio |
Atlas |
Encabezado del glosario con información básica. |
Atlas |
Término del glosario. |
Atlas |
Referencia a una instancia de objeto del tipo AtlasEntity usado en los valores de atributo de relación |
Atlas |
Encabezado del término relacionado. |
Atlas |
Captura los detalles del contenido de la estructura. No se crea una instancia directamente, solo se usa a través de AtlasEntity, AtlasClassification. |
Atlas |
Información básica de categorización de términos. |
Atlas |
Estado de la relación de términos atlas |
Entity |
Estado: se puede activar o eliminar |
Purview |
PurviewObjectId |
Resource |
ResourceLink |
Status |
Estado de la relación atlas |
Term |
Estado del término |
Time |
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 |
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 |
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. |
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 |
Encabezado del glosario con información básica. |
|
antonyms |
Matriz de encabezados de términos relacionados como antonios. |
|
assignedEntities |
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 |
Matriz de encabezados de categorización de términos. |
|
classifications |
Matriz de clasificaciones. |
|
classifies |
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 |
Información de jerarquía del término. |
|
isA |
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 |
Matriz de encabezados de términos relacionados preferidos. |
|
preferredToTerms |
Matriz de encabezados de términos relacionados a los que se prefiere. |
|
qualifiedName |
string |
Nombre completo del objeto del glosario. |
replacedBy |
Matriz de encabezados de términos relacionados que se reemplazan por. |
|
replacementTerms |
Matriz de encabezados de términos relacionados para su reemplazo. |
|
resources |
Matriz de vínculo de recursos para el término |
|
seeAlso |
Matriz de encabezados de términos relacionados para ver también. |
|
shortDescription |
string |
Versión corta de la descripción. |
status |
Estado del AtlasGlossaryTerm |
|
synonyms |
Matriz de encabezados de términos relacionados como sinónimos. |
|
templateName |
Template |
Nombre de la plantilla. |
translatedTerms |
Matriz de encabezados de términos relacionados traducidos. |
|
translationTerms |
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 |
Matriz de encabezados de términos relacionados como valores válidos. |
|
validValuesFor |
Matriz de encabezados de términos relacionados como valores válidos para otros registros. |
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 |
Estado de la entidad: se puede activar o eliminar. Las entidades eliminadas no se quitan. |
|
guid |
string |
GUID del objeto . |
relationshipAttributes |
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 |
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 |
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 |
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
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
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. |