Glossary - Create Terms

Référence

Service:: Purview

Version d'API:: 2023-09-01

Créez des termes de glossaire en bloc.

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

Avec des paramètres facultatifs:

POST {endpoint}/datamap/api/atlas/v2/glossary/terms?api-version=2023-09-01&includeTermHierarchy={includeTermHierarchy}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string
api-version	query		string	Version de l’API à utiliser pour cette opération.
includeTermHierarchy	query		boolean	Si inclure la hiérarchie de termes

Corps de la demande

Nom	Type	Description
body	AtlasGlossaryTerm[]	Tableau de définitions de termes de glossaire à créer en bloc.

Réponses

Nom	Type	Description
200 OK	AtlasGlossaryTerm[]	La demande a réussi.
Other Status Codes	AtlasErrorResponse	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://purview.azure.net/.default

Exemples

Glossary_CreateTerms

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AtlasClassification	Un instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.
AtlasErrorResponse	Réponse d’erreur du service
AtlasGlossaryHeader	En-tête de glossaire avec des informations de base.
AtlasGlossaryTerm	Terme de glossaire.
AtlasRelatedObjectId	Référence à un objet instance de type AtlasEntity utilisé dans les valeurs d’attribut de relation
AtlasRelatedTermHeader	En-tête du terme associé.
AtlasStruct	Capture les détails du contenu du struct. Non instancié directement, utilisé uniquement via AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader	Informations de base pour la catégorisation des termes.
AtlasTermRelationshipStatus	État de la relation de terme atlas
EntityStatus	État : peut être actif ou supprimé
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	État de la relation atlas
TermStatus	État du terme
TimeBoundary	Capture les détails de la limite de temps

AtlasClassification

Un instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.

Nom	Type	Description
attributes		Attributs du struct.
entityGuid	string	GUID de l’entité.
entityStatus	EntityStatus	État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
removePropagationsOnEntityDelete	boolean	Détermine si les propagations seront supprimées lors de la suppression de l’entité.
typeName	string	Nom du type.
validityPeriods	TimeBoundary[]	Tableau de limites de temps indiquant des périodes de validité.

AtlasErrorResponse

Réponse d’erreur du service

Nom	Type	Description
errorCode	string	Code d'erreur.
errorMessage	string	Message d’erreur.
requestId	string	ID de demande.

AtlasGlossaryHeader

En-tête de glossaire avec des informations de base.

Nom	Type	Description
displayText	string	Texte d’affichage.
glossaryGuid	string	GUID du glossaire.
relationGuid	string	GUID de la relation.

AtlasGlossaryTerm

Terme de glossaire.

Nom	Type	Description
abbreviation	string	Abréviation du terme.
anchor	AtlasGlossaryHeader	En-tête de glossaire avec des informations de base.
antonyms	AtlasRelatedTermHeader[]	Tableau d’en-têtes de termes associés sous forme d’antonymes.
assignedEntities	AtlasRelatedObjectId[]	Tableau d’ID d’objet associés.
attributes	object	Attributs personnalisés du terme, qui est la chaîne de carte<, la chaîne de carte<, l’objet>>. La clé du premier mappage de couche est le nom du modèle de terme.
categories	AtlasTermCategorizationHeader[]	Tableau d’en-têtes de catégorisation de terme.
classifications	AtlasClassification[]	Tableau de classifications.
classifies	AtlasRelatedTermHeader[]	Tableau d’en-têtes de termes associés.
contacts	object	Dictionnaire de contacts pour les termes. La clé peut être Expert ou Steward.
createTime	integer	Heure de création de l’enregistrement.
createdBy	string	Utilisateur qui a créé l’enregistrement.
examples	string[]	Tableau d’exemples.
guid	string	GUID de l’objet .
hierarchyInfo	PurviewObjectId[]	Informations de hiérarchie du terme.
isA	AtlasRelatedTermHeader[]	Tableau d’en-têtes de termes associés indiquant la relation is-a.
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
longDescription	string	Description de la version longue.
name	string	Nom de l’objet glossaire.
nickName	string	Nom du surnom du terme.
preferredTerms	AtlasRelatedTermHeader[]	Tableau d’en-têtes de termes associés préférés.
preferredToTerms	AtlasRelatedTermHeader[]	Tableau d’en-têtes de terme associés qui sont préférés.
qualifiedName	string	Nom qualifié de l’objet glossaire.
replacedBy	AtlasRelatedTermHeader[]	Tableau d’en-têtes de terme associés qui sont remplacés par .
replacementTerms	AtlasRelatedTermHeader[]	Tableau d’en-têtes de terme associés à remplacer.
resources	ResourceLink[]	Tableau de lien de ressource pour terme
seeAlso	AtlasRelatedTermHeader[]	Tableau d’en-têtes de terme associés pour voir également.
shortDescription	string	Version courte de la description.
status	TermStatus	État de l’AtlasGlossaryTerm
synonyms	AtlasRelatedTermHeader[]	Tableau d’en-têtes de termes associés en tant que synonymes.
templateName	TemplateName[]	Nom du modèle.
translatedTerms	AtlasRelatedTermHeader[]	Tableau d’en-têtes de termes associés traduits.
translationTerms	AtlasRelatedTermHeader[]	Tableau d’en-têtes de terme associés pour la traduction.
updateTime	integer	Heure de mise à jour de l’enregistrement.
updatedBy	string	Utilisateur qui a mis à jour l’enregistrement.
usage	string	Utilisation du terme.
validValues	AtlasRelatedTermHeader[]	Tableau d’en-têtes de terme associés en tant que valeurs valides.
validValuesFor	AtlasRelatedTermHeader[]	Tableau d’en-têtes de terme associés en tant que valeurs valides pour d’autres enregistrements.

