Delen via

Items - Update Item Definition

Service:
Core
API-versie:
v1

Hiermee wordt de definitie voor het opgegeven item overschreven.
Deze API wordt ondersteund voor een aantal itemtypen, zoek de ondersteunde itemtypen en informatie over hun definitiestructuur in het overzicht van itemdefinities. Het bijwerken van de definitie van het item heeft geen invloed op het vertrouwelijkheidslabel.

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 bereikenvoor meer informatie over bereiken.

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}/updateDefinition
Met optionele parameters: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition?updateMetadata={updateMetadata}

URI-parameters

Name In Vereist Type Description
itemId
 path True

string (uuid)

De item-id.
workspaceId
 path True

string (uuid)

De werkruimte-ID.
updateMetadata
 query

boolean

Als deze is ingesteld op true en het .platform-bestand wordt opgegeven als onderdeel van de definitie, worden de metagegevens van het item bijgewerkt met behulp van de metagegevens in het PLATFORM-bestand

Aanvraagbody

Name Vereist Type Description
definition True

ItemDefinition

Een itemdefinitieobject.

Antwoorden

Name Type Description
200 OK

De aanvraag is voltooid.
202 Accepted

Aanvraag geaccepteerd. De definitie van de update 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.

  • CorruptedPayload: de opgegeven nettolading is beschadigd.

Voorbeelden

Update an item definition example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
ItemDefinition

Een itemdefinitieobject.
ItemDefinitionPart

Een itemdefinitieonderdeelobject.
PayloadType

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

De nettolading van de itemdefinitieaanvraag bijwerken.

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.

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.

UpdateItemDefinitionRequest

Object

De nettolading van de itemdefinitieaanvraag bijwerken.

Name Type Description
definition

ItemDefinition

Een itemdefinitieobject.