Items - Update Item Definition

Usługa:: Core

Wersja interfejsu API:: v1

Zastępuje definicję określonego elementu.
Ten interfejs API jest obsługiwany w przypadku wielu typów elementów, znajdź obsługiwane typy elementów i informacje o ich strukturze definicji w temacie Omówienie definicji elementu. Aktualizowanie definicji elementu nie ma wpływu na etykietę poufności.

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

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla elementu.

Wymagane zakresy delegowane

W przypadku interfejsów API elementów użyj następujących typów zakresów:

Zakres ogólny: Item.ReadWrite.All
Określony zakres: itemType. ReadWrite.All (na przykład: Notebook.ReadWrite.All)

Aby uzyskać więcej informacji na temat zakresów, zobacz artykuł zakresy.

Tożsamości obsługiwane przez Microsoft Entra

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

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Gdy typ elementu w wywołaniu jest obsługiwany. Sprawdź odpowiedni interfejs API dla wywoływanego typu elementu, aby sprawdzić, czy wywołanie jest obsługiwane. Na przykład modele semantyczne są obsługiwane.

Interfejs

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
itemId	path	True	string (uuid)	Identyfikator elementu.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
updateMetadata	query		boolean	W przypadku ustawienia wartości true i pliku platformy w ramach definicji metadane elementu są aktualizowane przy użyciu metadanych w pliku platformy .

Treść żądania

Nazwa	Wymagane	Typ	Opis
definition	True	ItemDefinition	Obiekt definicji elementu.
options		object	Opcje elementu, którego definicja jest aktualizowana. Nazwy właściwości są nazwami opcji prawidłowymi dla typu elementu; wartości to wartości opcji. Aby uzyskać opcje obsługiwane przez określony typ elementu, zobacz dokumentację interfejsu `Update-Definition` API tego typu elementu.

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
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki 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 an item definition example

Przykładowe żądanie

HTTP

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

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "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/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definicje

Nazwa	Opis
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ItemDefinition	Obiekt definicji elementu.
ItemDefinitionPart	Obiekt części definicji elementu.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
UpdateItemDefinitionRequest	Zaktualizuj ładunek żądania definicji elementu.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwa	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

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.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	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.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

ItemDefinition

Objekt

Obiekt definicji elementu.

Nazwa	Typ	Opis
format	string	Format definicji elementu.
parts	ItemDefinitionPart[]	Lista części definicji.

ItemDefinitionPart

Objekt

Obiekt części definicji elementu.

Nazwa	Typ	Opis
path	string	Ścieżka części elementu.
payload	string	Ładunek części elementu.
payloadType	PayloadType	Typ ładunku.

PayloadType

Wyliczenie

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

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

UpdateItemDefinitionRequest

Objekt

Zaktualizuj ładunek żądania definicji elementu.

Nazwa	Typ	Opis
definition	ItemDefinition	Obiekt definicji elementu.
options	object	Opcje elementu, którego definicja jest aktualizowana. Nazwy właściwości są nazwami opcji prawidłowymi dla typu elementu; wartości to wartości opcji. Aby uzyskać opcje obsługiwane przez określony typ elementu, zobacz dokumentację interfejsu `Update-Definition` API tego typu elementu.