Condividi tramite


Entity - Partial Update By Unique Attributes

Aggiornare parzialmente l'entità: consente l'aggiornamento di un subset di attributi in un'entità identificata dal tipo e dall'attributo univoco, ad esempio Referenceable.qualifiedName. Gli aggiornamenti Null non sono possibili.

Oltre al parametro typeName path, le coppie chiave-valore dell'attributo possono essere fornite nel formato seguente:

attr:=. NOTA: attrName e attrValue devono essere univoci tra le entità, ad esempio. qualifiedName.

La richiesta REST sarà simile alla seguente: 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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string

typeName
path True

string

Nome del tipo.

attr:qualifiedName
query

string

Nome completo dell'entità. Questo è solo un esempio. qualifiedName può essere modificato in altri attributi univoci.

Corpo della richiesta

Nome Tipo Descrizione
entity

AtlasEntity

Istanza di un'entità, ad esempio hive_table, hive_database.

referredEntities

<string,  AtlasEntity>

Entità di riferimento.

Risposte

Nome Tipo Descrizione
200 OK

EntityMutationResult

La richiesta ha avuto esito positivo.

Other Status Codes

AtlasErrorResponse

Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
https://purview.azure.net/.default

Esempio

Entity_PartialUpdateByUniqueAttributes

Esempio di richiesta

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": {}
}

Risposta di esempio

{
  "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"
    }
  ]
}

Definizioni

Nome Descrizione
AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo se associato a un'entità.

AtlasEntity

Istanza di un'entità, ad esempio hive_table, hive_database.

AtlasEntityHeader

Istanza di un'entità, ad esempio hive_table, hive_database.

AtlasEntityWithExtInfo

Istanza di un'entità con informazioni estese, ad esempio hive_table hive_database.

AtlasErrorResponse

Risposta di errore dal servizio

AtlasTermAssignmentHeader

Intestazione per l'assegnazione di termini.

AtlasTermAssignmentStatus

Stato per l'assegnazione di termini

EntityMutationResult

Risultato della risposta alla mutazione dell'entità.

EntityStatus

Stato: può essere attivo o eliminato

TimeBoundary

Acquisisce i dettagli dei limiti di tempo

AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo se associato a un'entità.

Nome Tipo Descrizione
attributes

Attributi dello struct.

entityGuid

string

GUID dell'entità.

entityStatus

EntityStatus

Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.

lastModifiedTS

string

ETag per il controllo della concorrenza.

removePropagationsOnEntityDelete

boolean

Determina se le propagazioni verranno rimosse durante l'eliminazione dell'entità.

typeName

string

Nome del tipo.

validityPeriods

TimeBoundary[]

Matrice di limiti di tempo che indica i periodi di validità.

AtlasEntity

Istanza di un'entità, ad esempio hive_table, hive_database.

Nome Tipo Descrizione
attributes

Attributi dello struct.

businessAttributes

Attributi business

classifications

AtlasClassification[]

Matrice di classificazioni.

collectionId

string

ID raccolta dell'entità.

contacts

object

Dizionario dei contatti per le entità. La chiave può essere Expert o Owner.

createTime

integer

Ora di creazione del record.

createdBy

string

Utente che ha creato il record.

customAttributes

object

Attributo personalizzato

guid

string

GUID dell'entità.

homeId

string

ID home dell'entità.

isIncomplete

boolean

Indica se si tratta di un'entità shell

labels

string[]

Etichette

lastModifiedTS

string

ETag per il controllo della concorrenza.

meanings

AtlasTermAssignmentHeader[]

Matrice di intestazioni di assegnazione di termini che indica i significati dell'entità.

provenanceType

integer

Usato per registrare la provenienza di un'istanza di un'entità o di una relazione.

proxy

boolean

Determina se è presente un proxy.

relationshipAttributes

Attributi della relazione.

status

EntityStatus

Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.

typeName

string

Nome del tipo.

updateTime

integer

Ora di aggiornamento del record.

updatedBy

string

Utente che ha aggiornato il record.

version

integer

Versione dell'entità.

AtlasEntityHeader

Istanza di un'entità, ad esempio hive_table, hive_database.

Nome Tipo Descrizione
attributes

Attributi dello struct.

classificationNames

string[]

Matrice di nomi di classificazione.

classifications

AtlasClassification[]

Matrice di classificazioni.

displayText

string

Testo visualizzato.

guid

string

GUID del record.

isIncomplete

boolean

Indica se si tratta di un'entità shell

labels

string[]

Etichette

lastModifiedTS

string

ETag per il controllo della concorrenza.

meaningNames

string[]

Matrice di significati.

meanings

AtlasTermAssignmentHeader[]

Matrice di intestazioni di assegnazione di termini.

status

EntityStatus

Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.

typeName

string

Nome del tipo.

AtlasEntityWithExtInfo

Istanza di un'entità con informazioni estese, ad esempio hive_table hive_database.

Nome Tipo Descrizione
entity

AtlasEntity

Istanza di un'entità, ad esempio hive_table, hive_database.

referredEntities

<string,  AtlasEntity>

Entità di riferimento.

AtlasErrorResponse

Risposta di errore dal servizio

Nome Tipo Descrizione
errorCode

string

Codice di errore.

errorMessage

string

Messaggio di errore.

requestId

string

ID richiesta.

AtlasTermAssignmentHeader

Intestazione per l'assegnazione di termini.

Nome Tipo Descrizione
confidence

integer

Attendibilità dell'assegnazione del termine.

createdBy

string

Utente che ha creato il record.

description

string

Descrizione dell'assegnazione del termine.

displayText

string

Testo visualizzato.

expression

string

Espressione dell'assegnazione del termine.

relationGuid

string

GUID della relazione.

status

AtlasTermAssignmentStatus

Stato dell'assegnazione dei termini.

steward

string

Amministratore del termine.

termGuid

string

GUID del termine.

AtlasTermAssignmentStatus

Stato per l'assegnazione di termini

Nome Tipo Descrizione
DEPRECATED

string

Lo stato è deprecato.

DISCOVERED

string

Lo stato viene individuato.

IMPORTED

string

Lo stato viene importato.

OBSOLETE

string

Lo stato è obsoleto.

OTHER

string

Altro stato.

PROPOSED

string

Lo stato viene proposto.

VALIDATED

string

Lo stato viene convalidato.

EntityMutationResult

Risultato della risposta alla mutazione dell'entità.

Nome Tipo Descrizione
guidAssignments

object

Mappa delle assegnazioni GUID con entità.

mutatedEntities

object

Intestazioni di entità di entità mutate.

partialUpdatedEntities

AtlasEntityHeader[]

Matrice di intestazioni di entità che sono state aggiornate parzialmente.

EntityStatus

Stato: può essere attivo o eliminato

Nome Tipo Descrizione
ACTIVE

string

Lo stato è attivo.

DELETED

string

Lo stato viene eliminato.

TimeBoundary

Acquisisce i dettagli dei limiti di tempo

Nome Tipo Descrizione
endTime

string

Fine del limite di tempo.

startTime

string

Inizio del limite di tempo.

timeZone

string

Fuso orario del limite di tempo.