Items - Update Digital Twin Builder Definition

Serviço:

DigitalTwinBuilder

Versão da API:

v1

Observação

Esta API está na versão prévia.

Atualiza a definição de um DigitalTwinBuilder especificado. A atualização substitui a definição atual.
Essa API dá suporte a LRO (operações de execução longa).

Atualizar a definição do digitaltwinbuilder não afeta seu rótulo de confidencialidade.

Permissões

O chamador deve ter permissões de leitura e gravação para o construtor de gêmeos digitais.

Escopos delegados necessários

DigitalTwinBuilder.ReadWrite.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades gerenciadas	Não

Interfase

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
digitaltwinbuilderId	path	True	string (uuid)	A ID do digitaltwinbuilder.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.
updateMetadata	query		boolean	Se os metadados do item serão atualizados se forem fornecidos no .platform arquivo. True - Atualize os metadados se ele for fornecido no .platform arquivo como parte da definição, False – Não atualize os metadados.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
definition	True	DigitalTwinBuilderDefinition	Objeto de definição pública DigitalTwinBuilder.

Respostas

Nome	Tipo	Description
200 OK		Solicitação concluída com êxito.
202 Accepted		Solicitação aceita. A definição de atualização está em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: OperationNotSupportedForItem – Operação sem suporte para o item solicitado. CorruptedPayload – O conteúdo fornecido está corrompido.

Exemplos

Update a digitaltwinbuilder definition example

Solicitação de exemplo

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"
      }
    ]
  }
}

Resposta de exemplo

Código de status:

200

Código de status:

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

Definições

Nome	Description
DigitalTwinBuilderDefinition	Objeto de definição pública DigitalTwinBuilder.
DigitalTwinBuilderDefinitionPart	Objeto da parte de definição do DigitalTwinBuilder.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
PayloadType	O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.
UpdateDigitalTwinBuilderDefinitionRequest	Atualize o conteúdo da solicitação de definição pública do digitaltwinbuilder.

DigitalTwinBuilderDefinition

Objeto

Objeto de definição pública DigitalTwinBuilder.

Nome	Tipo	Description
format	string	O formato da definição do item.
parts	DigitalTwinBuilderDefinitionPart[]	Uma lista de partes de definição.

DigitalTwinBuilderDefinitionPart

Objeto

Objeto da parte de definição do DigitalTwinBuilder.

Nome	Tipo	Description
path	string	O caminho da parte DigitalTwinBuilder.
payload	string	O conteúdo da parte DigitalTwinBuilder.
payloadType	PayloadType	O tipo de conteúdo.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
InlineBase64	Base 64 embutida.

UpdateDigitalTwinBuilderDefinitionRequest

Objeto

Atualize o conteúdo da solicitação de definição pública do digitaltwinbuilder.

Nome	Tipo	Description
definition	DigitalTwinBuilderDefinition	Objeto de definição pública DigitalTwinBuilder.