Items - Get Item Definition

Dienst:

Core

API-Version:

v1

Gibt die angegebene Elementdefinition zurück.
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. Wenn Sie die Definition eines Elements erhalten, ist die Vertraulichkeitsbezeichnung kein Bestandteil der Definition.

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".

Einschränkungen

Diese API wird für ein Element mit einer geschützten Vertraulichkeitsbezeichnung blockiert, es sei denn, der Aufrufer verfügt über die Nutzungsrechte zum Löschen der Vertraulichkeitsbezeichnung.

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}/getDefinition

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
itemId	path	True	string (uuid)	Die Element-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
format	query		string	Das Format der Elementdefinition.

Antworten

Name	Typ	Beschreibung
200 OK	ItemDefinitionResponse	Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted		Anforderung angenommen. Das Abrufen der Definition wird ausgeführt. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.

Beispiele

Get an item definition example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Beispiel für eine Antwort

Statuscode:

200

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

Statuscode:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ItemDefinition	Ein Elementdefinitionsobjekt.
ItemDefinitionPart	Ein Elementdefinitionsteilobjekt.
ItemDefinitionResponse	Antwort auf die öffentliche Elementdefinition.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

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.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	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.
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.

ItemDefinitionResponse

Objekt

Antwort auf die öffentliche Elementdefinition.

Name	Typ	Beschreibung
definition	ItemDefinition	Ein Elementdefinitionsobjekt.

PayloadType

Enumeration

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

Wert	Beschreibung
InlineBase64	Inlinebasis 64.