Glossary - List Glossaries

Atlas에 등록된 모든 용어집을 가져옵니다.

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

URI 매개 변수

Name In Required Type Description
Endpoint
path True
  • string

Purview 계정의 카탈로그 엔드포인트입니다. 예: https://{accountName}.purview.azure.com

ignoreTermsAndCategories
query
  • boolean

용어 및 범주 무시 여부

limit
query
  • integer
int32

페이지 크기 - 기본적으로 페이징이 없습니다.

offset
query
  • integer
int32

페이지 매김 목적의 오프셋입니다.

sort
query
  • string

정렬 순서, ASC(기본값) 또는 DESC입니다.

응답

Name Type Description
200 OK

검색 조건에 맞는 기존 용어집 배열이거나 일치하는 항목이 없는 경우 빈 목록입니다.

Other Status Codes

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

OAuth2 Flow Azure Active Directory.

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

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

정의

AtlasClassification

AtlasClassification

AtlasGlossary

아틀라스글로사리

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

AtlasRelatedTermHeader

AtlasRelatedTermHeader

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Attributes

구조체의 특성입니다.

ErrorResponse

서비스의 오류 응답

SourceDetails

원본 정보에 대한 자세한 정보

Status

상태

TimeBoundary

TimeBoundary

AtlasClassification

AtlasClassification

Name Type Description
attributes

구조체의 특성입니다.

entityGuid
  • string

엔터티의 GUID입니다.

entityStatus

상태
엔터티의 상태 - 활성 또는 삭제할 수 있습니다. 삭제된 엔터티는 Atlas 저장소에서 제거되지 않습니다.

lastModifiedTS
  • string

lastModifiedTS
동시성 제어를 위한 ETag입니다.

removePropagationsOnEntityDelete
  • boolean

엔터티 삭제 시 전파가 제거될지 여부를 결정합니다.

source
  • string

분류 세부 정보를 만드는 원본을 나타냅니다.

sourceDetails

원본 정보에 대한 자세한 정보

typeName
  • string

형식의 이름입니다.

validityPeriods

유효 기간을 나타내는 시간 경계의 배열입니다.

AtlasGlossary

아틀라스글로사리

Name Type Description
categories

범주의 배열입니다.

classifications

분류의 배열입니다.

guid
  • string

개체의 GUID입니다.

language
  • string

용어집의 언어입니다.

lastModifiedTS
  • string

lastModifiedTS
동시성 제어를 위한 ETag입니다.

longDescription
  • string

긴 버전 설명입니다.

name
  • string

용어집 개체의 이름입니다.

qualifiedName
  • string

용어집 개체의 정규화된 이름입니다.

shortDescription
  • string

간단한 설명 버전입니다.

terms

관련 용어 헤더의 배열입니다.

usage
  • string

용어집의 사용법입니다.

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

Name Type Description
categoryGuid
  • string

범주의 GUID입니다.

description
  • string

범주 헤더에 대한 설명입니다.

displayText
  • string

표시 텍스트입니다.

parentCategoryGuid
  • string

부모 범주의 GUID입니다.

relationGuid
  • string

관계의 GUID입니다.

AtlasRelatedTermHeader

AtlasRelatedTermHeader

Name Type Description
description
  • string

관련 용어에 대한 설명입니다.

displayText
  • string

표시 텍스트입니다.

expression
  • string

용어의 식입니다.

relationGuid
  • string

관계의 GUID입니다.

source
  • string

용어의 소스입니다.

status

AtlasTermRelationshipStatus
용어 관계의 상태입니다.

steward
  • string

용어의 청지기입니다.

termGuid
  • string

용어의 GUID입니다.

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

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

Attributes

구조체의 특성입니다.

Name Type Description

ErrorResponse

서비스의 오류 응답

Name Type Description
errorCode
  • string

오류 코드입니다.

errorMessage
  • string

오류 메시지입니다.

requestId
  • string

요청 ID입니다.

SourceDetails

원본 정보에 대한 자세한 정보

Name Type Description

Status

상태

Name Type Description
ACTIVE
  • string
DELETED
  • string

TimeBoundary

TimeBoundary

Name Type Description
endTime
  • string

시간 경계의 끝입니다.

startTime
  • string

시간 경계의 시작입니다.

timeZone
  • string

시간 경계의 표준 시간대입니다.