Compartir a través de


Glossary - Update

Actualice el glosario especificado.

PUT {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}
PUT {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}?api-version=2023-09-01&ignoreTermsAndCategories={ignoreTermsAndCategories}

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.

ignoreTermsAndCategories
query

boolean

Si se omiten términos y categorías

Cuerpo de la solicitud

Nombre Tipo Description
categories

AtlasRelatedCategoryHeader[]

Matriz de categorías.

classifications

AtlasClassification[]

Matriz de clasificaciones.

createTime

integer

Hora de creación del registro.

createdBy

string

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

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

El usuario que actualizó el registro.

usage

string

Uso del glosario.

Respuestas

Nombre Tipo Description
200 OK

AtlasGlossary

La solicitud se ha realizado correctamente.

Other Status Codes

AtlasErrorResponse

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_Update

Solicitud de ejemplo

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

{
  "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",
  "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"
    }
  ]
}

Respuesta de muestra

{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "lastModifiedTS": "2",
  "language": "en",
  "usage": "Example Glossary",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1672892675600,
  "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

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: puede estar activo o eliminado.

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: puede estar activo o eliminado. No se quitan las entidades eliminadas.

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

El mensaje de error.

requestId

string

El 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

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

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

El 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 que se muestra.

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

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: puede estar activo o eliminado.

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

timeZone

string

Zona horaria del límite de tiempo.