Condividi tramite

Glossary - Partial Update Term

  • Riferimento
Servizio:
Purview
Versione API:
2023-09-01

Aggiornare parzialmente il termine glossario. Finora supporta solo l'aggiornamento parziale shortDescription, longDescription, abbreviazione, utilizzo e stato per il termine.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

termId
 path True

string

Identificatore univoco globale per il termine glossario.
api-version
 query

string

Versione dell'API da usare per questa operazione.
includeTermHierarchy
 query

boolean

Indica se includere la gerarchia dei termini

Risposte

Nome Tipo Descrizione
200 OK

AtlasGlossaryTerm

La richiesta ha avuto esito positivo.
Other Status Codes

AtlasErrorResponse

Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
https://purview.azure.net/.default

Esempio

Glossary_PartialUpdateTerm

Esempio di richiesta

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

{
  "longDescription": "Example Long Description"
}

Risposta di esempio

Codice di stato:
200 
{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Descrition",
  "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"
  },
  "categories": [
    {
      "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
      "displayText": "ExampleCategory1"
    }
  ],
  "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"
    }
  ],
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ]
}

Definizioni

Nome Descrizione
AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo se associato a un'entità.
AtlasErrorResponse

Risposta di errore dal servizio
AtlasGlossaryHeader

Intestazione del glossario con informazioni di base.
AtlasGlossaryTerm

Termine di glossario.
AtlasRelatedObjectId

Riferimento a un'istanza oggetto del tipo AtlasEntity usato nei valori degli attributi di relazione
AtlasRelatedTermHeader

Intestazione del termine correlato.
AtlasStruct

Acquisisce i dettagli del contenuto dello struct. Non creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader

Informazioni di base per la categorizzazione dei termini.
AtlasTermRelationshipStatus

Stato per la relazione del termine atlas
EntityStatus

Stato : può essere attivo o eliminato
PurviewObjectId

PurviewObjectId
ResourceLink

ResourceLink
StatusAtlasRelationship

Stato per la relazione atlas
TermStatus

Stato per il termine
TimeBoundary

Acquisisce i dettagli del limite temporale

AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo se associato a un'entità.

Nome Tipo Descrizione
attributes

Attributi dello struct.
entityGuid

string

GUID dell'entità.
entityStatus

EntityStatus

Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
lastModifiedTS

string

ETag per il controllo della concorrenza.
removePropagationsOnEntityDelete

boolean

Determina se le propagazioni verranno rimosse durante l'eliminazione dell'entità.
typeName

string

Nome del tipo.
validityPeriods

TimeBoundary[]

Matrice di limiti di tempo che indica i periodi di validità.

AtlasErrorResponse

Risposta di errore dal servizio

Nome Tipo Descrizione
errorCode

string

Codice di errore.
errorMessage

string

Messaggio di errore.
requestId

string

ID richiesta.

AtlasGlossaryHeader

Intestazione del glossario con informazioni di base.

Nome Tipo Descrizione
displayText

string

Testo visualizzato.
glossaryGuid

string

GUID del glossario.
relationGuid

string

GUID della relazione.

AtlasGlossaryTerm

Termine di glossario.

Nome Tipo Descrizione
abbreviation

string

Abbreviazione del termine .
anchor

AtlasGlossaryHeader

Intestazione del glossario con informazioni di base.
antonyms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate come antonyms.
assignedEntities

AtlasRelatedObjectId[]

Matrice di ID oggetto correlati.
attributes

object

Attributi personalizzati del termine, ovvero stringa di mapping<, stringa di mapping<, oggetto>>. La chiave della prima mappa livello è il nome del modello di termine.
categories

AtlasTermCategorizationHeader[]

Matrice di intestazioni di categorizzazione dei termini.
classifications

AtlasClassification[]

Matrice di classificazioni.
classifies

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate.
contacts

object

Dizionario dei contatti per i termini. La chiave potrebbe essere Expert o Steward.
createTime

integer

Ora di creazione del record.
createdBy

string

Utente che ha creato il record.
examples

string[]

Matrice di esempi.
guid

string

GUID dell'oggetto .
hierarchyInfo

PurviewObjectId[]

Informazioni sulla gerarchia del termine.
isA

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate che indicano che è una relazione.
lastModifiedTS

string

