Items - Create Digital Twin Builder

Service:: DigitalTwinBuilder

API Version:: v1

Creates a DigitalTwinBuilder in the specified workspace.

Note

Digital Twin Builder item is currently in Preview (learn more).

This API supports long running operations (LRO).

To create digitaltwinbuilder with definition, refer to DigitalTwinBuilder definition.

Permissions

The caller must have a contributor workspace role.

Required Delegated Scopes

DigitalTwinBuilder.ReadWrite.All or Item.ReadWrite.All

Limitations

To create a digitaltwinbuilder 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}/digitaltwinbuilders

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 digitaltwinbuilder display name. The display name must follow naming rules according to item type i.e., It should start with letter, only has numbers and letters or _ and is less than 100.
definition		DigitalTwinBuilderDefinition	The DigitalTwinBuilder public definition.
description		string	The digitaltwinbuilder description. Maximum length is 256 characters.

Responses

Name	Type	Description
201 Created	DigitalTwinBuilder	Successfully created
202 Accepted		Request accepted, digitaltwinbuilder 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

DigitalTwinBuilder

Successfully created

202 Accepted

Request accepted, digitaltwinbuilder 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 digitaltwinbuilder example

Create a digitaltwinbuilder with public definition example

Create a digitaltwinbuilder example

Sample request

HTTP

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

{
  "displayName": "DigitalTwinBuilder 1",
  "description": "A digitaltwinbuilder description."
}

Sample response

Status code:: 201

{
  "displayName": "DigitalTwinBuilder 1",
  "description": "A digitaltwinbuilder description.",
  "type": "DigitalTwinBuilder",
  "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 digitaltwinbuilder with public definition example

Sample request

HTTP

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

{
  "displayName": "DigitalTwinBuilder_1",
  "description": "An digitaltwinbuilder description.",
  "definition": {
    "parts": [
      {
        "path": "definition.json",
        "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:: 201

{
  "displayName": "DigitalTwinBuilder_1",
  "description": "An digitaltwinbuilder description.",
  "type": "DigitalTwinBuilder",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047655"
}

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
CreateDigitalTwinBuilderRequest	Create digitaltwinbuilder request payload.
DigitalTwinBuilder	An digitaltwinbuilder object.
DigitalTwinBuilderDefinition	DigitalTwinBuilder public definition object.
DigitalTwinBuilderDefinitionPart	DigitalTwinBuilder definition part object.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
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.

CreateDigitalTwinBuilderRequest

Object

Create digitaltwinbuilder request payload.

Name	Type	Description
definition	DigitalTwinBuilderDefinition	The DigitalTwinBuilder public definition.
description	string	The digitaltwinbuilder description. Maximum length is 256 characters.
displayName	string	The digitaltwinbuilder display name. The display name must follow naming rules according to item type i.e., It should start with letter, only has numbers and letters or _ and is less than 100.

DigitalTwinBuilder

Object

An digitaltwinbuilder 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.

DigitalTwinBuilderDefinition

Object

DigitalTwinBuilder public definition object.

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

DigitalTwinBuilderDefinitionPart

Object

DigitalTwinBuilder definition part object.

Name	Type	Description
path	string	The DigitalTwinBuilder part path.
payload	string	The DigitalTwinBuilder part payload.
payloadType	PayloadType	The payload type.

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.

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.

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 Digital Twin Builder

Permissions

Required Delegated Scopes

Limitations

Microsoft Entra supported identities

Interface

URI Parameters

Request Body

Responses

Examples

Create a digitaltwinbuilder example

Sample request

Sample response

Create a digitaltwinbuilder with public definition example

Sample request

Sample response

Definitions

CreateDigitalTwinBuilderRequest

DigitalTwinBuilder

DigitalTwinBuilderDefinition

DigitalTwinBuilderDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType