Partager via

Items - Update Item Definition

Service:
Core
Version d'API:
v1

Remplace la définition de l’élément spécifié.
Cette API est prise en charge pour un certain nombre de types d’éléments, recherchez les types d’éléments pris en charge et les informations sur leur structure de définition dans la vue d’ensemble de la définition d’élément. La mise à jour de la définition de l’élément n’affecte pas son étiquette de confidentialité.

Cette API prend en charge opérations longues (LRO).

Autorisations

L’appelant doit disposer d’autorisations de lecture et d’écriture pour l’élément.

Étendues déléguées requises

Pour les API d’élément, utilisez ces types d’étendue :

  • Étendue générique : Item.ReadWrite.All
  • Étendue spécifique : itemType. ReadWrite.All (par exemple : Notebook.ReadWrite.All)

pour plus d’informations sur les étendues, consultez article sur les étendues.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
Service principal et identités gérées Lorsque le type d’élément dans l’appel est pris en charge. Vérifiez l’API correspondante pour le type d’élément que vous appelez pour voir si votre appel est pris en charge. Par exemple, les modèles sémantiques sont pris en charge.

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition
Avec des paramètres facultatifs: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition?updateMetadata={updateMetadata}

Paramètres URI

Nom Dans Obligatoire Type Description
itemId
 path True

string (uuid)

ID d’élément.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.
updateMetadata
 query

boolean

Lorsque la valeur est true et que le fichier .platform est fourni dans le cadre de la définition, les métadonnées de l’élément sont mises à jour à l’aide des métadonnées dans le fichier .platform

Corps de la demande

Nom Obligatoire Type Description
definition True

ItemDefinition

Objet de définition d’élément.

Réponses

Nom Type Description
200 OK

La demande s’est terminée avec succès.
202 Accepted

Demande acceptée. La définition de mise à jour est en cours.

En-têtes

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

ErrorResponse

Codes d’erreur courants :

  • OperationNotSupportedForItem : opération non prise en charge pour l’élément demandé.

  • CorruptedPayload : la charge utile fournie est endommagée.

Exemples

Update an item definition example

Exemple de requête

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

Exemple de réponse

Code d’état:
200
Code d’état:
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

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
ItemDefinition

Objet de définition d’élément.
ItemDefinitionPart

Objet de partie définition d’élément.
PayloadType

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.
UpdateItemDefinitionRequest

Mettre à jour la charge utile de la demande de définition d’élément.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

ItemDefinition

Object

Objet de définition d’élément.

Nom Type Description
format

string

Format de la définition d’élément.
parts

ItemDefinitionPart[]

Liste des parties de définition.

ItemDefinitionPart

Object

Objet de partie définition d’élément.

Nom Type Description
path

string

Chemin d’accès de la partie élément.
payload

string

Charge utile de la partie élément.
payloadType

PayloadType

Type de charge utile.

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
InlineBase64

Base 64 inline.

UpdateItemDefinitionRequest

Object

Mettre à jour la charge utile de la demande de définition d’élément.

Nom Type Description
definition

ItemDefinition

Objet de définition d’élément.