ETag per il controllo della concorrenza.
longDescription

string

Descrizione della versione lunga.
name

string

Nome dell'oggetto glossario.
nickName

string

Nome nick del termine.
preferredTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate preferite.
preferredToTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate a cui si preferisce.
qualifiedName

string

Nome completo dell'oggetto glossario.
replacedBy

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate sostituite da .
replacementTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate per la sostituzione.
resources

ResourceLink[]

Matrice di collegamento alla risorsa per il termine
seeAlso

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate per vedere anche.
shortDescription

string

Versione breve della descrizione.
status

TermStatus

Stato di AtlasGlossaryTerm
synonyms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate come sinonimi.
templateName

TemplateName[]

Nome del modello.
translatedTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate tradotte.
translationTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate per la traduzione.
updateTime

integer

Ora di aggiornamento del record.
updatedBy

string

Utente che ha aggiornato il record.
usage

string

Utilizzo del termine.
validValues

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate come valori validi.
validValuesFor

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate come valori validi per altri record.

AtlasRelatedObjectId

Riferimento a un'istanza oggetto del tipo AtlasEntity usato nei valori degli attributi di relazione

Nome Tipo Descrizione
displayText

string

Testo visualizzato.
entityStatus

EntityStatus

Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
guid

string

GUID dell'oggetto .
relationshipAttributes

AtlasStruct

Acquisisce i dettagli del contenuto dello struct. Non è stata creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.
relationshipGuid

string

GUID della relazione.
relationshipStatus

StatusAtlasRelationship

Enumerazione dello stato della relazione.
relationshipType

string

Tipo di relazione
typeName

string

Nome del tipo.
uniqueAttributes

Attributi univoci dell'oggetto.

AtlasRelatedTermHeader

Intestazione del termine correlato.

Nome Tipo Descrizione
description

string

Descrizione del termine correlato.
displayText

string

Testo visualizzato.
expression

string

Espressione del termine .
relationGuid

string

GUID della relazione.
status

AtlasTermRelationshipStatus

Stato della relazione tra termini.
steward

string

Amministratore del termine.
termGuid

string

GUID del termine.

AtlasStruct

Acquisisce i dettagli del contenuto dello struct. Non creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.

Nome Tipo Descrizione
attributes

Attributi dello struct.
lastModifiedTS

string

ETag per il controllo di concorrenza.
typeName

string

Nome del tipo.

AtlasTermCategorizationHeader

Informazioni di base per la categorizzazione dei termini.

Nome Tipo Descrizione
categoryGuid

string

GUID della categoria.
description

string

Descrizione del record.
displayText

string

Testo visualizzato.
relationGuid

string

GUID della relazione.
status

AtlasTermRelationshipStatus

Stato della relazione di termine.

AtlasTermRelationshipStatus

Stato per la relazione del termine atlas

Nome Tipo Descrizione
ACTIVE

string

active
DEPRECATED

string

deprecated
DRAFT

string

Bozza
OBSOLETE

string

obsolete
OTHER

string

altro

EntityStatus

Stato : può essere attivo o eliminato

Nome Tipo Descrizione
ACTIVE

string

Lo stato è attivo.
DELETED

string

Lo stato viene eliminato.

PurviewObjectId

PurviewObjectId

Nome Tipo Descrizione
displayText

string

Testo visualizzato
guid

string

GUID dell'oggetto .
itemPath

string

Percorso elemento
name

string

Nome
properties

Dizionario di
resourceId

string

ID risorsa
typeName

string

Nome del tipo.
uniqueAttributes

Attributi univoci dell'oggetto.

ResourceLink

Nome Tipo Descrizione
displayName

string

Nome visualizzato per URL.
url

string

URL Web. http o https

StatusAtlasRelationship

Stato per la relazione atlas

Nome Tipo Descrizione
ACTIVE

string

active
DELETED

string

deleted

TermStatus

Stato per il termine

Nome Tipo Descrizione
Alert

string

avviso
Approved

string

Approvato
Draft

string

Bozza
Expired

string

Scaduto

TimeBoundary

Acquisisce i dettagli del limite temporale

Nome Tipo Descrizione
endTime

string

Fine del limite di tempo.
startTime

string

Inizio del limite di tempo.
timeZone

string

Fuso orario del limite di tempo.