Udostępnij za pośrednictwem


Entity - Partial Update By Unique Attributes

Aktualizowanie jednostki częściowo — umożliwia aktualizowanie podzestawu atrybutów w jednostce, która jest identyfikowana przez jego typ i unikatowy atrybut, np. Referenceable.qualifiedName. Aktualizacje o wartości null nie są możliwe.

Oprócz parametru ścieżki typeName pary klucz-wartość atrybutu mogą być podane w następującym formacie:

attr:=. UWAGA: AttrName i attrValue powinny być unikatowe w jednostkach, np. Qualifiedname.

Żądanie REST będzie wyglądać mniej więcej tak: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}
PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?attr:qualifiedName={attr:qualifiedName}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
path True

string

typeName
path True

string

Nazwa typu.

attr:qualifiedName
query

string

Kwalifikowana nazwa jednostki. (Jest to tylko przykład. qualifiedName można zmienić na inne unikatowe atrybuty)

Treść żądania

Nazwa Typ Opis
entity

AtlasEntity

Wystąpienie jednostki — na przykład hive_table, hive_database.

referredEntities

<string,  AtlasEntity>

Jednostki, o których mowa.

Odpowiedzi

Nazwa Typ Opis
200 OK

EntityMutationResult

Żądanie zakończyło się pomyślnie.

Other Status Codes

AtlasErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
https://purview.azure.net/.default

Przykłady

Entity_PartialUpdateByUniqueAttributes

Przykładowe żądanie

PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?attr:qualifiedName=https://exampleaccount.core.windows.net

{
  "entity": {
    "createTime": 1605766397985,
    "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
    "relationshipAttributes": {
      "services": [],
      "meanings": []
    },
    "status": "ACTIVE",
    "updateTime": 1605766397985,
    "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "lastModifiedTS": "1",
    "version": 0,
    "attributes": {
      "owner": "ExampleOwner",
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "createTime": 0,
      "name": "ExampleNewName"
    },
    "typeName": "azure_storage_account"
  },
  "referredEntities": {}
}

Przykładowa odpowiedź

{
  "guidAssignments": {},
  "mutatedEntities": {
    "PARTIAL_UPDATE": [
      {
        "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
        "lastModifiedTS": "2",
        "attributes": {
          "qualifiedName": "https://exampleaccount.core.windows.net"
        },
        "typeName": "azure_storage_account"
      }
    ]
  },
  "partialUpdatedEntities": [
    {
      "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
      "lastModifiedTS": "2",
      "attributes": {
        "qualifiedName": "https://exampleaccount.core.windows.net"
      },
      "typeName": "azure_storage_account"
    }
  ]
}

Definicje

Nazwa Opis
AtlasClassification

Wystąpienie klasyfikacji; nie ma tożsamości, ten obiekt istnieje tylko wtedy, gdy jest skojarzony z jednostką.

AtlasEntity

Wystąpienie jednostki — na przykład hive_table, hive_database.

AtlasEntityHeader

Wystąpienie jednostki — na przykład hive_table, hive_database.

AtlasEntityWithExtInfo

Wystąpienie jednostki wraz z dodatkowymi informacjami — na przykład hive_table, hive_database.

AtlasErrorResponse

Odpowiedź o błędzie z usługi

AtlasTermAssignmentHeader

Nagłówek przypisywania terminów.

AtlasTermAssignmentStatus

Stan przypisania terminu

EntityMutationResult

Wynik odpowiedzi mutacji jednostki.

EntityStatus

Stan — może być aktywny lub usunięty

TimeBoundary

Przechwytuje szczegóły granicy czasu

AtlasClassification

Wystąpienie klasyfikacji; nie ma tożsamości, ten obiekt istnieje tylko wtedy, gdy jest skojarzony z jednostką.

Nazwa Typ Opis
attributes

Atrybuty struktury.

entityGuid

string

Identyfikator GUID jednostki.

entityStatus

EntityStatus

Stan jednostki — może być aktywny lub usunięty. Usunięte jednostki nie są usuwane.

lastModifiedTS

string

ETag dla kontrolki współbieżności.

removePropagationsOnEntityDelete

boolean

Określa, czy propagacje zostaną usunięte po usunięciu jednostki.

typeName

string

Nazwa typu.

validityPeriods

TimeBoundary[]

Tablica granic czasu wskazująca okresy ważności.

AtlasEntity

Wystąpienie jednostki — na przykład hive_table, hive_database.

Nazwa Typ Opis
attributes

Atrybuty struktury.

businessAttributes

Atrybuty biznesowe

classifications

AtlasClassification[]

Tablica klasyfikacji.

