다음을 통해 공유

Glossary - Get Detailed

  • 참조
서비스:
Purview
API 버전:
2023-09-01

자세한 정보가 포함된 특정 용어집을 가져옵니다. 이 API는 권장되지 않습니다.

를 사용하여 용어/범주 세부 정보를 별도로 가져오는 것이 좋습니다.

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and

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

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed
선택적 매개 변수: 
GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed?api-version=2023-09-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
 path True

string

glossaryId
 path True

string

용어집에 대한 전역적으로 고유한 식별자입니다.
api-version
 query

string

이 작업에 사용할 API 버전입니다.

응답

Name 형식 Description
200 OK

AtlasGlossaryExtInfo

요청이 성공했습니다.
Other Status Codes

AtlasErrorResponse

예기치 않은 오류 응답입니다.

보안

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

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

예제

Glossary_GetDetailed

샘플 요청

GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/detailed?api-version=2023-09-01

샘플 응답

상태 코드:
200 
{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "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",
      "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
    },
    {
      "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
    },
    {
      "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
    }
  ],
  "termInfo": {
    "54688d39-b298-4104-9e80-f2a16f44aaea": {
      "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
      "qualifiedName": "ExampleTerm1@Glossary",
      "name": "ExampleTerm1",
      "shortDescription": "Example Short Description",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "2",
      "abbreviation": "T1",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287247276,
      "updateTime": 1606290587593,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
      },
      "assignedEntities": [
        {
          "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
          "typeName": "hdfs_path",
          "entityStatus": "ACTIVE",
          "displayText": "1",
          "relationshipType": "AtlasGlossarySemanticAssignment",
          "relationshipGuid": "cf2e959c-05e6-4a9f-b106-b6475741c2ba",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "AtlasGlossarySemanticAssignment",
            "attributes": {
              "expression": "Example Expression",
              "createdBy": "ExampleCreator",
              "steward": "ExampleSteward",
              "confidence": 100,
              "description": "Example Description",
              "source": "Azure",
              "status": null
            }
          }
        }
      ],
      "categories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007"
        }
      ],
      "seeAlso": [
        {
          "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm2"
        }
      ],
      "synonyms": [
        {
          "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm2"
        }
      ],
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Steward": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Steward Info"
          }
        ]
      },
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    },
    "952c7ba4-4c89-42d8-a05a-7d2161be7008": {
      "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"
      },
      "seeAlso": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm1"
        }
      ],
      "synonyms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm1"
        }
      ],
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    }
  },
  "categoryInfo": {
    "ed7458f0-9463-48a5-b5c6-4f785fb34e12": {
      "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory1",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "3",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
      },
      "parentCategory": {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
      },
      "childrenCategories": [
        {
          "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
          "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
        }
      ],
      "terms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
          "displayText": "ExampleTerm1"
        }
      ]
    },
    "e47c4584-daca-4f9e-9092-194e04692c9a": {
      "guid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "qualifiedName": "ExampleCategory2@Glossary",
      "name": "ExampleCategory2",
      "lastModifiedTS": "1",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
      },
      "childrenCategories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
        }
      ]
    },
    "0d6766f6-f4b6-435b-bda2-d3edc358998e": {
      "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
      "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory3",
      "lastModifiedTS": "2",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
      },
      "parentCategory": {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
      }
    }
  }
}

정의

Name Description
AtlasClassification

분류의 instance, ID가 없으며 이 개체는 엔터티와 연결된 경우에만 존재합니다.
AtlasErrorResponse

서비스의 오류 응답
AtlasGlossaryCategory

용어집 범주입니다.
AtlasGlossaryExtInfo

용어집의 확장된 정보입니다.
AtlasGlossaryHeader

기본 정보가 포함된 용어집 헤더입니다.
AtlasGlossaryTerm

용어집 용어입니다.
AtlasRelatedCategoryHeader

관련 범주의 헤더입니다.
AtlasRelatedObjectId

관계 특성 값에 사용되는 AtlasEntity 형식의 개체 instance 대한 참조
AtlasRelatedTermHeader

관련 용어의 헤더입니다.
AtlasStruct

구조체 콘텐츠의 세부 정보를 캡처합니다. 직접 인스턴스화되지 않고 AtlasEntity, AtlasClassification을 통해서만 사용됩니다.
AtlasTermCategorizationHeader

용어 분류에 대한 기본 정보입니다.
AtlasTermRelationshipStatus

atlas 용어 관계의 상태
EntityStatus

상태 - 활성 또는 삭제 가능
PurviewObjectId

PurviewObjectId
ResourceLink

ResourceLink
StatusAtlasRelationship

atlas 관계의 상태
TermStatus

용어의 상태
TimeBoundary

시간 경계 세부 정보를 캡처합니다.

AtlasClassification

분류의 instance, ID가 없으며 이 개체는 엔터티와 연결된 경우에만 존재합니다.