AtlasRelatedObjectId

Référence à un objet instance de type AtlasEntity utilisé dans les valeurs d’attribut de relation

Nom	Type	Description
displayText	string	Texte d’affichage.
entityStatus	EntityStatus	État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
guid	string	GUID de l’objet .
relationshipAttributes	AtlasStruct	Capture les détails du contenu du struct. Non instancié directement, utilisé uniquement via AtlasEntity, AtlasClassification.
relationshipGuid	string	GUID de la relation.
relationshipStatus	StatusAtlasRelationship	Énumération de la relation status.
relationshipType	string	Type de relation
typeName	string	Nom du type.
uniqueAttributes		Attributs uniques de l’objet.

AtlasRelatedTermHeader

En-tête du terme associé.

Nom	Type	Description
description	string	Description du terme associé.
displayText	string	Texte d’affichage.
expression	string	Expression du terme.
relationGuid	string	GUID de la relation.
status	AtlasTermRelationshipStatus	Status de la relation de terme.
steward	string	Intendant du terme.
termGuid	string	GUID du terme.

AtlasStruct

Capture les détails du contenu du struct. Non instancié directement, utilisé uniquement via AtlasEntity, AtlasClassification.

Nom	Type	Description
attributes		Attributs du struct.
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
typeName	string	Nom du type.

AtlasTermCategorizationHeader

Informations de base pour la catégorisation des termes.

Nom	Type	Description
categoryGuid	string	GUID de la catégorie.
description	string	Description de l’enregistrement.
displayText	string	Texte d’affichage.
relationGuid	string	GUID de la relation.
status	AtlasTermRelationshipStatus	Status de la relation de terme.

AtlasTermRelationshipStatus

État de la relation de terme atlas

Nom	Type	Description
ACTIVE	string	active
DEPRECATED	string	déprécié
DRAFT	string	Projet
OBSOLETE	string	obsolète
OTHER	string	Autres

EntityStatus

État : peut être actif ou supprimé

Nom	Type	Description
ACTIVE	string	Le status est actif.
DELETED	string	Le status est supprimé.

PurviewObjectId

Nom	Type	Description
displayText	string	Texte affiché
guid	string	GUID de l’objet .
itemPath	string	Chemin d’accès de l’élément
name	string	Nom
properties		Dictionnaire de
resourceId	string	ID de ressource
typeName	string	Nom du type.
uniqueAttributes		Attributs uniques de l’objet.

ResourceLink

Nom	Type	Description
displayName	string	Nom complet de l’URL.
url	string	url web. http ou https

StatusAtlasRelationship

État de la relation atlas

Nom	Type	Description
ACTIVE	string	active
DELETED	string	deleted

TermStatus

État du terme

Nom	Type	Description
Alert	string	alerte
Approved	string	Approuvé
Draft	string	Projet
Expired	string	Expiré

TimeBoundary

Capture les détails de la limite de temps

Nom	Type	Description
endTime	string	Fin de la limite de temps.
startTime	string	Début de la limite de temps.
timeZone	string	Fuseau horaire de la limite de temps.

Partager via