Sdílet prostřednictvím

Items - Create Item

Služba:
Core
Verze rozhraní API:
v1

Vytvoří položku v zadaném pracovním prostoru.
Toto rozhraní API je podporováno pro řadu typů položek, vyhledejte podporované typy položek v přehledu správy položek . K získání definice položky můžete použít rozhraní API pro získání definice položky.

Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Dovolení

Volající musí mít roli pracovního prostoru přispěvatele .

Požadované delegovaná rozsahy

Pro rozhraní API položek se používají tyto typy oborů:

  • Obecný obor: Item.ReadWrite.All
  • Specifický obor: itemType. ReadWrite.All (například Notebook.ReadWrite.All)

Další informace o oborech naleznete v článku obory .

Omezení

  • Pokud chcete vytvořit položku mimo PowerBI Fabric, musí být pracovní prostor v podporované kapacitě Fabric. Další informace najdete v tématu typy licencí Microsoft Fabric.
  • Aby uživatel mohl vytvořit položku PowerBI, musí mít příslušnou licenci. Další informace najdete v tématu typy licencí Microsoft Fabric.
  • Při vytváření položky použijte creationPayload nebo definition, ale nepoužívejte obě současně.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita Podpora
Uživatel Ano
instančního objektu a spravované identity Je-li podporován typ položky ve volání. Zkontrolujte odpovídající rozhraní API pro typ položky, který voláte, a zjistěte, jestli je volání podporované. Podporují se například sémantické modely.

Rozhraní

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
workspaceId
 path True

string (uuid)

ID pracovního prostoru.

Text požadavku

Name Vyžadováno Typ Description
displayName True

string

Zobrazovaný název položky. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
type True

ItemType

Typ položky.
creationPayload

object

Sada vlastností použitých k vytvoření položky. Stránka Vytvořit položku příslušného typu označuje, jestli je creationPayload podporována, a uvádí vlastnosti položky. Použijte creationPayload nebo definition. Nemůžete použít oba současně.
definition

ItemDefinition

Definice položky. Stránka Vytvořit položku příslušného typu indikuje, zda je definice podporována, a podrobně popisuje její strukturu. Použijte definition nebo creationPayload. Nemůžete použít oba současně.
description

string

Popis položky. Maximální délka je 256 znaků.
folderId

string (uuid)

ID složky. Pokud není zadána hodnota null, položka se vytvoří s pracovním prostorem jako její složkou.

Odpovědi

Name Typ Description
201 Created

Item

Úspěšně vytvořeno
202 Accepted

Žádost byla přijata, probíhá zřizování položek.

Hlavičky

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

ErrorResponse

Běžné kódy chyb:

  • InvalidItemType – Typ položky je neplatný.

  • ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit.

  • Poškozená částPayload – zadanou datovou část je poškozena.

  • FolderNotFound – Požadovanou složku se nepodařilo najít.

  • WorkspaceItemsLimitExceededed – Došlo k překročení limitu položek pracovního prostoru.

Příklady

Create an item example
Create an item in folder example

Create an item example

Ukázkový požadavek

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

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

Ukázková odpověď

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

Create an item in folder example

Ukázkový požadavek

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items

{
  "displayName": "Item 1",
  "type": "Lakehouse",
  "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

Ukázková odpověď

Stavový kód:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "id": "cccccccc-2222-3333-4444-dddddddddddd"
}
Stavový kód:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0000aaaa-11bb-cccc-dd22-eeeeee333333
x-ms-operation-id: 0000aaaa-11bb-cccc-dd22-eeeeee333333
Retry-After: 30

Definice

Name Description
CreateItemRequest

Vytvořte datovou část žádosti o položku.
ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.
ErrorResponse

Odpověď na chybu.
ErrorResponseDetails

Podrobnosti o odpovědi na chybu.
Item

Objekt položky.
ItemDefinition

Objekt definice položky.
ItemDefinitionPart

