Items - Update Item Definition

Hizmet:

Core

API Sürümü:

v1

Belirtilen öğenin tanımını geçersiz kılar.
Bu API bir dizi öğe türü için desteklenir, öğe tanımına genel bakış bölümünde desteklenen öğe türlerini ve bunların tanım yapısı hakkındaki bilgileri bulabilirsiniz. Öğenin tanımının güncelleştirilmesi, duyarlılık etiketini etkilemez.

Bu API, uzun süre çalışan işlemleri (LRO)destekler.

İzinler

Çağıranın öğe için okuma ve yazma izinleri olmalıdır.

Gerekli Temsilci Kapsamları

Öğe API'leri için şu kapsam türlerini kullanın:

• Genel kapsam: Item.ReadWrite.All
• Belirli kapsam: itemType. ReadWrite.All (örneğin: Notebook.ReadWrite.All)

Kapsamlar hakkında daha fazla bilgi için kapsamlar makalesine bakın.

Microsoft Entra destekli kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik	Destek
Kullanıcı	Evet
Hizmet sorumlusu ve yönetilen kimlikler	Çağrıdaki öğe türü desteklendiğinde. Aramanızın desteklenip desteklenmediğini görmek için çağırdığınız öğe türü için ilgili API'yi denetleyin. Örneğin, anlamsal modeller desteklenir.

Arayüz

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
itemId	path	True	string (uuid)	Öğe kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.
updateMetadata	query		boolean	True olarak ayarlandığında ve .platform dosyası tanımın bir parçası olarak sağlandığında, öğenin meta verileri .platform dosyasındaki meta veriler kullanılarak güncelleştirilir

İstek Gövdesi

Name	Gerekli	Tür	Description
definition	True	ItemDefinition	Öğe tanımı nesnesi.

Yanıtlar

Name	Tür	Description
200 OK		İstek başarıyla tamamlandı.
202 Accepted		İstek kabul edildi. Güncelleştirme tanımı devam ediyor. Üst Bilgiler Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: OperationNotSupportedForItem - İstenen öğe için işlem desteklenmiyor. BozukPayload - Sağlanan yük bozuk.

Örnekler

Update an item definition example

Örnek isteği

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

Örnek yanıt

Durum kodu:

200

Durum kodu:

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

Tanımlar

Name	Description
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
ItemDefinition	Öğe tanımı nesnesi.
ItemDefinitionPart	Öğe tanımı parça nesnesi.
PayloadType	Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.
UpdateItemDefinitionRequest	Öğe tanımı isteği yükünü güncelleştirin.

ErrorRelatedResource

Object

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Object

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Object

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

ItemDefinition

Object

Öğe tanımı nesnesi.

Name	Tür	Description
format	string	Öğe tanımının biçimi.
parts	ItemDefinitionPart[]	Tanım bölümlerinin listesi.

ItemDefinitionPart

Object

Öğe tanımı parça nesnesi.

Name	Tür	Description
path	string	Öğe bölümü yolu.
payload	string	Öğe bölümü yükü.
payloadType	PayloadType	Yük türü.

PayloadType

Listeleme

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

Değer	Description
InlineBase64	Satır içi Temel 64.

UpdateItemDefinitionRequest

Object

Öğe tanımı isteği yükünü güncelleştirin.

Name	Tür	Description
definition	ItemDefinition	Öğe tanımı nesnesi.