Items - Get Item Definition

Tjeneste:

Core

API-version:

v1

Returnerer den angivne elementdefinition.
Denne API understøttes for en række elementtyper. Find de understøttede elementtyper og oplysninger om deres definitionsstruktur i oversigt over elementdefinitioner. Når du henter definitionen af et element, er følsomhedsmærkaten ikke en del af definitionen.

Denne API understøtter LRO-handlinger (Long Running Operations).

Tilladelser

Den, der ringer op, skal have læse- og skriverettigheder til elementet.

Påkrævede delegerede områder

For element-API'er skal du bruge disse områdetyper:

• Standardområde: Item.ReadWrite.All
• Bestemt område: itemType. ReadWrite.All (f.eks. Notebook.ReadWrite.All)

Du kan få flere oplysninger om områder i artiklen Områder.

Begrænsninger

Denne API er blokeret for et element med en beskyttet følsomhedsmærkat, medmindre kalderen har brugsrettigheder til at slette følsomhedsmærkaten.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Når elementtypen i opkaldet understøttes. Kontrollér den tilsvarende API for den elementtype, du ringer til, for at se, om dit opkald understøttes. Semantiske modeller understøttes f.eks.

Grænseflade

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

Med valgfrie parametre:

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
itemId	path	True	string (uuid)	Element-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
format	query		string	Formatet af elementdefinitionen.

Svar

Name	Type	Beskrivelse
200 OK	ItemDefinitionResponse	Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Hentning af definitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element.

Eksempler

Get an item definition example

Eksempelanmodning

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

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemDefinition	Et elementdefinitionsobjekt.
ItemDefinitionPart	Et elementdefinitionsdelobjekt.
ItemDefinitionResponse	Svar på offentlig definition af element.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ItemDefinition

Object

Et elementdefinitionsobjekt.

Name	Type	Beskrivelse
format	string	Formatet af elementdefinitionen.
parts	ItemDefinitionPart[]	En liste over definitionsdele.

ItemDefinitionPart

Object

Et elementdefinitionsdelobjekt.

Name	Type	Beskrivelse
path	string	Stien til elementdelen.
payload	string	Nyttedata for elementdelen.
payloadType	PayloadType	Nyttedatatypen.

ItemDefinitionResponse

Object

Svar på offentlig definition af element.

Name	Type	Beskrivelse
definition	ItemDefinition	Et elementdefinitionsobjekt.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.