Objekt části definice položky.
ItemTag

Představuje značku použitou u položky.
ItemType

Typ položky. V průběhu času je možné přidat další typy položek.
PayloadType

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

CreateItemRequest

Objekt

Vytvořte datovou část žádosti o položku.

Name Typ Description
creationPayload

object

Sada vlastností použitých k vytvoření položky. Stránka Vytvořit položku příslušného typu označuje, jestli je creationPayload podporována, a uvádí vlastnosti položky. Použijte creationPayload nebo definition. Nemůžete použít oba současně.
definition

ItemDefinition

Definice položky. Stránka Vytvořit položku příslušného typu indikuje, zda je definice podporována, a podrobně popisuje její strukturu. Použijte definition nebo creationPayload. Nemůžete použít oba současně.
description

string

Popis položky. Maximální délka je 256 znaků.
displayName

string

Zobrazovaný název položky. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
folderId

string (uuid)

ID složky. Pokud není zadána hodnota null, položka se vytvoří s pracovním prostorem jako její složkou.
type

ItemType

Typ položky.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name Typ Description
resourceId

string

ID prostředku, které je součástí chyby.
resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou
requestId

string

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

Item

Objekt

Objekt položky.

Name Typ Description
description

string

Popis položky.
displayName

string

Zobrazovaný název položky.
folderId

string (uuid)

ID složky.
id

string (uuid)

ID položky.
tags

ItemTag[]

Seznam použitých značek
type

ItemType

Typ položky.
workspaceId

string (uuid)

ID pracovního prostoru.

ItemDefinition

Objekt

Objekt definice položky.

Name Typ Description
format

string

Formát definice položky.
parts

ItemDefinitionPart[]

Seznam částí definice.

ItemDefinitionPart

Objekt

Objekt části definice položky.

Name Typ Description
path

string

Cesta části položky.
payload

string

Datová část položky.
payloadType

PayloadType

Typ datové části.

ItemTag

Objekt

Představuje značku použitou u položky.

Name Typ Description
displayName

string

Název značky.
id

string (uuid)

ID značky.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota Description
Dashboard

Řídicí panel PowerBI
Report

Sestava PowerBI
SemanticModel

Sémantický model PowerBI
PaginatedReport

Stránkovaná sestava PowerBI
Datamart

Datový diagram PowerBI
Lakehouse

Jezero.
Eventhouse

Eventhouse.
Environment

Prostředí.
KQLDatabase

Databáze KQL.
KQLQueryset

Sada dotazů KQL.
KQLDashboard

Řídicí panel KQL.
DataPipeline

Datový kanál.
Notebook

Poznámkový blok.
SparkJobDefinition

Definice úlohy Sparku.
MLExperiment

Experiment strojového učení.
MLModel

Model strojového učení.
Warehouse

Sklad.
Eventstream

Eventstream.
SQLEndpoint

Koncový bod SQL.
MirroredWarehouse

Zrcadlený sklad.
MirroredDatabase

Zrcadlené databáze.
Reflex

A Reflex.
GraphQLApi

Rozhraní API pro položku GraphQL
MountedDataFactory

A MountedDataFactory.
SQLDatabase

Databáze SQLDatabase.
CopyJob

Úloha kopírování.
VariableLibrary

ProměnnáLibrary.
Dataflow

Tok dat.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Snímek skladu.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Tok digitálního dvojčete.
MirroredAzureDatabricksCatalog

Zrcadlený katalog Azure Databricks.
Map

Mapa.
AnomalyDetector

Detektor anomálií.
UserDataFunction

Funkce uživatelských dat.
GraphModel

A GraphModel.
GraphQuerySet

Sada dotazů grafu.
SnowflakeDatabase

Snowflake Database pro ukládání tabulek Iceberg vytvořených z účtu Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Databáze Cosmos DB.

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota Description
InlineBase64

Vložená základna 64.