Entity - List By Unique Attributes

Referencia

Szolgáltatás:: Purview

API-verzió:: 2023-09-01

Tömeges API az egyedi attribútumai által azonosított entitások listájának lekéréséhez. A typeName elérési út paraméter mellett az attribútumkulcs-érték pár(ok) az alábbi formátumban is megadható

typeName=<typeName>&attr_1:<attrName>=<attrValue>&attr_2:<attrName>=<attrValue>&attr_3:<attrName>=<attrValue>

MEGJEGYZÉS: Az attrName tulajdonságnak egyedi attribútumnak kell lennie az adott entitástípushoz. A REST-kérés így nézne ki

GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1

Megjegyzés: legalább egy egyedi attribútumot meg kell adni.

GET {endpoint}/datamap/api/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}

Opcionális paraméterekkel:

GET {endpoint}/datamap/api/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}&attr_N:qualifiedName={attr_N:qualifiedName}

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)
typeName	path	True	string	A típus neve.
attr_N:qualifiedName	query		string	Entitás minősített neve. Ha például két entitást szeretne megkeresni, beállíthatja attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (Ez csak egy példa. a qualifiedName más egyedi attribútumokra módosítható)
ignoreRelationships	query		boolean	A kapcsolatattribútumok figyelmen kívül hagyása.
minExtInfo	query		boolean	A hivatkozott entitások minimális információinak megadása.

Válaszok

Name	Típus	Description
200 OK	AtlasEntitiesWithExtInfo	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

Entity_ListByUniqueAttributes

Mintakérelem

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/bulk/uniqueAttribute/type/azure_storage_account?minExtInfo=True&attr_N:qualifiedName=adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1

Mintaválasz

Állapotkód:: 200

{
  "referredEntities": {},
  "entities": [
    {
      "typeName": "column",
      "attributes": {
        "owner": null,
        "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1",
        "name": "ExampleName1",
        "description": null,
        "type": "string"
      },
      "guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021",
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "createTime": 1553072455110,
      "updateTime": 1553072455110,
      "version": 0,
      "relationshipAttributes": {
        "schema": [],
        "inputToProcesses": [],
        "composeSchema": {
          "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929",
          "typeName": "tabular_schema",
          "displayText": "tabular_schema",
          "relationshipGuid": "400fd8e4-97bd-45eb-a21c-880b4094ce5b",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "tabular_schema_columns"
          }
        },
        "meanings": [],
        "outputFromProcesses": [],
        "tabular_schema": null
      }
    }
  ]
}

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.
AtlasEntitiesWithExtInfo	Egy entitás egy példánya a kiterjesztett adatokkal együtt – például hive_table, hive_database.
AtlasEntity	Egy entitás egy példánya – például hive_table, hive_database.
AtlasErrorResponse	Hibaválasz a szolgáltatástól
AtlasTermAssignmentHeader	A kifejezés-hozzárendelés fejléce.
AtlasTermAssignmentStatus	A kifejezés-hozzárendelés állapota
EntityStatus	Állapot – lehet aktív vagy törölve
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.

AtlasEntitiesWithExtInfo

Objektum

Egy entitás egy példánya a kiterjesztett adatokkal együtt – például hive_table, hive_database.

Name	Típus	Description
entities	AtlasEntity[]	Entitások tömbje.
referredEntities	<string, AtlasEntity>	A hivatkozott entitások.

AtlasEntity

Objektum

Egy entitás egy példánya – például hive_table, hive_database.

Name	Típus	Description
attributes		A szerkezet attribútumai.
businessAttributes		Üzleti attribútumok
classifications	AtlasClassification[]	Besorolások tömbje.
collectionId	string	Az entitás gyűjteményazonosítója.
contacts	object	Az entitások névjegyeinek szótára. A kulcs lehet szakértő vagy tulajdonos.
createTime	integer (int64)	A rekord létrehozási ideje.
createdBy	string	A rekordot létrehozó felhasználó.
customAttributes	object	Egyéni attribútum
guid	string	Az entitás GUID azonosítója.
homeId	string	Az entitás otthoni azonosítója.
isIncomplete	boolean	Függetlenül attól, hogy rendszerhéj-entitás-e
labels	string[]	Címkék
lastModifiedTS	string	ETag az egyidejűség-vezérléshez.
meanings	AtlasTermAssignmentHeader[]	Kifejezés-hozzárendelés fejléceinek tömbje, amely az entitás jelentését jelzi.
provenanceType	integer (int32)	Egy entitás vagy kapcsolat egy példányának eredetének rögzítésére szolgál.
proxy	boolean	Meghatározza, hogy van-e proxy.
relationshipAttributes		A kapcsolat attribútumai.
status	EntityStatus	Az entitás állapota – lehet aktív vagy törölhető. A törölt entitások nem törlődnek.
typeName	string	A típus neve.
updateTime	integer (int64)	A rekord frissítési ideje.
updatedBy	string	A rekordot frissített felhasználó.
version	integer (int64)	Az entitás verziója.

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.

AtlasTermAssignmentHeader

Objektum

A kifejezés-hozzárendelés fejléce.

Name	Típus	Description
confidence	integer (int32)	A kifejezés-hozzárendelés megbízhatósága.
createdBy	string	A rekordot létrehozó felhasználó.
description	string	A hozzárendelés kifejezésének leírása.
displayText	string	A megjelenített szöveg.
expression	string	A hozzárendelés kifejezése.
relationGuid	string (uuid)	A kapcsolat GUID azonosítója.
status	AtlasTermAssignmentStatus	A feltételek hozzárendelésének állapota.
steward	string	A kifejezés intézője.
termGuid	string (uuid)	A kifejezés GUID azonosítója.

AtlasTermAssignmentStatus

Enumerálás

A kifejezés-hozzárendelés állapota

Érték	Description
DEPRECATED	Az állapot elavult.
DISCOVERED	Az állapot felderítve.
IMPORTED	Az állapot importálása történik.
OBSOLETE	Az állapot elavult.
OTHER	Egyéb állapot.
PROPOSED	Az állapot javasolt.
VALIDATED	A rendszer ellenőrzi az állapotot.

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.

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.