Bagikan melalui


Entity - Partial Update By Unique Attributes

Perbarui entitas sebagian - Izinkan subset atribut diperbarui pada entitas yang diidentifikasi oleh jenis dan atribut uniknya misalnya: Referenceable.qualifiedName. Pembaruan null tidak dimungkinkan.

Selain parameter jalur typeName, pasangan kunci-nilai atribut dapat disediakan dalam format berikut:

attr:=. CATATAN: AttrName dan attrValue harus unik di seluruh entitas, misalnya. qualifiedName.

Permintaan REST akan terlihat seperti ini: 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}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpoint
path True

string

typeName
path True

string

Nama jenis.

attr:qualifiedName
query

string

Nama entitas yang memenuhi syarat. (Ini hanya contoh. qualifiedName dapat diubah ke atribut unik lainnya)

Isi Permintaan

Nama Jenis Deskripsi
entity

AtlasEntity

Instans entitas - seperti hive_table, hive_database.

referredEntities

<string,  AtlasEntity>

Entitas yang dirujuk.

Respons

Nama Jenis Deskripsi
200 OK

EntityMutationResult

Permintaan telah berhasil.

Other Status Codes

AtlasErrorResponse

Respons kesalahan yang tidak terduga.

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
https://purview.azure.net/.default

Contoh

Entity_PartialUpdateByUniqueAttributes

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
AtlasClassification

Instans klasifikasi; tidak memiliki identitas, objek ini hanya ada ketika dikaitkan dengan entitas.

AtlasEntity

Instans entitas - seperti hive_table, hive_database.

AtlasEntityHeader

Instans entitas - seperti hive_table, hive_database.

AtlasEntityWithExtInfo

Instans entitas bersama dengan info yang diperluas - seperti hive_table, hive_database.

AtlasErrorResponse

Respons kesalahan dari layanan

AtlasTermAssignmentHeader

Header untuk penetapan istilah.

AtlasTermAssignmentStatus

Status untuk penetapan istilah

EntityMutationResult

Hasil respons mutasi entitas.

EntityStatus

Status - dapat aktif atau dihapus

TimeBoundary

Menangkap detail batas waktu

AtlasClassification

Instans klasifikasi; tidak memiliki identitas, objek ini hanya ada ketika dikaitkan dengan entitas.

Nama Jenis Deskripsi
attributes

Atribut struct.

entityGuid

string

GUID entitas.

entityStatus

EntityStatus

Status entitas - dapat aktif atau dihapus. Entitas yang dihapus tidak dihapus.

lastModifiedTS

string

ETag untuk kontrol konkurensi.

removePropagationsOnEntityDelete

boolean

Menentukan apakah propagasi akan dihapus pada penghapusan entitas.

typeName

string

Nama jenis.

validityPeriods

TimeBoundary[]

Array batas waktu yang menunjukkan periode validitas.

AtlasEntity

Instans entitas - seperti hive_table, hive_database.

Nama Jenis Deskripsi
attributes

Atribut struct.

businessAttributes

Atribut bisnis

classifications

AtlasClassification[]

Array klasifikasi.

collectionId

string

ID koleksi entitas.

contacts

object

Kamus kontak untuk entitas. Kuncinya bisa jadi Ahli atau Pemilik.

createTime

integer

Waktu rekaman yang dibuat.

createdBy

string

Pengguna yang membuat rekaman.

customAttributes

object

Atribut Kustom

guid

string

GUID entitas.

homeId

string

ID rumah entitas.

isIncomplete

boolean

Apakah itu entitas shell

labels

string[]

label

lastModifiedTS

string

ETag untuk kontrol konkurensi.

meanings

AtlasTermAssignmentHeader[]

Array header penetapan istilah yang menunjukkan arti entitas.

provenanceType

integer

Digunakan untuk merekam pembuktian instans entitas atau hubungan.

proxy

boolean

Menentukan apakah ada proksi.

relationshipAttributes

Atribut hubungan.

status

EntityStatus

Status entitas - dapat aktif atau dihapus. Entitas yang dihapus tidak dihapus.

typeName

string

Nama jenis.

updateTime

integer

Waktu pembaruan rekaman.

updatedBy

string

Pengguna yang memperbarui rekaman.

version

integer

Versi entitas.

AtlasEntityHeader

Instans entitas - seperti hive_table, hive_database.

Nama Jenis Deskripsi
attributes

Atribut struct.

classificationNames

string[]

Array nama klasifikasi.

classifications

AtlasClassification[]

Array klasifikasi.

displayText

string

Teks tampilan.

guid

string

GUID rekaman.

isIncomplete

boolean

Apakah itu entitas shell

labels

string[]

label

lastModifiedTS

string

ETag untuk kontrol konkurensi.

meaningNames

string[]

Array makna.

meanings

AtlasTermAssignmentHeader[]

Array header penetapan istilah.

status

EntityStatus

Status entitas - dapat aktif atau dihapus. Entitas yang dihapus tidak dihapus.

typeName

string

Nama jenis.

AtlasEntityWithExtInfo

Instans entitas bersama dengan info yang diperluas - seperti hive_table, hive_database.

Nama Jenis Deskripsi
entity

AtlasEntity

Instans entitas - seperti hive_table, hive_database.

referredEntities

<string,  AtlasEntity>

Entitas yang dirujuk.

AtlasErrorResponse

Respons kesalahan dari layanan

Nama Jenis Deskripsi
errorCode

string

Kode kesalahan.

errorMessage

string

Pesan kesalahan.

requestId

string

ID permintaan.

AtlasTermAssignmentHeader

Header untuk penetapan istilah.

Nama Jenis Deskripsi
confidence

integer

Keyakinan penetapan istilah.

createdBy

string

Pengguna yang membuat rekaman.

description

string

Deskripsi penetapan istilah.

displayText

string

Teks tampilan.

expression

string

Ekspresi penetapan istilah.

relationGuid

string

GUID hubungan.

status

AtlasTermAssignmentStatus

Status penetapan istilah.

steward

string

Pengurus istilah.

termGuid

string

GUID istilah.

AtlasTermAssignmentStatus

Status untuk penetapan istilah

Nama Jenis Deskripsi
DEPRECATED

string

Status tidak digunakan lagi.

DISCOVERED

string

Status ditemukan.

IMPORTED

string

Status diimpor.

OBSOLETE

string

Status sudah usang.

OTHER

string

Status lainnya.

PROPOSED

string

Status diusulkan.

VALIDATED

string

Status divalidasi.

EntityMutationResult

Hasil respons mutasi entitas.

Nama Jenis Deskripsi
guidAssignments

object

Peta penetapan GUID dengan entitas.

mutatedEntities

object

Header entitas entitas yang bermutasi.

partialUpdatedEntities

AtlasEntityHeader[]

Array header entitas yang diperbarui sebagian.

EntityStatus

Status - dapat aktif atau dihapus

Nama Jenis Deskripsi
ACTIVE

string

Status aktif.

DELETED

string

Status dihapus.

TimeBoundary

Menangkap detail batas waktu

Nama Jenis Deskripsi
endTime

string

Batas waktu akhir.

startTime

string

Awal batas waktu.

timeZone

string

Zona waktu batas waktu.