Items - Update GraphQLApi Definition

Service:

GraphQLApi

API Version:

v1

Overrides the definition for the specified API for GraphQL.

This API supports long running operations (LRO).

Updating the GraphQLApi's definition, does not affect its sensitivity label.

Permissions

The caller must have read and write permissions for the GraphQLApi.

Required Delegated Scopes

GraphQLApi.ReadWrite.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/updateDefinition

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
GraphQLApiId	path	True	string (uuid)	The GraphQLApi ID.
workspaceId	path	True	string (uuid)	The workspace ID.
updateMetadata	query		boolean	When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the .platform file

Request Body

Name	Required	Type	Description
definition	True	GraphQLApiPublicDefinition	API for GraphQL public definition object. To create the definition, see GraphQLApi definition.

Responses

Name	Type	Description
200 OK		Request completed successfully.
202 Accepted		Request accepted. Update definition is in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item. CorruptedPayload - The provided payload is corrupted.

Examples

Update a GraphQLApi public definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GraphQLApis/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "graphql-definition.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:

200

Status code:

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

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GraphQLApiPublicDefinition	API for GraphQL public definition object. To create the definition, see GraphQLApi definition.
GraphQLApiPublicDefinitionPart	API for GraphQL definition part object.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.
UpdateGraphQLApiDefinitionRequest	Update API for GraphQL public definition request payload.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

GraphQLApiPublicDefinition

Object

API for GraphQL public definition object. To create the definition, see GraphQLApi definition.

Name	Type	Description
format	string	The format of the item definition.
parts	GraphQLApiPublicDefinitionPart[]	A list of definition parts.

GraphQLApiPublicDefinitionPart

Object

API for GraphQL definition part object.

Name	Type	Description
path	string	The API for GraphQL definition part path.
payload	string	The API for GraphQL definition part payload.
payloadType	PayloadType	The payload type.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value	Description
InlineBase64	Inline Base 64.

UpdateGraphQLApiDefinitionRequest

Object

Update API for GraphQL public definition request payload.

Name	Type	Description
definition	GraphQLApiPublicDefinition	API for GraphQL public definition object. To create the definition, see GraphQLApi definition.