Glossary - Update Term

Referencia

Szolgáltatás:: Purview

API-verzió:: 2023-09-01

Frissítse a megadott szószedet kifejezést a GUID azonosítójával.

PUT {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}

Opcionális paraméterekkel:

PUT {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}?api-version=2023-09-01&includeTermHierarchy={includeTermHierarchy}

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)
termId	path	True	string	A szószedet kifejezés globálisan egyedi azonosítója.
api-version	query		string minLength: 1	A művelethez használni kívánt API-verzió.
includeTermHierarchy	query		boolean	Kifejezéshierarchia belefoglalása

Kérelem törzse

Name	Típus	Description
abbreviation	string	A kifejezés rövidítése.
anchor	AtlasGlossaryHeader	A szószedet fejléce alapszintű információkkal.
antonyms	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje antonimákként.
assignedEntities	AtlasRelatedObjectId[]	Kapcsolódó objektumazonosítók tömbje.
attributes	object	A kifejezés egyéni attribútumai, azaz a megfeleltetés<sztring,leképezés<sztring,objektum>>. Az első rétegtérkép kulcsa a kifejezéssablon neve.
categories	AtlasTermCategorizationHeader[]	Kifejezéskategorizálási fejlécek tömbje.
classifications	AtlasClassification[]	Besorolások tömbje.
classifies	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje.
contacts	object	A kifejezések névjegyeinek szótára. A kulcs lehet szakértő vagy gondnok.
createTime	integer (int64)	A rekord létrehozási ideje.
createdBy	string	A rekordot létrehozó felhasználó.
examples	string[]	Példák tömbje.
guid	string	Az objektum GUID azonosítója.
hierarchyInfo	PurviewObjectId[]	A kifejezés hierarchiaadatai.
isA	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje, amely az is-a kapcsolatot jelzi.
lastModifiedTS	string	ETag az egyidejűség-vezérléshez.
longDescription	string	A hosszú verzió leírása.
name	string	A szószedetobjektum neve.
nickName	string	A kifejezés nickneve.
preferredTerms	AtlasRelatedTermHeader[]	Az előnyben részesített kapcsolódó kifejezésfejlécek tömbje.
preferredToTerms	AtlasRelatedTermHeader[]	Az előnyben részesített kapcsolódó kifejezésfejlécek tömbje.
qualifiedName	string	A szószedetobjektum minősített neve.
replacedBy	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje, amelyet a rendszer lecserél.
replacementTerms	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje csere céljából.
resources	ResourceLink[]	Erőforráshivatkozás tömbje a kifejezéshez
seeAlso	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje lásd még.
shortDescription	string	A leírás rövid verziója.
status	TermStatus	Az AtlasGlossaryTerm állapota
synonyms	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje szinonimákként.
templateName	TemplateName[]	A sablon neve.
translatedTerms	AtlasRelatedTermHeader[]	Lefordított kapcsolódó kifejezésfejlécek tömbje.
translationTerms	AtlasRelatedTermHeader[]	A fordításhoz kapcsolódó kifejezésfejlécek tömbje.
updateTime	integer (int64)	A rekord frissítési ideje.
updatedBy	string	A rekordot frissített felhasználó.
usage	string	A kifejezés használata.
validValues	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje érvényes értékként.
validValuesFor	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje más rekordok érvényes értékeiként.

Válaszok

Name	Típus	Description
200 OK	AtlasGlossaryTerm	A kérés sikeres volt.
Other Status Codes	AtlasErrorResponse	Váratlan hibaválasz.

Biztonság

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

Glossary_UpdateTerm

Mintakérelem

HTTP

PUT {endpoint}/datamap/api/atlas/v2/glossary/term/54688d39-b298-4104-9e80-f2a16f44aaea?api-version=2023-09-01

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008"
    },
    {
      "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008"
    },
    {
      "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18"
    }
  ]
}

Mintaválasz

Állapotkód:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
      "displayText": "ExampleTerm2"
    },
    {
      "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18",
      "relationGuid": "4d802ada-65f3-45a8-969f-aba47d9c6200",
      "displayText": "ExampleTerm3"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
      "displayText": "ExampleTerm2"
    },
    {
      "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18",
      "relationGuid": "bb26fe7c-6e26-46ad-b936-50a5f7ffbbaf",
      "displayText": "ExampleTerm3"
    }
  ],
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ]
}

Definíciók

