Glossary - Update Term

Referencia

Servicio:: Purview

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

Actualice el término del glosario especificado por su GUID.

PUT {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}

Con parámetros opcionales:

PUT {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}?api-version=2023-09-01&includeTermHierarchy={includeTermHierarchy}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)
termId	path	True	string	Identificador único global del término del glosario.
api-version	query		string minLength: 1	Versión de la API que se va a usar para esta operación.
includeTermHierarchy	query		boolean	Si se incluye la jerarquía de términos

Cuerpo de la solicitud

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	Los atributos personalizados del término , que se asignan<cadena,map<cadena,objeto>>. La clave del primer mapa de capa 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 términos. Clave podría ser experto o administrador.
createTime	integer (int64)	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 de nick del término.
preferredTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados preferidos.
preferredToTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados que se prefieren.
qualifiedName	string	Nombre completo del objeto de 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érmino relacionados para la traducción.
updateTime	integer (int64)	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.

Respuestas

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

Solicitud de ejemplo

HTTP

PUT {endpoint}/datamap/api/atlas/v2/glossary/term/54688d39-b298-4104-9e80-f2a16f44aaea?api-version=2023-09-01

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008"
    },
    {
      "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008"
    },
    {
      "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18"
    }
  ]
}

Respuesta de muestra

status code:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
      "displayText": "ExampleTerm2"
    },
    {
      "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18",
      "relationGuid": "4d802ada-65f3-45a8-969f-aba47d9c6200",
      "displayText": "ExampleTerm3"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
      "displayText": "ExampleTerm2"
    },
    {
      "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18",
      "relationGuid": "bb26fe7c-6e26-46ad-b936-50a5f7ffbbaf",
      "displayText": "ExampleTerm3"
    }
  ],
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ]
}

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
AtlasGlossaryHeader	Encabezado del glosario con información básica.
AtlasGlossaryTerm	Término del glosario.
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, que solo se usa a través de AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader	Información básica para la 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

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.

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.

AtlasGlossaryTerm

Object

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	Los atributos personalizados del término , que se asignan<cadena,map<cadena,objeto>>. La clave del primer mapa de capa 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 términos. Clave podría ser experto o administrador.
createTime	integer (int64)	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 de nick del término.
preferredTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados preferidos.
preferredToTerms	AtlasRelatedTermHeader[]	Matriz de encabezados de términos relacionados que se prefieren.
qualifiedName	string	Nombre completo del objeto de 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érmino relacionados para la traducción.
updateTime	integer (int64)	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.

AtlasRelatedObjectId

Object

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

Nombre	Tipo	Description
displayText	string	Texto para mostrar.
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, que solo se usa a través de AtlasEntity, AtlasClassification.
relationshipGuid	string (uuid)	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

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.

AtlasStruct

Object

Captura los detalles del contenido de la estructura. No se crea una instancia directamente, que 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

Object

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

Nombre	Tipo	Description
categoryGuid	string (uuid)	Guid de la categoría.
description	string	Descripción del registro.
displayText	string	Texto para mostrar.
relationGuid	string (uuid)	GUID de la relación.
status	AtlasTermRelationshipStatus	Estado de la relación de términos.

AtlasTermRelationshipStatus

Enumeración

Estado de la relación de términos atlas

Valor	Description
ACTIVE	activo
DEPRECATED	obsolescente
DRAFT	borrador
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.

PurviewObjectId

Object

PurviewObjectId

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

ResourceLink

Object

ResourceLink

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

StatusAtlasRelationship

Enumeración

Estado de la relación atlas

Valor	Description
ACTIVE	activo
DELETED	deleted

TermStatus

Enumeración

Estado del término

Valor	Description
Alert	alerta
Approved	aprobado
Draft	borrador
Expired	caducado

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.

Compartir a través de

Glossary - Update Term

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

OAuth2Auth

Ámbitos

Ejemplos

Glossary_UpdateTerm

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AtlasClassification

AtlasErrorResponse

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary