Items - Update Graph Model Definition
Remplace la définition du GraphModel spécifié.
Note
L’élément GraphModel est actuellement en préversion (en savoir plus).
Cette API prend en charge opérations longues (LRO).
La mise à jour de la définition de GraphModel n’affecte pas son étiquette de confidentialité.
Permissions
L’appelant doit disposer d’autorisations de lecture et d’écriture pour GraphModel.
Étendues déléguées requises
Item.ReadWrite.All
Microsoft Entra identités prises en charge
Cette API prend en charge les identités Microsoft répertoriées dans cette section.
| Identité | Support |
|---|---|
| Utilisateur | Oui |
| Service principal et identités gérées | Oui |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/updateDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/updateDefinition?updateMetadata={updateMetadata}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
graph
|
path | True |
string (uuid) |
ID GraphModel. |
|
workspace
|
path | True |
string (uuid) |
Identifiant de l’espace de travail. |
|
update
|
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 |
Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article . |
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
|
|
| 429 Too Many Requests |
La limite de débit de service a été dépassée. Le serveur retourne un En-têtes Retry-After: integer |
|
| Other Status Codes |
Codes d’erreur courants :
|
Exemples
Update a GraphModel public definition example
Exemple de requête
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/graphModels/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True
{
"definition": {
"format": "json",
"parts": [
{
"path": "graphType.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "graphDefinition.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "dataSources.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": "stylingConfiguration.json",
"payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
Exemple de réponse
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 |
|---|---|
|
Error |
Objet de détails de ressource associé à l’erreur. |
|
Error |
Réponse d’erreur. |
|
Error |
Détails de la réponse d’erreur. |
|
Graph |
Format de la définition d’élément. Des types |
|
Graph |
Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article . |
|
Graph |
Objet de partie de définition GraphModel. |
|
Payload |
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. |
|
Update |
Mettre à jour la charge utile de demande de définition publique GraphModel. |
ErrorRelatedResource
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
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 |
Liste des détails d’erreur supplémentaires. |
|
| relatedResource |
Détails de la ressource associée à l’erreur. |
|
| requestId |
string (uuid) |
ID de la demande associée à l’erreur. |
ErrorResponseDetails
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 |
Détails de la ressource associée à l’erreur. |
GraphModelDefinitionFormat
Format de la définition d’élément. Des types format supplémentaires peuvent être ajoutés au fil du temps.
| Valeur | Description |
|---|---|
| json |
Format JSON pour la définition publique GraphModel, spécifiquement conçu pour prendre en charge les scénarios CI/CD dans Fabric. |
GraphModelPublicDefinition
Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article .
| Nom | Type | Description |
|---|---|---|
| format |
Format de la définition d’élément. Des types |
|
| parts |
Liste des parties de définition. |
GraphModelPublicDefinitionPart
Objet de partie de définition GraphModel.
| Nom | Type | Description |
|---|---|---|
| path |
string |
Chemin du composant de définition publique GraphModel. |
| payload |
string |
Charge utile du composant de définition publique GraphModel. |
| payloadType |
Type de charge utile. |
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.
| Valeur | Description |
|---|---|
| InlineBase64 |
Base 64 inline. |
UpdateGraphModelDefinitionRequest
Mettre à jour la charge utile de demande de définition publique GraphModel.
| Nom | Type | Description |
|---|---|---|
| definition |
Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article . |