Glossary - List Glossaries

Dapatkan semua glosarium yang terdaftar di Atlas.

GET {Endpoint}/catalog/api/atlas/v2/glossary
GET {Endpoint}/catalog/api/atlas/v2/glossary?limit={limit}&offset={offset}&sort={sort}&ignoreTermsAndCategories={ignoreTermsAndCategories}

Parameter URI

Name In Required Type Description
Endpoint
path True
  • string

Titik akhir katalog akun Purview Anda. Contoh: https://{accountName}.purview.azure.com

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

Name Type Description
200 OK

Array glosarium yang ada sesuai dengan kriteria pencarian atau daftar kosong jika tidak ada yang cocok.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

Glossary_ListGlossaries

Sample Request

GET {Endpoint}/catalog/api/atlas/v2/glossary?limit=1&offset=0&sort=ASC

Sample Response

[
  {
    "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",
    "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

AtlasClassification

AtlasClassification

AtlasGlossary

AtlasGlossary

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

AtlasRelatedTermHeader

AtlasRelatedTermHeader

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Attributes

Atribut struct.

ErrorResponse

Respons kesalahan dari layanan

SourceDetails

detail selengkapnya tentang informasi sumber

Status

Status

TimeBoundary

Batas Waktu

AtlasClassification

AtlasClassification

Name Type Description
attributes

Atribut struct.

entityGuid
  • string

GUID entitas.

entityStatus

Status
Status entitas - dapat aktif atau dihapus. Entitas yang dihapus tidak dihapus dari penyimpanan Atlas.

lastModifiedTS
  • string

lastModifiedTS
ETag untuk kontrol konkurensi.

removePropagationsOnEntityDelete
  • boolean

Menentukan apakah propagasi akan dihapus pada penghapusan entitas.

source
  • string

menunjukkan sumber yang membuat detail klasifikasi

sourceDetails

detail selengkapnya tentang informasi sumber

typeName
  • string

Nama jenis.

validityPeriods

Array batas waktu yang menunjukkan periode validitas.

AtlasGlossary

AtlasGlossary

Name Type Description
categories

Array kategori.

classifications

Array klasifikasi.

guid
  • string

GUID objek.

language
  • string

Bahasa glosarium.

lastModifiedTS
  • string

lastModifiedTS
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

Array header istilah terkait.

usage
  • string

Penggunaan glosarium.

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

Name Type Description
categoryGuid
  • string

GUID kategori.

description
  • string

Deskripsi header kategori.

displayText
  • string

Teks tampilan.

parentCategoryGuid
  • string

GUID kategori induk.

relationGuid
  • string

GUID hubungan.

AtlasRelatedTermHeader

AtlasRelatedTermHeader

Name Type Description
description
  • string

Deskripsi istilah terkait.

displayText
  • string

Teks tampilan.

expression
  • string

Ekspresi istilah.

relationGuid
  • string

GUID hubungan.

source
  • string

Sumber istilah.

status

AtlasTermRelationshipStatus
Status hubungan istilah.

steward
  • string

Pengurus istilah.

termGuid
  • string

GUID istilah.

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Name Type Description
ACTIVE
  • string
DEPRECATED
  • string
DRAFT
  • string
OBSOLETE
  • string
OTHER
  • string

Attributes

Atribut struct.

Name Type Description

ErrorResponse

Respons kesalahan dari layanan

Name Type Description
errorCode
  • string

Kode kesalahan.

errorMessage
  • string

Pesan kesalahan.

requestId
  • string

ID permintaan.

SourceDetails

detail selengkapnya tentang informasi sumber

Name Type Description

Status

Status

Name Type Description
ACTIVE
  • string
DELETED
  • string

TimeBoundary

Batas Waktu

Name Type Description
endTime
  • string

Batas akhir waktu.

startTime
  • string

Awal batas waktu.

timeZone
  • string

Zona waktu batas waktu.