Items - Update Item Definition

  • Reference
Service:
Core
API Version:
v1

Overrides the definition for the specified item.

This API is supported for a number of item types, find the supported item types and information about their definition structure in Item definition overview. Updating the item's definition, does not affect its sensitivity label.

This API supports long running operations (LRO).

Permissions

The API caller must have item write permissions (contributor or higher workspace permissions).

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.

Interface

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

URI Parameters

Name In Required Type Description
itemId
 path True

string

uuid

The item ID.
workspaceId
 path True

string

uuid

The workspace ID.

Request Body

Name Required Type Description
definition True

ItemDefinition

An item definition object.

Responses

Name Type Description
200 OK

Request completed successfully.
202 Accepted

Request accepted. Update definition is in progress.

Headers

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

ErrorResponse

Common error codes:

  • OperationNotSupportedForItem - Operation not supported for requested item.

  • CorruptedPayload - The provided payload is corrupted.

Examples

Update an item definition example

Sample request

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

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:
200
Status code:
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

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
ItemDefinition

An item definition object.
ItemDefinitionPart

An item definition part object.
PayloadType

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

Update item definition request payload.

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.

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.

PayloadType

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

Name Type Description
InlineBase64

string

Inline Base 64.

UpdateItemDefinitionRequest

Update item definition request payload.

Name Type Description
definition

ItemDefinition

An item definition object.