Glossary - Create Term

參考

服務:: Purview

API 版本:: 2023-09-01

建立詞彙。

POST {endpoint}/datamap/api/atlas/v2/glossary/term

含選擇性參數:

POST {endpoint}/datamap/api/atlas/v2/glossary/term?includeTermHierarchy={includeTermHierarchy}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string
includeTermHierarchy	query		boolean	是否包含字詞階層

要求本文

名稱	類型	Description
abbreviation	string	詞彙的縮寫。
anchor	AtlasGlossaryHeader	具有基本資訊的詞彙標頭。
antonyms	AtlasRelatedTermHeader[]	相關字詞標頭的陣列，以做為自變數。
assignedEntities	AtlasRelatedObjectId[]	相關物件識別碼的陣列。
attributes	object	詞彙的自定義屬性，也就是 map<string、map<string、object>>。第一個圖層地圖的索引鍵是字詞範本名稱。
categories	AtlasTermCategorizationHeader[]	詞彙分類標頭的陣列。
classifications	AtlasClassification[]	分類的陣列。
classifies	AtlasRelatedTermHeader[]	相關字詞標頭的陣列。
contacts	object	詞彙聯繫人的字典。關鍵可能是專家或監管人。
createTime	integer	記錄的建立時間。
createdBy	string	建立記錄的使用者。
examples	string[]	範例的陣列。
guid	string	物件的 GUID。
hierarchyInfo	PurviewObjectId[]	詞彙的階層資訊。
isA	AtlasRelatedTermHeader[]	相關詞彙標頭的陣列，指出為關聯性。
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[]	相關字詞標頭的陣列，做為其他記錄的有效值。

回應

名稱	類型	Description
200 OK	AtlasGlossaryTerm	要求成功。
Other Status Codes	AtlasErrorResponse	非預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://purview.azure.net/.default

範例

Glossary_CreateTerm

Glossary_CreateTermWithTemplate

Glossary_CreateTerm

範例要求

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/term

{
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "abbreviation": "T1",
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward info"
      }
    ]
  }
}

範例回覆

狀態碼:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "abbreviation": "T1",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  }
}

Glossary_CreateTermWithTemplate

範例要求

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/term

{
  "name": "ExampleTerm",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
  },
  "attributes": {
    "ExampleTermTemplateAttribute": {
      "plain string": "Example String",
      "date": 1606233600000,
      "single choice": "Example Single Choice A",
      "multi choice": [
        "Example Multi Choice A",
        "Example Multi Choice B"
      ]
    }
  }
}

範例回覆

狀態碼:: 200

{
  "guid": "9390cc82-1077-403e-a4d2-b6a69834707b",
  "qualifiedName": "ExampleTerm@Glossary",
  "name": "ExampleTerm",
  "lastModifiedTS": "1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "attributes": {
    "ExampleTermTemplateAttribute": {
      "plain string": "Example String",
      "date": 1606233600000,
      "single choice": "Example Single Choice A",
      "multi choice": [
        "Example Multi Choice A",
        "Example Multi Choice B"
      ]
    }
  }
}

定義

名稱	Description
AtlasClassification	分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。
AtlasErrorResponse	來自服務的錯誤回應
AtlasGlossaryHeader	具有基本資訊的詞彙標頭。
AtlasGlossaryTerm	詞彙。
AtlasRelatedObjectId	在關聯性屬性值中使用的 AtlasEntity 型別物件實例參考
AtlasRelatedTermHeader	相關詞彙的標頭。
AtlasStruct	擷取結構內容的詳細數據。未直接具現化，僅透過 AtlasEntity、AtlasClassification 使用。
AtlasTermCategorizationHeader	詞彙分類的基本資訊。
AtlasTermRelationshipStatus	atlas 字詞關聯性的狀態
EntityStatus	狀態 - 可以是作用中或刪除
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	atlas 關聯性的狀態
TermStatus	字詞的狀態
TimeBoundary	擷取時間界限詳細數據

AtlasClassification

分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。

名稱	類型	Description
attributes		結構的屬性。
entityGuid	string	實體的 GUID。
entityStatus	EntityStatus	實體的狀態 - 可以是作用中或刪除。不會移除已刪除的實體。
lastModifiedTS	string	並行控制的 ETag。
removePropagationsOnEntityDelete	boolean	判斷是否會在實體刪除時移除傳播。
typeName	string	型別的名稱。
validityPeriods	TimeBoundary[]	指出有效期間的時間界限陣列。

AtlasErrorResponse

來自服務的錯誤回應

名稱	類型	Description
errorCode	string	錯誤碼。
errorMessage	string	錯誤訊息。
requestId	string	要求識別碼。

AtlasGlossaryHeader

具有基本資訊的詞彙標頭。

