編輯

共用方式為

Items - Create Item

  • Reference
Service:
Core
API Version:
v1

Creates an item in the specified workspace.
This API is supported for a number of item types, find the supported item types in Item management overview. You can use Get item definition API to get an item definition.

This API supports long running operations (LRO).

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

For item APIs use these scope types:

  • Generic scope: Item.ReadWrite.All
  • Specific scope: itemType.ReadWrite.All (for example: Notebook.ReadWrite.All)

for more information about scopes, see scopes article.

Limitations

  • To create a non-PowerBI Fabric item the workspace must be on a supported Fabric capacity. For more information see Microsoft Fabric license types.
  • To create a PowerBI item, the user must have the appropriate license. For more information see Microsoft Fabric license types.
  • When creating an item, use either creationPayload or definition, but do not use both at the same time.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities When the item type in the call is supported. Check the corresponding API for the item type you're calling, to see if your call is supported. For example, semantic models are supported.

Interface

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

URI Parameters

Name In Required Type Description
workspaceId
 path True

string

uuid

The workspace ID.

Request Body

Name Required Type Description
displayName True

string

The item display name. The display name must follow naming rules according to item type.
type True

ItemType

The item type.
creationPayload

object

A set of properties used to create the item. Use creationPayload or definition. You can't use both at the same time.
definition

ItemDefinition

The item definition. Use definition or creationPayload. You can't use both at the same time.
description

string

The item description. Maximum length is 256 characters.

Responses

Name Type Description
201 Created

Item

Successfully created
202 Accepted

Request accepted, item provisioning in progress

Headers

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

ErrorResponse

Common error codes:

  • InvalidItemType - Item type is invalid.

  • ItemDisplayNameAlreadyInUse - Item display name is already used.

  • CorruptedPayload - The provided payload is corrupted

Examples

Create an item example

Sample request

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

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

Sample response

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

Definitions

Name Description
CreateItemRequest

Create item request payload.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
Item

An item object.
ItemDefinition

An item definition object.
ItemDefinitionPart

An item definition part object.
ItemType

The type of the item. Additional item types may be added over time.
PayloadType

The type of the definition part payload. Additional payload types may be added over time.

CreateItemRequest

Create item request payload.

Name Type Description
creationPayload

object

A set of properties used to create the item. Use creationPayload or definition. You can't use both at the same time.
definition

ItemDefinition

The item definition. Use definition or creationPayload. You can't use both at the same time.
description

string

The item description. Maximum length is 256 characters.
displayName

string

The item display name. The display name must follow naming rules according to item type.
type

ItemType

The item type.

ErrorRelatedResource

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

Item

An item object.

Name Type Description
description

string

The item description.
displayName

string

The item display name.
id

string

The item ID.
type

ItemType

The item type.
workspaceId

string

The workspace ID.

ItemDefinition

An item definition object.

Name Type Description
format

string

The format of the item definition.
parts

ItemDefinitionPart[]

A list of definition parts.

ItemDefinitionPart

An item definition part object.

Name Type Description
path

string

The item part path.
payload

string

The item part payload.
payloadType

PayloadType

The payload type.

ItemType

The type of the item. Additional item types may be added over time.

Name Type Description
Dashboard

string

PowerBI dashboard.
DataPipeline

string

A data pipeline.
Datamart

string

PowerBI datamart.
Environment

string

An environment.
Eventhouse

string

An eventhouse.
Eventstream

string

An eventstream.
KQLDashboard

string

A KQL dashboard.
KQLDatabase

string

A KQL database.
KQLQueryset

string

A KQL queryset.
Lakehouse

string

A lakehouse.
MLExperiment

string

A machine learning experiment.
MLModel

string

A machine learning model.
MirroredDatabase

string

A mirrored database.
MirroredWarehouse

string

A mirrored warehouse.
Notebook

string

A notebook.
PaginatedReport

string

PowerBI paginated report.
Reflex

string

A Reflex.
Report

string

PowerBI report.
SQLEndpoint

string

An SQL endpoint.
SemanticModel

string

PowerBI semantic model.
SparkJobDefinition

string

A spark job definition.
Warehouse

string

A warehouse.

PayloadType

The type of the definition part payload. Additional payload types may be added over time.

Name Type Description
InlineBase64

string

Inline Base 64.