Udostępnij za pośrednictwem

Items - Create Item

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

Tworzy element w określonym obszarze roboczym.
Ten interfejs API jest obsługiwany w przypadku wielu typów elementów. Znajdź obsługiwane typy elementów w Omówienie zarządzania elementami. Aby uzyskać definicję elementu, możesz użyć interfejsu API pobierania definicji elementu .

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

Uprawnienia

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

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.

Ograniczenia

  • Aby utworzyć element spoza usługi PowerBI Fabric, obszar roboczy musi znajdować się w obsługiwanej pojemności sieci szkieletowej. Aby uzyskać więcej informacji, zobacz typy licencji usługi Microsoft Fabric.
  • Aby utworzyć element usługi Power BI, użytkownik musi mieć odpowiednią licencję. Aby uzyskać więcej informacji, zobacz typy licencji usługi Microsoft Fabric.
  • Podczas tworzenia elementu użyj creationPayload lub definition, ale nie używaj obu tych elementów jednocześnie.

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

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string

uuid

Identyfikator obszaru roboczego.

Treść żądania

Nazwa Wymagane Typ Opis
displayName True

string

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

ItemType

Typ elementu.
creationPayload

object

Zestaw właściwości używanych do tworzenia elementu. Strona Utwórz element odpowiedniego typu wskazuje, czy creationPayload jest obsługiwana i wyświetla listę właściwości elementu. Użyj creationPayload lub definition. Nie można używać obu tych elementów w tym samym czasie.
definition

ItemDefinition

Definicja elementu. Strona tworzenia elementu odpowiedniego typu wskazuje, czy definicja jest obsługiwana, i szczegóły jego struktury. Użyj definition lub creationPayload. Nie można używać obu tych elementów w tym samym czasie.
description

string

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

Odpowiedzi

Nazwa Typ Opis
201 Created

Item

Pomyślnie utworzono
202 Accepted

Żądanie zaakceptowane, aprowizowanie elementów w toku

Nagłówki

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

ErrorResponse

Typowe kody błędów:

  • InvalidItemType — typ elementu jest nieprawidłowy.

  • ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana.

  • Uszkodzonypayload — podany ładunek jest uszkodzony

Przykłady

Create an item example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

Przykładowa odpowiedź

Kod stanu:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
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
CreateItemRequest

Utwórz ładunek żądania elementu.
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.
ItemDefinition

Obiekt definicji elementu.
ItemDefinitionPart

Obiekt części definicji elementu.
ItemType

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

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

CreateItemRequest

Objekt

Utwórz ładunek żądania elementu.

Nazwa Typ Opis
creationPayload

object

Zestaw właściwości używanych do tworzenia elementu. Strona Utwórz element odpowiedniego typu wskazuje, czy creationPayload jest obsługiwana i wyświetla listę właściwości elementu. Użyj creationPayload lub definition. Nie można używać obu tych elementów w tym samym czasie.
definition

ItemDefinition

Definicja elementu. Strona tworzenia elementu odpowiedniego typu wskazuje, czy definicja jest obsługiwana, i szczegóły jego struktury. Użyj definition lub creationPayload. Nie można używać obu tych elementów w tym samym czasie.
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.
type

ItemType

Typ 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.

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.

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.

PayloadType

Wyliczanie

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

Wartość Opis
InlineBase64

Śródliniowa baza 64.