Items - Get Item Definition

Tjeneste:: Core

API-versjon:: v1

Returnerer den angitte elementdefinisjonen.
Denne API-en støttes for en rekke elementtyper, finner de støttede elementtypene og informasjon om definisjonsstrukturen i elementdefinisjonsoversikten. Når du får definisjonen for et element, er ikke følsomhetsetiketten en del av definisjonen.

Denne API-en støtter langvarige operasjoner (LRO).

Tillatelser

Innringeren må ha lese- og skrivetillatelser for elementet.

Nødvendige delegerte omfang

For element-API-er bruker du disse omfangstypene:

Generelt omfang: Item.ReadWrite.All
Bestemt omfang: itemType. ReadWrite.All (for eksempel: Notebook.ReadWrite.All)

Hvis du vil ha mer informasjon om omfang, kan du se omfangsartikkelen.

Begrensninger

Hvis du vil hente definisjonen av et element som er beskyttet av en kryptert følsomhetsetikett, må innringeren ha tilstrekkelige bruksrettigheter til å fjerne etiketten, som konfigurert i Microsoft Purview.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Når elementtypen i samtalen støttes. Kontroller den tilsvarende API-en for elementtypen du ringer, for å se om samtalen støttes. Semantiske modeller støttes for eksempel.

Grensesnitt

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

Med valgfrie parametere:

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

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
itemId	path	True	string (uuid)	Element-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.
format	query		string	Formatet for elementdefinisjonen.

Svar

Name	Type	Beskrivelse
200 OK	ItemDefinitionResponse	Forespørselen er fullført.
202 Accepted		Forespørselen er godtatt. Henting av definisjonen pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: OperationNotSupportedForItem – operasjonen støttes ikke for forespurt element.

Eksempler

Get an item definition example

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:: 200

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

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

Definisjoner

Name	Beskrivelse
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ItemDefinition	Et elementdefinisjonsobjekt.
ItemDefinitionPart	Et elementdefinisjonsdelobjekt.
ItemDefinitionResponse	Svar på offentlig elementdefinisjon.
PayloadType	Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ItemDefinition

Objekt

Et elementdefinisjonsobjekt.

Name	Type	Beskrivelse
format	string	Formatet for elementdefinisjonen.
parts	ItemDefinitionPart[]	En liste over definisjonsdeler.

ItemDefinitionPart

Objekt

Et elementdefinisjonsdelobjekt.

Name	Type	Beskrivelse
path	string	Elementdelbanen.
payload	string	Nyttelasten for elementdelen.
payloadType	PayloadType	Nyttelasttypen.

ItemDefinitionResponse

Objekt

Svar på offentlig elementdefinisjon.

Name	Type	Beskrivelse
definition	ItemDefinition	Et elementdefinisjonsobjekt.

PayloadType

Opplisting

Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

Verdi	Beskrivelse
InlineBase64	Innebygd grunntall 64.