Glossary - Create Term

Riferimento

Servizio:: Purview

Versione API:: 2023-09-01

Creare un termine di glossario.

POST {endpoint}/datamap/api/atlas/v2/glossary/term

Con parametri facoltativi:

POST {endpoint}/datamap/api/atlas/v2/glossary/term?includeTermHierarchy={includeTermHierarchy}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string
includeTermHierarchy	query		boolean	Indica se includere la gerarchia dei termini

Corpo della richiesta

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.

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_CreateTerm

Glossary_CreateTermWithTemplate

Glossary_CreateTerm

Esempio di richiesta

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/term

{
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "abbreviation": "T1",
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward info"
      }
    ]
  }
}

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 Description",
  "abbreviation": "T1",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  }
}

Glossary_CreateTermWithTemplate

Esempio di richiesta

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/term

{
  "name": "ExampleTerm",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
  },
  "attributes": {
    "ExampleTermTemplateAttribute": {
      "plain string": "Example String",
      "date": 1606233600000,
      "single choice": "Example Single Choice A",
      "multi choice": [
        "Example Multi Choice A",
        "Example Multi Choice B"
      ]
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "guid": "9390cc82-1077-403e-a4d2-b6a69834707b",
  "qualifiedName": "ExampleTerm@Glossary",
  "name": "ExampleTerm",
  "lastModifiedTS": "1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "attributes": {
    "ExampleTermTemplateAttribute": {
      "plain string": "Example String",
      "date": 1606233600000,
      "single choice": "Example Single Choice A",
      "multi choice": [
        "Example Multi Choice A",
        "Example Multi Choice B"
      ]
    }
  }
}

Definizioni

Nome	Descrizione
AtlasClassification	Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo quando associato a un'entità.
AtlasErrorResponse	Risposta di errore dal servizio
AtlasGlossaryHeader	Intestazione di glossario con informazioni di base.
AtlasGlossaryTerm	Termine glossario.
AtlasRelatedObjectId	Riferimento a un'istanza di oggetto del tipo AtlasEntity usato nei valori dell'attributo di relazione
AtlasRelatedTermHeader	Intestazione del termine correlato.
AtlasStruct	Acquisisce i dettagli del contenuto dello struct. Non è stata creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader	Informazioni di base per la categorizzazione del termine.
AtlasTermRelationshipStatus	Stato della relazione tra termini 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 dei limiti di tempo

AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo quando 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 di concorrenza.
removePropagationsOnEntityDelete	boolean	Determina se le propagazioni verranno rimosse per l'eliminazione dell'entità.
typeName	string	Nome del tipo.
validityPeriods	TimeBoundary[]	Matrice di limiti temporali che indicano 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 di glossario con informazioni di base.

Nome	Tipo	Descrizione
displayText	string	Testo visualizzato.
glossaryGuid	string	GUID del glossario.
relationGuid	string	GUID della relazione.

AtlasGlossaryTerm

Termine glossario.

Nome	Tipo	Descrizione
abbreviation	string	Abbreviazione del termine.
anchor	AtlasGlossaryHeader	Intestazione di 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 mappa<, stringa mappa<, oggetto>>. La chiave della prima mappa di livello è il nome del modello di termine.
categories	AtlasTermCategorizationHeader[]	Matrice di intestazioni di categorizzazione 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 creata 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 la relazione is-a.
lastModifiedTS	string	ETag per il controllo di 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 che sono preferite.
qualifiedName	string	Nome qualificato 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 dell'Atlas GlossariaryTerm
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 di oggetto del tipo AtlasEntity usato nei valori dell'attributo 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 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 di termine.
steward	string	Il responsabile del termine.
termGuid	string	GUID del termine.

AtlasStruct

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

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
lastModifiedTS	string	ETag per il controllo della concorrenza.
typeName	string	Nome del tipo.

AtlasTermCategorizationHeader

Informazioni di base per la categorizzazione del termine.

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 della relazione tra termini 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

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 dei limiti di tempo

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.

Condividi tramite

Glossary - Create Term

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

OAuth2Auth

Ambiti

Esempio

Glossary_CreateTerm

Esempio di richiesta

Risposta di esempio

Glossary_CreateTermWithTemplate

Esempio di richiesta

Risposta di esempio

Definizioni

AtlasClassification

AtlasErrorResponse

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary

Risorse aggiuntive