Items - Update Digital Twin Builder Definition

Service:

DigitalTwinBuilder

API Version:

v1

Note

This API is in preview.

Updates the definition of a specified DigitalTwinBuilder. The update overrides the current definition.
This API supports long running operations (LRO).

Updating the digitaltwinbuilder definition, does not affect its sensitivity label.

Permissions

The caller must have read and write permissions for the digital twin builder.

Required Delegated Scopes

DigitalTwinBuilder.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	No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/digitaltwinbuilders/{digitaltwinbuilderId}/updateDefinition

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
digitaltwinbuilderId	path	True	string (uuid)	The digitaltwinbuilder ID.
workspaceId	path	True	string (uuid)	The workspace ID.
updateMetadata	query		boolean	Whether to update the item's metadata if it is provided in the .platform file. True - Update the metadata if it is provided in the .platform file as part of the definition, False - Do not update the metadata.

Request Body

Name	Required	Type	Description
definition	True	DigitalTwinBuilderDefinition	DigitalTwinBuilder public definition object.

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 digitaltwinbuilder definition example

Sample request

HTTP

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

{
  "definition": {
    "parts": [
      {
        "path": "definition.json",
        "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:

200

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
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.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.
UpdateDigitalTwinBuilderDefinitionRequest	Update digitaltwinbuilder public definition request payload.

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.

PayloadType

Enumeration

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

Value	Description
InlineBase64	Inline Base 64.

UpdateDigitalTwinBuilderDefinitionRequest

Object

Update digitaltwinbuilder public definition request payload.

Name	Type	Description
definition	DigitalTwinBuilderDefinition	DigitalTwinBuilder public definition object.