Name 형식 Description
attributes

구조체의 특성입니다.
entityGuid

string

엔터티의 GUID입니다.
entityStatus

EntityStatus

엔터티의 상태 - 활성 또는 삭제할 수 있습니다. 삭제된 엔터티는 제거되지 않습니다.
lastModifiedTS

string

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

boolean

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

string

형식의 이름입니다.
validityPeriods

TimeBoundary[]

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

AtlasErrorResponse

서비스의 오류 응답

Name 형식 Description
errorCode

string

오류 코드입니다.
errorMessage

string

오류 메시지입니다.
requestId

string

요청 ID입니다.

AtlasGlossaryCategory

용어집 범주입니다.

Name 형식 Description
anchor

AtlasGlossaryHeader

기본 정보가 포함된 용어집 헤더입니다.
childrenCategories

AtlasRelatedCategoryHeader[]

자식 범주의 배열입니다.
classifications

AtlasClassification[]

분류의 배열입니다.
createTime

integer

레코드의 만든 시간입니다.
createdBy

string

레코드를 만든 사용자입니다.
guid

string

개체의 GUID입니다.
lastModifiedTS

string

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

string

긴 버전 설명입니다.
name

string

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

AtlasRelatedCategoryHeader

관련 범주의 헤더입니다.
qualifiedName

string

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

string

간단한 설명 버전입니다.
terms

AtlasRelatedTermHeader[]

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

integer

레코드의 업데이트 시간입니다.
updatedBy

string

레코드를 업데이트한 사용자입니다.

AtlasGlossaryExtInfo

용어집의 확장된 정보입니다.

Name 형식 Description
categories

AtlasRelatedCategoryHeader[]

범주의 배열입니다.
categoryInfo

<string,  AtlasGlossaryCategory>

용어집 범주 정보입니다.
classifications

AtlasClassification[]

분류의 배열입니다.
createTime

integer

레코드의 만든 시간입니다.
createdBy

string

레코드를 만든 사용자입니다.
guid

string

개체의 GUID입니다.
language

string

용어집의 언어입니다.
lastModifiedTS

string

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

string

긴 버전 설명입니다.
name

string

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

string

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

string

간단한 설명 버전입니다.
termInfo

<string,  AtlasGlossaryTerm>

용어집 용어 정보입니다.
terms

AtlasRelatedTermHeader[]

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

integer

레코드의 업데이트 시간입니다.
updatedBy

string

레코드를 업데이트한 사용자입니다.
usage

string

용어집의 사용법입니다.

AtlasGlossaryHeader

기본 정보가 포함된 용어집 헤더입니다.

Name 형식 Description
displayText

string

표시 텍스트입니다.
glossaryGuid

string

용어집의 GUID입니다.
relationGuid

string

관계의 GUID입니다.

AtlasGlossaryTerm

용어집 용어입니다.

Name 형식 Description
abbreviation

string

용어의 약어입니다.
anchor

AtlasGlossaryHeader

기본 정보가 포함된 용어집 헤더입니다.
antonyms

AtlasRelatedTermHeader[]

antonyms로 관련된 용어 헤더의 배열입니다.
assignedEntities

AtlasRelatedObjectId[]

관련 개체 ID의 배열입니다.
attributes

object

맵 문자열, 지도<<문자열, 개체>>인 용어의 사용자 지정 특성입니다. 첫 번째 계층 맵의 키는 용어 템플릿 이름입니다.
categories

AtlasTermCategorizationHeader[]

용어 분류 헤더의 배열입니다.
classifications

AtlasClassification[]

분류의 배열입니다.
classifies

AtlasRelatedTermHeader[]

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

object

용어에 대한 연락처 사전입니다. 키는 전문가 또는 스튜어드일 수 있습니다.
createTime

integer

레코드의 만든 시간입니다.
createdBy

string

레코드를 만든 사용자입니다.
examples

string[]

예제의 배열입니다.
guid

string

개체의 GUID입니다.
hierarchyInfo

PurviewObjectId[]

용어의 계층 정보입니다.
isA

AtlasRelatedTermHeader[]

is-a 관계를 나타내는 관련 용어 헤더의 배열입니다.
lastModifiedTS

string

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

string

긴 버전 설명입니다.
name

string

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

string

용어의 닉 이름입니다.
preferredTerms

AtlasRelatedTermHeader[]

기본 설정 관련 용어 헤더의 배열입니다.
preferredToTerms

AtlasRelatedTermHeader[]

선호되는 관련 용어 헤더의 배열입니다.
qualifiedName

string

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

AtlasRelatedTermHeader[]

로 대체되는 관련 용어 헤더의 배열입니다.
replacementTerms

AtlasRelatedTermHeader[]

대체를 위한 관련 용어 헤더의 배열입니다.
resources

ResourceLink[]

용어에 대한 리소스 링크 배열
seeAlso

