Delen via

Items - Get Item Definition

Service:
Core
API-versie:
v1

Retourneert de opgegeven itemdefinitie.
Deze API wordt ondersteund voor een aantal itemtypen, zoek de ondersteunde itemtypen en informatie over hun definitiestructuur in het overzicht van itemdefinities. Wanneer u de definitie van een item krijgt, maakt het vertrouwelijkheidslabel geen deel uit van de definitie.

Deze API ondersteunt langlopende bewerkingen (LRO).

Machtigingen

De aanroeper moet lees- en schrijfmachtigingen voor het item hebben.

Vereiste gedelegeerde bereiken

Voor item-API's worden deze bereiktypen gebruikt:

  • Algemeen bereik: Item.ReadWrite.All
  • Specifiek bereik: itemType. ReadWrite.All (bijvoorbeeld: Notebook.ReadWrite.All)

Zie het artikel Scopes voor meer informatie over bereiken.

Beperkingen

Deze API wordt geblokkeerd voor een item met een beveiligd vertrouwelijkheidslabel, tenzij de aanroeper de gebruiksrechten heeft om het vertrouwelijkheidslabel te verwijderen.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit Ondersteuning
Gebruiker Ja
serviceprincipal en beheerde identiteiten Wanneer het itemtype in de aanroep wordt ondersteund. Controleer de bijbehorende API voor het itemtype dat u aanroept om te zien of uw aanroep wordt ondersteund. Semantische modellen worden bijvoorbeeld ondersteund.

gebruikersinterface

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

URI-parameters

Name In Vereist Type Description
itemId
 path True

string (uuid)

De item-id.
workspaceId
 path True

string (uuid)

De werkruimte-ID.
format
 query

string

De indeling van de itemdefinitie.

Antwoorden

Name Type Description
200 OK

ItemDefinitionResponse

De aanvraag is voltooid.
202 Accepted

Aanvraag geaccepteerd. Het ophalen van de definitie wordt uitgevoerd.

Kopteksten

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • OperationNotSupportedForItem - Bewerking wordt niet ondersteund voor aangevraagd item.

Voorbeelden

Get an item definition example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
ItemDefinition

Een itemdefinitieobject.
ItemDefinitionPart

Een itemdefinitieonderdeelobject.
ItemDefinitionResponse

Antwoord van openbare definitie van item.
PayloadType

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

ItemDefinition

Object

Een itemdefinitieobject.

Name Type Description
format

string

De indeling van de itemdefinitie.
parts

ItemDefinitionPart[]

Een lijst met definitieonderdelen.

ItemDefinitionPart

Object

Een itemdefinitieonderdeelobject.

Name Type Description
path

string

Het pad van het itemonderdeel.
payload

string

De nettolading van het itemonderdeel.
payloadType

PayloadType

Het nettoladingstype.

ItemDefinitionResponse

Object

Antwoord van openbare definitie van item.

Name Type Description
definition

ItemDefinition

Een itemdefinitieobject.

PayloadType

Inventarisatie

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde Description
InlineBase64

Inline base 64.