名稱	類型	Description
displayText	string	顯示文字。
glossaryGuid	string	字彙的 GUID。
relationGuid	string	關聯性的 GUID。

AtlasGlossaryTerm

詞彙。

名稱	類型	Description
abbreviation	string	詞彙的縮寫。
anchor	AtlasGlossaryHeader	具有基本資訊的詞彙標頭。
antonyms	AtlasRelatedTermHeader[]	相關字詞標頭的陣列，做為自變數。
assignedEntities	AtlasRelatedObjectId[]	相關物件識別碼的陣列。
attributes	object	詞彙的自定義屬性，也就是 map<string、map<string、object>>。第一個圖層地圖的索引鍵是字詞範本名稱。
categories	AtlasTermCategorizationHeader[]	詞彙分類標頭的陣列。
classifications	AtlasClassification[]	分類陣列。
classifies	AtlasRelatedTermHeader[]	相關字詞標頭的陣列。
contacts	object	詞彙聯繫人的字典。關鍵可以是專家或監管人。
createTime	integer	記錄的建立時間。
createdBy	string	建立記錄的使用者。
examples	string[]	範例陣列。
guid	string	物件的 GUID。
hierarchyInfo	PurviewObjectId[]	詞彙的階層資訊。
isA	AtlasRelatedTermHeader[]	相關字詞標頭的陣列，表示為關聯性。
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[]	相關字詞標頭的陣列，做為其他記錄的有效值。

AtlasRelatedObjectId

在關聯性屬性值中使用的 AtlasEntity 型別物件實例參考

名稱	類型	Description
displayText	string	顯示文字。
entityStatus	EntityStatus	實體的狀態 - 可以是作用中或刪除。不會移除已刪除的實體。
guid	string	物件的 GUID。
relationshipAttributes	AtlasStruct	擷取結構內容的詳細數據。未直接具現化，僅透過 AtlasEntity、AtlasClassification 使用。
relationshipGuid	string	關聯性的 GUID。
relationshipStatus	StatusAtlasRelationship	關聯性狀態的列舉。
relationshipType	string	關聯性類型
typeName	string	型別的名稱。
uniqueAttributes		物件的唯一屬性。

AtlasRelatedTermHeader

相關詞彙的標頭。

名稱	類型	Description
description	string	相關詞彙的描述。
displayText	string	顯示文字。
expression	string	詞彙的表達式。
relationGuid	string	關聯性的 GUID。
status	AtlasTermRelationshipStatus	詞彙關聯性的狀態。
steward	string	詞彙的負責人。
termGuid	string	詞彙的 GUID。

AtlasStruct

擷取結構內容的詳細數據。未直接具現化，僅透過 AtlasEntity、AtlasClassification 使用。

名稱	類型	Description
attributes		結構的屬性。
lastModifiedTS	string	ETag 用於並行控制。
typeName	string	型別的名稱。

AtlasTermCategorizationHeader

詞彙分類的基本資訊。

名稱	類型	Description
categoryGuid	string	類別的 GUID。
description	string	記錄的描述。
displayText	string	顯示文字。
relationGuid	string	關聯性的 GUID。
status	AtlasTermRelationshipStatus	詞彙關聯性的狀態。

AtlasTermRelationshipStatus

atlas 字詞關聯性的狀態

名稱	類型	Description
ACTIVE	string	作用中
DEPRECATED	string	deprecated
DRAFT	string	草案
OBSOLETE	string	過時
OTHER	string	其他

EntityStatus

狀態 - 可以是作用中或刪除

名稱	類型	Description
ACTIVE	string	狀態為作用中。
DELETED	string	狀態已刪除。

PurviewObjectId

名稱	類型	Description
displayText	string	顯示文字
guid	string	物件的 GUID。
itemPath	string	項目路徑
name	string	名稱
properties		的字典
resourceId	string	資源標識碼
typeName	string	型別的名稱。
uniqueAttributes		物件的唯一屬性。

ResourceLink

名稱	類型	Description
displayName	string	URL 的顯示名稱。
url	string	Web URL。 http 或 https

StatusAtlasRelationship

atlas 關聯性的狀態

名稱	類型	Description
ACTIVE	string	作用中
DELETED	string	已刪除

TermStatus

字詞的狀態

名稱	類型	Description
Alert	string	警示
Approved	string	批准
Draft	string	草案
Expired	string	已到期

TimeBoundary

擷取時間界限詳細數據

名稱	類型	Description
endTime	string	時間界限的結尾。
startTime	string	時間界限的開頭。
timeZone	string	時間界限的時區。

共用方式為

Glossary - Create Term

URI 參數

要求本文

回應

安全性

OAuth2Auth

範圍

範例

Glossary_CreateTerm

範例要求

範例回覆

Glossary_CreateTermWithTemplate

範例要求

範例回覆

定義

AtlasClassification

AtlasErrorResponse

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary

其他資源