Items - Update Item Definition

Tjeneste:: Core

API-version:: v1

Tilsidesætter definitionen for det angivne element.
Denne API understøttes for en række elementtyper. Find de understøttede elementtyper og oplysninger om deres definitionsstruktur i oversigt over elementdefinitioner. Opdatering af elementets definition påvirker ikke dets følsomhedsmærkat.

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 om områder.

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

Med valgfrie parametre:

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
itemId	path	True	string (uuid)	Element-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
updateMetadata	query		boolean	Når den er angivet til true, og .platform-filen er angivet som en del af definitionen, opdateres elementets metadata ved hjælp af metadataene i .platform-filen

Brødtekst for anmodning

Navn	Påkrævet	Type	Beskrivelse
definition	True	ItemDefinition	Et elementdefinitionsobjekt.
options		object	Indstillinger for det element, hvis definition opdateres. Egenskabsnavne er navne på indstillinger, der er gyldige for elementtypen. værdier er indstillingsværdierne. Du kan se de indstillinger, der understøttes af en bestemt elementtype, i denne elementtypes `Update-Definition` API-dokumentation.

Svar

Navn	Type	Beskrivelse
200 OK		Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Opdateringsdefinitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element. CorruptedPayload – Den angivne nyttedata er beskadiget.

Eksempler

Update an item definition example

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:: 200

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

Definitioner

Navn	Beskrivelse
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemDefinition	Et elementdefinitionsobjekt.
ItemDefinitionPart	Et elementdefinitionsdelobjekt.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
UpdateItemDefinitionRequest	Opdater nyttedata for anmodning om definition af element.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

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

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	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.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ItemDefinition

Objekt

Et elementdefinitionsobjekt.

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

ItemDefinitionPart

Objekt

Et elementdefinitionsdelobjekt.

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

PayloadType

Optælling

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

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

UpdateItemDefinitionRequest

Objekt

Opdater nyttedata for anmodning om definition af element.

Navn	Type	Beskrivelse
definition	ItemDefinition	Et elementdefinitionsobjekt.
options	object	Indstillinger for det element, hvis definition opdateres. Egenskabsnavne er navne på indstillinger, der er gyldige for elementtypen. værdier er indstillingsværdierne. Du kan se de indstillinger, der understøttes af en bestemt elementtype, i denne elementtypes `Update-Definition` API-dokumentation.