Items - Create Graph Model

Service:: GraphModel

API Version:: v1

Creates a GraphModel in the specified workspace.

Note

GraphModel item is currently in Preview (learn more).

This API supports long running operations (LRO).

To create GraphModel with a public definition, refer to GraphModel article.

Permissions

The caller must have a contributor workspace role.

Required Delegated Scopes

Item.ReadWrite.All

Limitations

To create a GraphModel the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphModels

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string (uuid)	The workspace ID.

Request Body

Name	Required	Type	Description
displayName	True	string	The GraphModel display name. The display name must follow naming rules according to item type.
definition		GraphModelPublicDefinition	The GraphModel public definition.
description		string	The GraphModel description. Maximum length is 256 characters.
folderId		string (uuid)	The folder ID. If not specified or null, the GraphModel is created with the workspace as its folder.

Responses

Name	Type	Description
201 Created	GraphModel	Successfully created
202 Accepted		Request accepted, GraphModel provisioning in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: InvalidItemType - Item type is invalid ItemDisplayNameAlreadyInUse - Item display name is already used. CorruptedPayload - The provided payload is corrupted. WorkspaceItemsLimitExceeded - Workspace item limit exceeded.

Name

Type

Description

201 Created

GraphModel

Successfully created

202 Accepted

Request accepted, GraphModel provisioning in progress.

Headers

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Common error codes:

InvalidItemType - Item type is invalid
ItemDisplayNameAlreadyInUse - Item display name is already used.
CorruptedPayload - The provided payload is corrupted.
WorkspaceItemsLimitExceeded - Workspace item limit exceeded.

Examples

Create a GraphModel example

Create a GraphModel with public definition example

Create a GraphModel example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GraphModels

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description."
}

Sample response

Status code:: 201

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "type": "GraphModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a GraphModel with public definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GraphModels

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "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"
      }
    ]
  }
}

Sample response

Status code:: 201

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "type": "GraphModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitions

Name	Description
CreateGraphModelRequest	Create GraphModel request payload.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GraphModel	A GraphModel object.
GraphModelDefinitionFormat	The format of the item definition. Additional `format` types may be added over time.
GraphModelPublicDefinition	GraphModel public definition object. Refer to this article for more details on how to craft a GraphModel public definition.
GraphModelPublicDefinitionPart	GraphModel definition part object.
ItemTag	Represents a tag applied on an item.
ItemType	The type of the item. Additional item types may be added over time.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.

CreateGraphModelRequest

Object

Create GraphModel request payload.

Name	Type	Description
definition	GraphModelPublicDefinition	The GraphModel public definition.
description	string	The GraphModel description. Maximum length is 256 characters.
displayName	string	The GraphModel display name. The display name must follow naming rules according to item type.
folderId	string (uuid)	The folder ID. If not specified or null, the GraphModel is created with the workspace as its folder.

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.

GraphModel

Object

A GraphModel object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
folderId	string (uuid)	The folder ID.
id	string (uuid)	The item ID.
tags	ItemTag[]	List of applied tags.
type	ItemType	The item type.
workspaceId	string (uuid)	The workspace ID.

GraphModelDefinitionFormat

Enumeration

The format of the item definition. Additional format types may be added over time.

Value	Description
json	JSON format for the GraphModel public definition, specifically designed to support CI/CD scenarios in Fabric.

GraphModelPublicDefinition

Object

GraphModel public definition object. Refer to this article for more details on how to craft a GraphModel public definition.

Name	Type	Description
format	GraphModelDefinitionFormat	The format of the item definition. Additional `format` types may be added over time.
parts	GraphModelPublicDefinitionPart[]	A list of definition parts.

GraphModelPublicDefinitionPart

Object

GraphModel definition part object.

Name	Type	Description
path	string	The GraphModel public definition part path.
payload	string	The GraphModel public definition part payload.
payloadType	PayloadType	The payload type.

ItemTag

Object

Represents a tag applied on an item.

Name	Type	Description
displayName	string	The name of the tag.
id	string (uuid)	The tag ID.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value	Description
Dashboard	PowerBI dashboard.
Report	PowerBI report.
SemanticModel	PowerBI semantic model.
PaginatedReport	PowerBI paginated report.
Datamart	PowerBI datamart.
Lakehouse	A lakehouse.
Eventhouse	An eventhouse.
Environment	An environment.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
KQLDashboard	A KQL dashboard.
DataPipeline	A data pipeline.
Notebook	A notebook.
SparkJobDefinition	A spark job definition.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
Warehouse	A warehouse.
Eventstream	An eventstream.
SQLEndpoint	An SQL endpoint.
MirroredWarehouse	A mirrored warehouse.
MirroredDatabase	A mirrored database.
Reflex	A Reflex.
GraphQLApi	An API for GraphQL item.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	A Copy job.
VariableLibrary	A VariableLibrary.
Dataflow	A Dataflow.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	A Warehouse snapshot.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	A mirrored azure databricks catalog.
Map	A Map.
AnomalyDetector	An Anomaly Detector.
UserDataFunction	A User Data Function.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	A Snowflake Database to store Iceberg tables created from Snowflake account.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	A Cosmos DB Database.
Ontology	An Ontology.
EventSchemaSet	An EventSchemaSet.

PayloadType

Enumeration

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

Value	Description
InlineBase64	Inline Base 64.

Share via

Items - Create Graph Model

Permissions

Required Delegated Scopes

Limitations

Microsoft Entra supported identities

Interface

URI Parameters

Request Body

Responses

Examples

Create a GraphModel example

Sample request

Sample response

Create a GraphModel with public definition example

Sample request

Sample response

Definitions

CreateGraphModelRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModel

GraphModelDefinitionFormat

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

ItemTag

ItemType

PayloadType