Name	Description
AtlasClassification	Besorolás egy példánya; nem rendelkezik identitással, ez az objektum csak akkor létezik, ha egy entitáshoz van társítva.
AtlasErrorResponse	Hibaválasz a szolgáltatástól
AtlasGlossaryHeader	A szószedet fejléce alapszintű információkkal.
AtlasGlossaryTerm	A szószedet kifejezés.
AtlasRelatedObjectId	Hivatkozás a kapcsolatattribútum-értékekben használt AtlasEntity típusú objektumpéldányra
AtlasRelatedTermHeader	A kapcsolódó kifejezés fejléce.
AtlasStruct	A szerkezet tartalmának részleteit rögzíti. Közvetlenül nem példányosítva, csak az AtlasEntity, Az AtlasClassification használatával használható.
AtlasTermCategorizationHeader	A kifejezés kategorizálásának alapvető információi.
AtlasTermRelationshipStatus	Az Atlas kifejezéskapcsolat állapota
EntityStatus	Állapot – lehet aktív vagy törölve
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	Atlas-kapcsolat állapota
TermStatus	A kifejezés állapota
TimeBoundary	Időhatár részleteinek rögzítése

AtlasClassification

Objektum

Besorolás egy példánya; nem rendelkezik identitással, ez az objektum csak akkor létezik, ha egy entitáshoz van társítva.

Name	Típus	Description
attributes		A szerkezet attribútumai.
entityGuid	string	Az entitás GUID azonosítója.
entityStatus	EntityStatus	Az entitás állapota – lehet aktív vagy törölhető. A törölt entitások nem törlődnek.
lastModifiedTS	string	ETag az egyidejűség-vezérléshez.
removePropagationsOnEntityDelete	boolean	Meghatározza, hogy a propagálások törlődnek-e az entitás törlésekor.
typeName	string	A típus neve.
validityPeriods	TimeBoundary[]	Az érvényességi időtartamokat jelző időhatárok tömbje.

AtlasErrorResponse

Objektum

Hibaválasz a szolgáltatástól

Name	Típus	Description
errorCode	string	A hibakód.
errorMessage	string	A hibaüzenet.
requestId	string (uuid)	A kérelem azonosítója.

AtlasGlossaryHeader

Objektum

A szószedet fejléce alapszintű információkkal.

Name	Típus	Description
displayText	string	A megjelenített szöveg.
glossaryGuid	string	A szószedet GUID azonosítója.
relationGuid	string	A kapcsolat GUID azonosítója.

AtlasGlossaryTerm

Objektum

A szószedet kifejezés.

Name	Típus	Description
abbreviation	string	A kifejezés rövidítése.
anchor	AtlasGlossaryHeader	A szószedet fejléce alapszintű információkkal.
antonyms	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje antonimákként.
assignedEntities	AtlasRelatedObjectId[]	Kapcsolódó objektumazonosítók tömbje.
attributes	object	A kifejezés egyéni attribútumai, azaz a megfeleltetés<sztring,leképezés<sztring,objektum>>. Az első rétegtérkép kulcsa a kifejezéssablon neve.
categories	AtlasTermCategorizationHeader[]	Kifejezéskategorizálási fejlécek tömbje.
classifications	AtlasClassification[]	Besorolások tömbje.
classifies	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje.
contacts	object	A kifejezések névjegyeinek szótára. A kulcs lehet szakértő vagy gondnok.
createTime	integer (int64)	A rekord létrehozási ideje.
createdBy	string	A rekordot létrehozó felhasználó.
examples	string[]	Példák tömbje.
guid	string	Az objektum GUID azonosítója.
hierarchyInfo	PurviewObjectId[]	A kifejezés hierarchiaadatai.
isA	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje, amely az is-a kapcsolatot jelzi.
lastModifiedTS	string	ETag az egyidejűség-vezérléshez.
longDescription	string	A hosszú verzió leírása.
name	string	A szószedetobjektum neve.
nickName	string	A kifejezés nickneve.
preferredTerms	AtlasRelatedTermHeader[]	Az előnyben részesített kapcsolódó kifejezésfejlécek tömbje.
preferredToTerms	AtlasRelatedTermHeader[]	Az előnyben részesített kapcsolódó kifejezésfejlécek tömbje.
qualifiedName	string	A szószedetobjektum minősített neve.
replacedBy	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje, amelyet a rendszer lecserél.
replacementTerms	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje csere céljából.
resources	ResourceLink[]	Erőforráshivatkozás tömbje a kifejezéshez
seeAlso	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje lásd még.
shortDescription	string	A leírás rövid verziója.
status	TermStatus	Az AtlasGlossaryTerm állapota
synonyms	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje szinonimákként.
templateName	TemplateName[]	A sablon neve.
translatedTerms	AtlasRelatedTermHeader[]	Lefordított kapcsolódó kifejezésfejlécek tömbje.
translationTerms	AtlasRelatedTermHeader[]	A fordításhoz kapcsolódó kifejezésfejlécek tömbje.
updateTime	integer (int64)	A rekord frissítési ideje.
updatedBy	string	A rekordot frissített felhasználó.
usage	string	A kifejezés használata.
validValues	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje érvényes értékként.
validValuesFor	AtlasRelatedTermHeader[]	A kapcsolódó kifejezésfejlécek tömbje más rekordok érvényes értékeiként.

