Udostępnij przez

Items - Update Digital Twin Builder Definition

Usługa:
DigitalTwinBuilder
Wersja interfejsu API:
v1

Aktualizuje definicję określonego obiektu DigitalTwinBuilder. Aktualizacja zastępuje bieżącą definicję.

Note

Element usługi Digital Twin Builder jest obecnie dostępny w wersji zapoznawczej (dowiedz się więcej).

Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aktualizowanie definicji elementu digitaltwinbuilder nie ma wpływu na jego etykietę poufności.

Permissions

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla konstruktora cyfrowej reprezentacji bliźniaczej.

Wymagane zakresy delegowane

DigitalTwinBuilder.ReadWrite.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane No

Interface

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
digitaltwinbuilderId
 path True

string (uuid)

Identyfikator digitaltwinbuilder.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
updateMetadata
 query

boolean

Czy zaktualizować metadane elementu, jeśli zostały podane w .platform pliku. True — zaktualizuj metadane, jeśli są podane w pliku w .platform ramach definicji, False — nie aktualizuj metadanych.

Treść żądania

Nazwa Wymagane Typ Opis
definition True

DigitalTwinBuilderDefinition

Obiekt definicji publicznej DigitalTwinBuilder.

Odpowiedzi

Nazwa Typ Opis
200 OK

Żądanie zostało ukończone pomyślnie.
202 Accepted

Zaakceptowano żądanie. Trwa aktualizowanie definicji.

Nagłówki

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

  • CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

Update a digitaltwinbuilder definition example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200
Kod stanu:
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

Definicje

Nazwa Opis
DigitalTwinBuilderDefinition

Obiekt definicji publicznej DigitalTwinBuilder.
DigitalTwinBuilderDefinitionPart

Obiekt części definicji DigitalTwinBuilder.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
PayloadType

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
UpdateDigitalTwinBuilderDefinitionRequest

Zaktualizuj ładunek żądania definicji publicznej digitaltwinbuilder.

DigitalTwinBuilderDefinition

Objekt

Obiekt definicji publicznej DigitalTwinBuilder.

Nazwa Typ Opis
format

string

Format definicji elementu.
parts

DigitalTwinBuilderDefinitionPart[]

Lista części definicji.

DigitalTwinBuilderDefinitionPart

Objekt

Obiekt części definicji DigitalTwinBuilder.

Nazwa Typ Opis
path

string

Ścieżka części DigitalTwinBuilder.
payload

string

Ładunek części DigitalTwinBuilder.
payloadType

PayloadType

Typ ładunku.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

PayloadType

Wyliczanie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość Opis
InlineBase64

Śródliniowa baza 64.

UpdateDigitalTwinBuilderDefinitionRequest

Objekt

Zaktualizuj ładunek żądania definicji publicznej digitaltwinbuilder.

Nazwa Typ Opis
definition

DigitalTwinBuilderDefinition

Obiekt definicji publicznej DigitalTwinBuilder.