Glossary - List

Referensi

Service:: Purview

API Version:: 2023-09-01

Dapatkan semua glosarium. Merekomendasikan penggunaan batas/offset untuk mendapatkan hasil penomoran halaman. Sarankan menggunakan 'ignoreTermsAndCategories=true' dan ambil istilah/kategori secara terpisah menggunakan

'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' dan

'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string
api-version	query		string	Versi API yang digunakan untuk operasi ini.
ignoreTermsAndCategories	query		boolean	Apakah mengabaikan istilah dan kategori
limit	query		integer int32	Ukuran halaman - secara default tidak ada halaman.
offset	query		integer int32	Offset untuk tujuan penomoran halaman.
sort	query		string	Urutan sortir, ASC (default) atau DESC.

Respons

Nama	Jenis	Deskripsi
200 OK	AtlasGlossary[]	Permintaan telah berhasil.
Other Status Codes	AtlasErrorResponse	Respons kesalahan yang tidak terduga.

Keamanan

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
https://purview.azure.net/.default

Contoh

Glossary_List

Sample Request

HTTP

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

Sample Response

Status code:: 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"
      }
    ]
  }
]

Definisi

Nama	Deskripsi
AtlasClassification	Instans klasifikasi; tidak memiliki identitas, objek ini hanya ada ketika dikaitkan dengan entitas.
AtlasErrorResponse	Respons kesalahan dari layanan
AtlasGlossary	Objek glosarium.
AtlasRelatedCategoryHeader	Header kategori terkait.
AtlasRelatedTermHeader	Header istilah terkait.
AtlasTermRelationshipStatus	Status untuk hubungan istilah atlas
EntityStatus	Status - dapat aktif atau dihapus
TimeBoundary	Mengambil detail batas waktu

AtlasClassification

Instans klasifikasi; tidak memiliki identitas, objek ini hanya ada ketika dikaitkan dengan entitas.

Nama	Jenis	Deskripsi
attributes		Atribut struct.
entityGuid	string	GUID entitas.
entityStatus	EntityStatus	Status entitas - dapat aktif atau dihapus. Entitas yang dihapus tidak dihapus.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
removePropagationsOnEntityDelete	boolean	Menentukan apakah propagasi akan dihapus pada penghapusan entitas.
typeName	string	Nama jenis.
validityPeriods	TimeBoundary[]	Array batas waktu yang menunjukkan periode validitas.

AtlasErrorResponse

Respons kesalahan dari layanan

Nama	Jenis	Deskripsi
errorCode	string	Kode kesalahan.
errorMessage	string	Pesan kesalahan.
requestId	string	ID permintaan.

AtlasGlossary

Objek glosarium.

Nama	Jenis	Deskripsi
categories	AtlasRelatedCategoryHeader[]	Array kategori.
classifications	AtlasClassification[]	Array klasifikasi.
createTime	integer	Waktu rekaman yang dibuat.
createdBy	string	Pengguna yang membuat rekaman.
guid	string	GUID objek.
language	string	Bahasa glosarium.
lastModifiedTS	string	ETag untuk kontrol konkurensi.
longDescription	string	Deskripsi versi panjang.
name	string	Nama objek glosarium.
qualifiedName	string	Nama yang memenuhi syarat dari objek glosarium.
shortDescription	string	Versi singkat deskripsi.
terms	AtlasRelatedTermHeader[]	Array header istilah terkait.
updateTime	integer	Waktu pembaruan rekaman.
updatedBy	string	Pengguna yang memperbarui rekaman.
usage	string	Penggunaan glosarium.

AtlasRelatedCategoryHeader

Header kategori terkait.

Nama	Jenis	Deskripsi
categoryGuid	string	GUID kategori.
description	string	Deskripsi header kategori.
displayText	string	Teks tampilan.
parentCategoryGuid	string	GUID kategori induk.
relationGuid	string	GUID hubungan.

AtlasRelatedTermHeader

Header istilah terkait.

Nama	Jenis	Deskripsi
description	string	Deskripsi istilah terkait.
displayText	string	Teks tampilan.
expression	string	Ekspresi istilah.
relationGuid	string	GUID hubungan.
status	AtlasTermRelationshipStatus	Status hubungan istilah.
steward	string	Pengurus istilah.
termGuid	string	GUID istilah.

AtlasTermRelationshipStatus

Status untuk hubungan istilah atlas

Nama	Jenis	Deskripsi
ACTIVE	string	aktif
DEPRECATED	string	tidak digunakan lagi
DRAFT	string	Draft
OBSOLETE	string	Usang
OTHER	string	lainnya

EntityStatus

Status - dapat aktif atau dihapus

Nama	Jenis	Deskripsi
ACTIVE	string	Status aktif.
DELETED	string	Status dihapus.

TimeBoundary

Mengambil detail batas waktu

Nama	Jenis	Deskripsi
endTime	string	Batas akhir waktu.
startTime	string	Awal batas waktu.
timeZone	string	Zona waktu batas waktu.