Items - Get Item Definition

服务:

Core

API 版本:

v1

返回指定的项定义。
许多项类型都支持此 API，可在 项定义概述中找到受支持的项类型和有关其定义结构的信息。 获取项的定义时，敏感度标签不是定义的一部分。

此 API 支持 长时间运行的作（LRO）。

权限

调用方必须具有项的 读取和写入 权限。

所需的委派范围

对于项 API，请使用以下范围类型：

• 泛型范围：Item.ReadWrite.All
• 特定范围：itemType。ReadWrite.All（例如：Notebook.ReadWrite.All）

有关范围的详细信息，请参阅 Scopes 文章。

局限性

除非调用方具有删除敏感度标签的使用权限，否则对于具有受保护敏感度标签的项目，将阻止此 API。

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体和托管标识	支持调用中的项类型时。 检查要调用的项目类型的相应 API，以查看调用是否受支持。 例如，支持语义模型。

接口

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

具有可选参数:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition?format={format}

URI 参数

名称	在	必需	类型	说明
itemId	path	True	string (uuid)	项 ID。
workspaceId	path	True	string (uuid)	工作区 ID。
format	query		string	项定义的格式。

响应

名称	类型	说明
200 OK	ItemDefinitionResponse	请求成功完成。
202 Accepted		请求已接受。 正在检索定义。 标头 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： OperationNotSupportedForItem - 请求的项不支持作。

示例

Get an item definition example

示例请求

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

示例响应

状态代码:

200

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

状态代码:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemDefinition	项定义对象。
ItemDefinitionPart	项定义部件对象。
ItemDefinitionResponse	项公共定义响应。
PayloadType	定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ItemDefinition

Object

项定义对象。

名称	类型	说明
format	string	项定义的格式。
parts	ItemDefinitionPart[]	定义部件的列表。

ItemDefinitionPart

Object

项定义部件对象。

名称	类型	说明
path	string	项部件路径。
payload	string	项部件有效负载。
payloadType	PayloadType	有效负载类型。

ItemDefinitionResponse

Object

项公共定义响应。

名称	类型	说明
definition	ItemDefinition	项定义对象。

PayloadType

枚举

定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。

值	说明
InlineBase64	内联基线 64。