AtlasRelatedObjectId

Objektum

Hivatkozás a kapcsolatattribútum-értékekben használt AtlasEntity típusú objektumpéldányra

Name	Típus	Description
displayText	string	A megjelenített szöveg.
entityStatus	EntityStatus	Az entitás állapota – lehet aktív vagy törölhető. A törölt entitások nem törlődnek.
guid	string	Az objektum GUID azonosítója.
relationshipAttributes	AtlasStruct	A szerkezet tartalmának részleteit rögzíti. Közvetlenül nem példányosítva, csak az AtlasEntity, Az AtlasClassification használatával használható.
relationshipGuid	string (uuid)	A kapcsolat GUID azonosítója.
relationshipStatus	StatusAtlasRelationship	A kapcsolati állapot enumerációja.
relationshipType	string	Kapcsolat típusa
typeName	string	A típus neve.
uniqueAttributes		Az objektum egyedi attribútumai.

AtlasRelatedTermHeader

Objektum

A kapcsolódó kifejezés fejléce.

Name	Típus	Description
description	string	A kapcsolódó kifejezés leírása.
displayText	string	A megjelenített szöveg.
expression	string	A kifejezés kifejezése.
relationGuid	string	A kapcsolat GUID azonosítója.
status	AtlasTermRelationshipStatus	A kifejezéskapcsolat állapota.
steward	string	A kifejezés intézője.
termGuid	string	A kifejezés GUID azonosítója.

AtlasStruct

Objektum

A szerkezet tartalmának részleteit rögzíti. Közvetlenül nem példányosítva, csak az AtlasEntity, Az AtlasClassification használatával használható.

Name	Típus	Description
attributes		A szerkezet attribútumai.
lastModifiedTS	string	ETag az egyidejűség-vezérléshez.
typeName	string	A típus neve.

AtlasTermCategorizationHeader

Objektum

A kifejezés kategorizálásának alapvető információi.

Name	Típus	Description
categoryGuid	string (uuid)	A kategória GUID azonosítója.
description	string	A rekord leírása.
displayText	string	A megjelenített szöveg.
relationGuid	string (uuid)	A kapcsolat GUID azonosítója.
status	AtlasTermRelationshipStatus	A kifejezéskapcsolat állapota.

AtlasTermRelationshipStatus

Enumerálás

Az Atlas kifejezéskapcsolat állapota

Érték	Description
ACTIVE	aktív
DEPRECATED	elavult
DRAFT	piszkozat
OBSOLETE	elavult
OTHER	más

EntityStatus

Enumerálás

Állapot – lehet aktív vagy törölve

Érték	Description
ACTIVE	Az állapot aktív.
DELETED	Az állapot törlődik.

PurviewObjectId

Objektum

PurviewObjectId

Name	Típus	Description
displayText	string	Megjelenítendő szöveg
guid	string	Az objektum GUID azonosítója.
itemPath	string	Elem elérési útja
name	string	Név
properties		Szótár
resourceId	string	Erőforrás-azonosító
typeName	string	A típus neve.
uniqueAttributes		Az objektum egyedi attribútumai.

ResourceLink

Objektum

ResourceLink

Name	Típus	Description
displayName	string	Az URL-cím megjelenítendő neve.
url	string	webes URL-cím. http vagy https

StatusAtlasRelationship

Enumerálás

Atlas-kapcsolat állapota

Érték	Description
ACTIVE	aktív
DELETED	törölt

TermStatus

Enumerálás

A kifejezés állapota

Érték	Description
Alert	figyelmeztetés
Approved	jóváhagyott
Draft	piszkozat
Expired	Lejárt

TimeBoundary

Objektum

Időhatár részleteinek rögzítése

Name	Típus	Description
endTime	string	Az időhatár vége.
startTime	string	Az időhatár kezdete.
timeZone	string	Az időhatár időzónája.

Megosztás a következőn keresztül:

Glossary - Update Term

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

OAuth2Auth

Hatókörök

Példák

Glossary_UpdateTerm

Mintakérelem

Mintaválasz

Definíciók

AtlasClassification

AtlasErrorResponse

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary