Glossary - List

Référence

Service:: Purview

Version d'API:: 2023-09-01

Obtenez tous les glossaires. Recommandez d’utiliser la limite/décalage pour obtenir le résultat de la pagination. Recommandez d’utiliser « ignoreTermsAndCategories=true » et d’extraire séparément les termes/catégories à l’aide de « GET /datamap/api/atlas/v2/glossaire/{glossaireId}/terms » et « GET « /datamap/api/atlas/v2/glossaire/{glossaireId}/categories ».

GET {endpoint}/datamap/api/atlas/v2/glossary

Avec des paramètres facultatifs:

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}&ignoreTermsAndCategories={ignoreTermsAndCategories}

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.
ignoreTermsAndCategories	query		boolean	Indique si les termes et les catégories sont ignorés
limit	query		integer int32	Taille de la page : par défaut, il n’y a pas de pagination.
offset	query		integer int32	Décalage à des fins de pagination.
sort	query		string	Ordre de tri, ASC (valeur par défaut) ou DESC.

Réponses

Nom	Type	Description
200 OK	AtlasGlossary[]	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_List

Exemple de requête

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit=1&offset=0&sort=ASC

Exemple de réponse

Code d’état:: 200

[
  {
    "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",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1672892675688,
    "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"
      }
    ]
  }
]

Définitions

Nom	Description
AtlasClassification	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
AtlasGlossary	Objet glossaire.
AtlasRelatedCategoryHeader	En-tête de la catégorie associée.
AtlasRelatedTermHeader	En-tête du terme associé.
AtlasTermRelationshipStatus	État de la relation de terme atlas
EntityStatus	État : peut être actif ou supprimé
TimeBoundary	Capture les détails des limites temporelles

AtlasClassification

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 d’entité.
typeName	string	Nom du type.
validityPeriods	TimeBoundary[]	Tableau de limites de temps indiquant les 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.

AtlasGlossary

Objet glossaire.

Nom	Type	Description
categories	AtlasRelatedCategoryHeader[]	Tableau de catégories.
classifications	AtlasClassification[]	Tableau de classifications.
createTime	integer	Heure créée de l’enregistrement.
createdBy	string	Utilisateur qui a créé l’enregistrement.
guid	string	GUID de l’objet.
language	string	Langue du glossaire.
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.
qualifiedName	string	Nom qualifié de l’objet glossaire.
shortDescription	string	Version abrégée de la description.
terms	AtlasRelatedTermHeader[]	Tableau d’en-têtes de terme associés.
updateTime	integer	Heure de mise à jour de l’enregistrement.
updatedBy	string	Utilisateur qui a mis à jour l’enregistrement.
usage	string	Utilisation du glossaire.

AtlasRelatedCategoryHeader

En-tête de la catégorie associée.

Nom	Type	Description
categoryGuid	string	GUID de la catégorie.
description	string	Description de l’en-tête de catégorie.
displayText	string	Texte d’affichage.
parentCategoryGuid	string	GUID de la catégorie parente.
relationGuid	string	GUID de la relation.

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	État de la relation de terme.
steward	string	L’administrateur du terme.
termGuid	string	GUID du terme.

AtlasTermRelationshipStatus

État de la relation de terme atlas

Nom	Type	Description
ACTIVE	string	actif
DEPRECATED	string	obsolescent
DRAFT	string	brouillon
OBSOLETE	string	obsolète
OTHER	string	autre

EntityStatus

État : peut être actif ou supprimé

Nom	Type	Description
ACTIVE	string	L’état est actif.
DELETED	string	L’état est supprimé.

TimeBoundary

Capture les détails des limites temporelles

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