Items - Update Item Definition

Layanan:

Core

Versi API:

v1

Mengambil alih definisi untuk item yang ditentukan.
API ini didukung untuk sejumlah jenis item, menemukan jenis item yang didukung dan informasi tentang struktur definisinya dalam Gambaran umum definisi item. Memperbarui definisi item, tidak memengaruhi label sensitivitasnya.

API ini mendukung operasi jangka panjang (LRO).

Hak akses

Pemanggil harus memiliki izin baca dan tulis untuk item tersebut.

Cakupan yang Didelegasikan yang Diperlukan

Untuk API item, gunakan jenis cakupan ini:

• Cakupan generik: Item.ReadWrite.All
• Cakupan spesifik: itemType. ReadWrite.All (misalnya: Notebook.ReadWrite.All)

untuk informasi selengkapnya tentang cakupan, lihat artikel cakupan .

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Dukungan
Pengguna	Ya
Prinsipal Layanan dan Identitas Terkelola	Saat tipe item dalam panggilan didukung. Periksa API yang sesuai untuk jenis item yang Anda panggil, untuk melihat apakah panggilan Anda didukung. Misalnya, model semantik didukung.

Antarmuka

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition

Dengan parameter opsional:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition?updateMetadata={updateMetadata}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
itemId	path	True	string (uuid)	ID item.
workspaceId	path	True	string (uuid)	ID ruangkerja.
updateMetadata	query		boolean	Ketika diatur ke true dan file .platform disediakan sebagai bagian dari definisi, metadata item diperbarui menggunakan metadata dalam file .platform

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
definition	True	ItemDefinition	Objek definisi item.

Respons

Nama	Jenis	Deskripsi
200 OK		Permintaan berhasil diselesaikan.
202 Accepted		Permintaan diterima. Definisi pembaruan sedang berlangsung. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: OperationNotSupportedForItem - Operasi tidak didukung untuk item yang diminta. CorruptedPayload - Payload yang disediakan rusak.

Contoh

Update an item definition example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Respon sampel

Kode status:

200

Kode status:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definisi

Nama	Deskripsi
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
ItemDefinition	Objek definisi item.
ItemDefinitionPart	Objek bagian definisi item.
PayloadType	Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.
UpdateItemDefinitionRequest	Memperbarui payload permintaan definisi item.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

ItemDefinition

Objek

Objek definisi item.

Nama	Jenis	Deskripsi
format	string	Format definisi item.
parts	ItemDefinitionPart[]	Daftar bagian definisi.

ItemDefinitionPart

Objek

Objek bagian definisi item.

Nama	Jenis	Deskripsi
path	string	Jalur bagian item.
payload	string	Payload bagian item.
payloadType	PayloadType	Jenis payload.

PayloadType

Enumeration

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
InlineBase64	Dasar Sebaris 64.

UpdateItemDefinitionRequest

Objek

Memperbarui payload permintaan definisi item.

Nama	Jenis	Deskripsi
definition	ItemDefinition	Objek definisi item.