Glossary - Partial Update

참조

서비스:: Purview

API 버전:: 2023-09-01

용어집을 부분적으로 업데이트합니다. qualifiedName과 같은 일부 속성은 업데이트할 수 없습니다.

지금까지는 용어집에 대한 부분 업데이트 shortDescription, longDescription, 언어 및 사용량만 지원합니다.

응답 본문 크기를 줄이려면 'ignoreTermsAndCategories=true'를 사용하는 것이 좋습니다.

PUT {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/partial

선택적 매개 변수:

PUT {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/partial?api-version=2023-09-01&ignoreTermsAndCategories={ignoreTermsAndCategories}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string
glossaryId	path	True	string	용어집의 전역적으로 고유한 식별자입니다.
api-version	query		string	이 작업에 사용할 API 버전입니다.
ignoreTermsAndCategories	query		boolean	용어 및 범주 무시 여부

응답

Name	형식	Description
200 OK	AtlasGlossary	요청이 성공했습니다.
Other Status Codes	AtlasErrorResponse	예기치 않은 오류 응답입니다.

보안

OAuth2Auth

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

범위

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

예제

Glossary_PartialUpdate

샘플 요청

HTTP

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

{
  "longDescription": "Example Long Description"
}

샘플 응답

상태 코드:: 200

{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "lastModifiedTS": "3",
  "language": "en",
  "usage": "Example Glossary",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1672892675600,
  "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"
    }
  ]
}

정의

Name	Description
AtlasClassification	분류의 instance, ID가 없으며, 이 개체는 엔터티와 연결된 경우에만 존재합니다.
AtlasErrorResponse	서비스의 오류 응답
AtlasGlossary	용어집 개체입니다.
AtlasRelatedCategoryHeader	관련 범주의 헤더입니다.
AtlasRelatedTermHeader	관련 용어의 헤더입니다.
AtlasTermRelationshipStatus	아틀라스 용어 관계의 상태
EntityStatus	상태 - 활성 또는 삭제 가능
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입니다.

AtlasGlossary

용어집 개체입니다.

Name	형식	Description
categories	AtlasRelatedCategoryHeader[]	범주의 배열입니다.
classifications	AtlasClassification[]	분류 배열입니다.
createTime	integer	레코드의 만든 시간입니다.
createdBy	string	레코드를 만든 사용자입니다.
guid	string	개체의 GUID입니다.
language	string	용어집의 언어입니다.
lastModifiedTS	string	동시성 제어를 위한 ETag입니다.
longDescription	string	긴 버전 설명입니다.
name	string	용어집 개체의 이름입니다.
qualifiedName	string	용어집 개체의 정규화된 이름입니다.
shortDescription	string	간단한 설명 버전입니다.
terms	AtlasRelatedTermHeader[]	관련 용어 헤더의 배열입니다.
updateTime	integer	레코드의 업데이트 시간입니다.
updatedBy	string	레코드를 업데이트한 사용자입니다.
usage	string	용어집의 사용법입니다.

AtlasRelatedCategoryHeader

Name	형식	Description
categoryGuid	string	범주의 GUID입니다.
description	string	범주 헤더에 대한 설명입니다.
displayText	string	표시 텍스트입니다.
parentCategoryGuid	string	부모 범주의 GUID입니다.
relationGuid	string	관계의 GUID입니다.

AtlasRelatedTermHeader

Name	형식	Description
description	string	관련 용어에 대한 설명입니다.
displayText	string	표시 텍스트입니다.
expression	string	용어의 식입니다.
relationGuid	string	관계의 GUID입니다.
status	AtlasTermRelationshipStatus	용어 관계의 상태.
steward	string	용어의 청지기입니다.
termGuid	string	용어의 GUID입니다.

AtlasTermRelationshipStatus

아틀라스 용어 관계의 상태

Name	형식	Description
ACTIVE	string	활성
DEPRECATED	string	사용되지 않음
DRAFT	string	초안
OBSOLETE	string	사용되지 않음
OTHER	string	other

EntityStatus

상태 - 활성 또는 삭제 가능

Name	형식	Description
ACTIVE	string	상태 활성 상태입니다.
DELETED	string	상태 삭제됩니다.

TimeBoundary

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

Name	형식	Description
endTime	string	시간 경계의 끝입니다.
startTime	string	시간 경계의 시작입니다.
timeZone	string	시간 경계의 표준 시간대입니다.

다음을 통해 공유