Items - Update Item Definition

Dienst:: Core

API-Version:: v1

Überschreibt die Definition für das angegebene Element.
Diese API wird für eine Reihe von Elementtypen unterstützt, finden Sie die unterstützten Elementtypen und Informationen zu ihrer Definitionsstruktur in der Elementdefinitionsübersicht. Das Aktualisieren der Elementdefinition wirkt sich nicht auf die Vertraulichkeitsbezeichnung aus.

Diese API unterstützt LRO-.

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für das Element besitzen.

Erforderliche delegierte Bereiche

Verwenden Sie für Element-APIs die folgenden Bereichstypen:

Allgemeiner Bereich: Item.ReadWrite.All
Bestimmter Bereich: itemType-. ReadWrite.All (z. B.: Notebook.ReadWrite.All)

weitere Informationen zu Bereichen finden Sie im Artikel Bereiche.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützung
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Wenn der Elementtyp im Anruf unterstützt wird. Überprüfen Sie die entsprechende API für den elementtyp, den Sie aufrufen, um festzustellen, ob Ihr Aufruf unterstützt wird. So werden z. B. semantische Modelle unterstützt.

Schnittstelle

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
itemId	path	True	string (uuid)	Die Element-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
updateMetadata	query		boolean	Wenn sie auf "true" festgelegt ist und die PLATTFORM-Datei als Teil der Definition bereitgestellt wird, werden die Metadaten des Elements mithilfe der Metadaten in der PLATTFORM-Datei aktualisiert.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
definition	True	ItemDefinition	Ein Elementdefinitionsobjekt.
options		object	Optionen für das Element, dessen Definition aktualisiert wird. Eigenschaftsnamen sind Optionsnamen, die für den Elementtyp gültig sind; Werte sind die Optionswerte. Die von einem bestimmten Elementtyp unterstützten Optionen finden Sie in der API-Dokumentation dieses Elementtyps `Update-Definition` .

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted		Anforderung angenommen. Die Updatedefinition wird ausgeführt. Header Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt. CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Update an item definition example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 200

Statuscode:: 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

Definitionen

Name	Beschreibung
ErrorParameter	Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ItemDefinition	Ein Elementdefinitionsobjekt.
ItemDefinitionPart	Ein Elementdefinitionsteilobjekt.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
UpdateItemDefinitionRequest	Aktualisieren der Elementdefinitionsanforderungsnutzlast.

ErrorParameter

Objekt

Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.

Name	Typ	Beschreibung
message	string	Eine lesbare Beschreibung der Bedeutung des Parameters.
name	string	Die Parameterkennung.
value	string	Der übergebene Wert

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
parameters	ErrorParameter[]	Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

ItemDefinition

Objekt

Ein Elementdefinitionsobjekt.

Name	Typ	Beschreibung
format	string	Das Format der Elementdefinition.
parts	ItemDefinitionPart[]	Eine Liste der Definitionsteile.

ItemDefinitionPart

Objekt

Ein Elementdefinitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Elementteilpfad.
payload	string	Die Nutzlast des Elementteils.
payloadType	PayloadType	Der Nutzlasttyp.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

UpdateItemDefinitionRequest

Objekt

Aktualisieren der Elementdefinitionsanforderungsnutzlast.

Name	Typ	Beschreibung
definition	ItemDefinition	Ein Elementdefinitionsobjekt.
options	object	Optionen für das Element, dessen Definition aktualisiert wird. Eigenschaftsnamen sind Optionsnamen, die für den Elementtyp gültig sind; Werte sind die Optionswerte. Die von einem bestimmten Elementtyp unterstützten Optionen finden Sie in der API-Dokumentation dieses Elementtyps `Update-Definition` .