AtlasRelatedTermHeader[]

에 대한 관련 용어 헤더의 배열도 참조하세요.
shortDescription

string

간단한 설명 버전입니다.
status

TermStatus

AtlasGlossaryTerm의 상태
synonyms

AtlasRelatedTermHeader[]

동의어로 관련된 용어 헤더의 배열입니다.
templateName

TemplateName[]

템플릿의 이름입니다.
translatedTerms

AtlasRelatedTermHeader[]

번역된 관련 용어 헤더의 배열입니다.
translationTerms

AtlasRelatedTermHeader[]

번역을 위한 관련 용어 헤더의 배열입니다.
updateTime

integer

레코드의 업데이트 시간입니다.
updatedBy

string

레코드를 업데이트한 사용자입니다.
usage

string

용어의 사용법입니다.
validValues

AtlasRelatedTermHeader[]

유효한 값으로 관련된 용어 헤더의 배열입니다.
validValuesFor

AtlasRelatedTermHeader[]

다른 레코드에 유효한 값으로 관련된 용어 헤더의 배열입니다.

AtlasRelatedCategoryHeader

관련 범주의 헤더입니다.

Name 형식 Description
categoryGuid

string

범주의 GUID입니다.
description

string

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

string

표시 텍스트입니다.
parentCategoryGuid

string

부모 범주의 GUID입니다.
relationGuid

string

관계의 GUID입니다.

AtlasRelatedObjectId

관계 특성 값에 사용되는 AtlasEntity 형식의 개체 instance 대한 참조

Name 형식 Description
displayText

string

표시 텍스트입니다.
entityStatus

EntityStatus

엔터티의 상태 - 활성 또는 삭제할 수 있습니다. 삭제된 엔터티는 제거되지 않습니다.
guid

string

개체의 GUID입니다.
relationshipAttributes

AtlasStruct

구조체 콘텐츠의 세부 정보를 캡처합니다. 직접 인스턴스화되지 않고 AtlasEntity, AtlasClassification을 통해서만 사용됩니다.
relationshipGuid

string

관계의 GUID입니다.
relationshipStatus

StatusAtlasRelationship

관계 상태 열거형입니다.
relationshipType

string

관계 유형
typeName

string

형식의 이름입니다.
uniqueAttributes

개체의 고유 특성입니다.

AtlasRelatedTermHeader

관련 용어의 헤더입니다.

Name 형식 Description
description

string

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

string

표시 텍스트입니다.
expression

string

용어의 식입니다.
relationGuid

string

관계의 GUID입니다.
status

AtlasTermRelationshipStatus

용어 관계의 상태.
steward

string

용어의 청지기입니다.
termGuid

string

용어의 GUID입니다.

AtlasStruct

구조체 콘텐츠의 세부 정보를 캡처합니다. 직접 인스턴스화되지 않고 AtlasEntity, AtlasClassification을 통해서만 사용됩니다.

Name 형식 Description
attributes

구조체의 특성입니다.
lastModifiedTS

string

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

string

형식의 이름입니다.

AtlasTermCategorizationHeader

용어 분류에 대한 기본 정보입니다.

Name 형식 Description
categoryGuid

string

범주의 GUID입니다.
description

string

레코드에 대한 설명입니다.
displayText

string

표시 텍스트입니다.
relationGuid

string

관계의 GUID입니다.
status

AtlasTermRelationshipStatus

용어 관계의 상태.

AtlasTermRelationshipStatus

atlas 용어 관계의 상태

Name 형식 Description
ACTIVE

string

활성
DEPRECATED

string

사용되지 않음
DRAFT

string

초안
OBSOLETE

string

사용되지 않음
OTHER

string

other

EntityStatus

상태 - 활성 또는 삭제 가능

Name 형식 Description
ACTIVE

string

상태 활성 상태입니다.
DELETED

string

상태 삭제됩니다.

PurviewObjectId

PurviewObjectId

Name 형식 Description
displayText

string

표시 텍스트
guid

string

개체의 GUID입니다.
itemPath

string

항목 경로
name

string

Name
properties

사전
resourceId

string

리소스 ID
typeName

string

형식의 이름입니다.
uniqueAttributes

개체의 고유 특성입니다.

ResourceLink

Name 형식 Description
displayName

string

URL의 표시 이름입니다.
url

string

웹 URL입니다. HTTP 또는 HTTPS

StatusAtlasRelationship

atlas 관계의 상태

Name 형식 Description
ACTIVE

string

활성
DELETED

string

deleted

TermStatus

용어의 상태

Name 형식 Description
Alert

string

경고
Approved

string

승인
Draft

string

초안
Expired

string

만료

TimeBoundary

시간 경계 세부 정보를 캡처합니다.

Name 형식 Description
endTime

string

시간 경계의 끝입니다.
startTime

string

시간 경계의 시작입니다.
timeZone

string

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