collectionId

string

Identyfikator kolekcji jednostki.

contacts

object

Słownik kontaktów dla jednostek. Kluczem może być ekspert lub właściciel.

createTime

integer

Godzina utworzenia rekordu.

createdBy

string

Użytkownik, który utworzył rekord.

customAttributes

object

Atrybut niestandardowy

guid

string

Identyfikator GUID jednostki.

homeId

string

Identyfikator strony głównej jednostki.

isIncomplete

boolean

Czy jest to jednostka powłoki

labels

string[]

Etykiety

lastModifiedTS

string

ETag dla kontrolki współbieżności.

meanings

AtlasTermAssignmentHeader[]

Tablica nagłówków przypisania terminów wskazująca znaczenie jednostki.

provenanceType

integer

Służy do rejestrowania pochodzenia wystąpienia jednostki lub relacji.

proxy

boolean

Określa, czy istnieje serwer proxy.

relationshipAttributes

Atrybuty relacji.

status

EntityStatus

Stan jednostki — może być aktywny lub usunięty. Usunięte jednostki nie są usuwane.

typeName

string

Nazwa typu.

updateTime

integer

Czas aktualizacji rekordu.

updatedBy

string

Użytkownik, który zaktualizował rekord.

version

integer

Wersja jednostki.

AtlasEntityHeader

Wystąpienie jednostki — na przykład hive_table, hive_database.

Nazwa Typ Opis
attributes

Atrybuty struktury.

classificationNames

string[]

Tablica nazw klasyfikacji.

classifications

AtlasClassification[]

Tablica klasyfikacji.

displayText

string

Tekst wyświetlany.

guid

string

Identyfikator GUID rekordu.

isIncomplete

boolean

Czy jest to jednostka powłoki

labels

string[]

Etykiety

lastModifiedTS

string

ETag dla kontrolki współbieżności.

meaningNames

string[]

Tablica znaczenia.

meanings

AtlasTermAssignmentHeader[]

Tablica nagłówków przypisania terminów.

status

EntityStatus

Stan jednostki — może być aktywny lub usunięty. Usunięte jednostki nie są usuwane.

typeName

string

Nazwa typu.

AtlasEntityWithExtInfo

Wystąpienie jednostki wraz z dodatkowymi informacjami — na przykład hive_table, hive_database.

Nazwa Typ Opis
entity

AtlasEntity

Wystąpienie jednostki — na przykład hive_table, hive_database.

referredEntities

<string,  AtlasEntity>

Jednostki, o których mowa.

AtlasErrorResponse

Odpowiedź o błędzie z usługi

Nazwa Typ Opis
errorCode

string

Kod błędu.

errorMessage

string

Komunikat o błędzie.

requestId

string

Identyfikator żądania.

AtlasTermAssignmentHeader

Nagłówek przypisywania terminów.

Nazwa Typ Opis
confidence

integer

Pewność przypisania terminu.

createdBy

string

Użytkownik, który utworzył rekord.

description

string

Opis przypisania terminu.

displayText

string

Tekst wyświetlany.

expression

string

Wyrażenie przypisania terminu.

relationGuid

string

Identyfikator GUID relacji.

status

AtlasTermAssignmentStatus

Stan przypisania terminów.

steward

string

Steward kadencji.

termGuid

string

Identyfikator GUID terminu.

AtlasTermAssignmentStatus

Stan przypisania terminu

Nazwa Typ Opis
DEPRECATED

string

Stan jest przestarzały.

DISCOVERED

string

Stan zostanie odnaleziony.

IMPORTED

string

Stan jest importowany.

OBSOLETE

string

Stan jest przestarzały.

OTHER

string

Inny stan.

PROPOSED

string

Stan jest proponowany.

VALIDATED

string

Stan jest weryfikowany.

EntityMutationResult

Wynik odpowiedzi mutacji jednostki.

Nazwa Typ Opis
guidAssignments

object

Mapa przypisań identyfikatora GUID z jednostkami.

mutatedEntities

object

Nagłówki jednostek zmutowanych.

partialUpdatedEntities

AtlasEntityHeader[]

Tablica nagłówków jednostek, które częściowo zostały zaktualizowane.

EntityStatus

Stan — może być aktywny lub usunięty

Nazwa Typ Opis
ACTIVE

string

Stan jest aktywny.

DELETED

string

Stan jest usuwany.

TimeBoundary

Przechwytuje szczegóły granicy czasu

Nazwa Typ Opis
endTime

string

Koniec granicy czasu.

startTime

string

Początek granicy czasowej.

timeZone

string

Strefa czasowa granicy czasu.