Udostępnij za pośrednictwem

Items - Update Item

  • Odwołanie
Usługa:
Core
Wersja interfejsu API:
v1

Aktualizuje właściwości 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 Omówienie zarządzania elementami.

Uprawnienia

Obiekt wywołujący musi mieć rolę współautora lub wyższą w obszarze roboczym.

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 firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
jednostki usługi i tożsamości zarządzanych 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

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
itemId
 path True

string

uuid

Identyfikator elementu.
workspaceId
 path True

string

uuid

Identyfikator obszaru roboczego.

Treść żądania

Nazwa Typ Opis
description

string

Opis elementu. Maksymalna długość to 256 znaków.
displayName

string

Nazwa wyświetlana elementu. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu.

Odpowiedzi

Nazwa Typ Opis
200 OK

Item

Żądanie zostało ukończone pomyślnie.
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • ItemNotFound — żądany element nie został znaleziony.

  • InvalidRequest — nieprawidłowe żądanie aktualizacji.

Przykłady

Update an item example

Przykładowe żądanie

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Item's New name",
  "description": "Item's New description"
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "displayName": "Item's New name",
  "description": "Item's New description",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definicje

Nazwa Opis
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

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

Obiekt elementu.
ItemType

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
UpdateItemRequest

Zaktualizuj żądanie elementu.

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.

Item

Objekt

Obiekt elementu.

Nazwa Typ Opis
description

string

Opis elementu.
displayName

string

Nazwa wyświetlana elementu.
id

string

uuid

Identyfikator elementu.
type

ItemType

Typ elementu.
workspaceId

string

uuid

Identyfikator obszaru roboczego.

ItemType

Wyliczanie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość Opis
Dashboard

Pulpit nawigacyjny usługi Power BI.
DataPipeline

Potok danych.
Datamart

Datamart usługi Power BI.
Environment

Środowisko.
Eventhouse

Magazyn zdarzeń.
Eventstream

Strumień zdarzeń.
GraphQLApi

Interfejs API dla elementu GraphQL.
KQLDashboard

Pulpit nawigacyjny KQL.
KQLDatabase

Baza danych KQL.
KQLQueryset

Zestaw zapytań KQL.
Lakehouse

Jezioro.
MLExperiment

Eksperyment uczenia maszynowego.
MLModel

Model uczenia maszynowego.
MirroredDatabase

Dublowana baza danych.
MirroredWarehouse

Dublowany magazyn.
MountedDataFactory

A MountedDataFactory.
Notebook

Notes.
PaginatedReport

Raport podzielony na strony usługi PowerBI.
Reflex

Refleks.
Report

Raport usługi Power BI.
SQLDatabase

Baza danych SQLDatabase.
SQLEndpoint

Punkt końcowy SQL.
SemanticModel

Model semantyczny usługi PowerBI.
SparkJobDefinition

Definicja zadania platformy Spark.
Warehouse

Magazyn.

UpdateItemRequest

Objekt

Zaktualizuj żądanie elementu.

Nazwa Typ Opis
description

string

Opis elementu. Maksymalna długość to 256 znaków.
displayName

string

Nazwa wyświetlana elementu. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu.