Template Apps - Create Install Ticket

Service:

Power BI REST APIs

API Version:

v1.0

为指定的模板应用的 自动安装流生成安装 票证。

权限

调用方必须使用服务主体进行身份验证。 有关详细信息，请参阅使用服务主体和注意事项和限制嵌入 Power BI 内容。

限制

• 进行此 API 调用的租户 必须 拥有指定的模板应用。
• 模板应用必须发布到 Microsoft AppSource，或者票证创建者和使用票证安装的最终用户都必须具有对应用的显式访问权限。
• 必须配置安装票证中的所有查询参数。
  
  

POST https://api.powerbi.com/v1.0/myorg/CreateTemplateAppInstallTicket

请求正文

名称	类型	说明
installDetails	TemplateAppInstallDetails[]	安装详细信息列表

响应

名称	类型	说明
200 OK	InstallTicket	确定

示例

Create an install ticket for a template app, specifying two query parameters example.

Sample Request

POST https://api.powerbi.com/v1.0/myorg/CreateTemplateAppInstallTicket

Request Body

{
  "appId": "91ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "packageKey": "g632bb64...OfsoqT56xEM=",
  "ownerTenantId": "d43e3248-3d83-44aa-a94d-c836bd7f9b79",
  "config": {
    "configuration": {
      "param1": "value1",
      "param2": "value2"
    }
  }
}

Sample Response

Status code:

200

{
  "ticket": "H4sI....AAA=",
  "ticketId": "4b76f5ed-5a06-4150-8d1b-60f8e4c186f4",
  "expiration": "2020-07-29T17:58:19Z"
}

Status code:

401

{
  "error": {
    "code": "ServiceAppApplicationOwnershipValidationFailed",
    "pbi.error": {
      "code": "ServiceAppApplicationOwnershipValidationFailed",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

Status code:

400

{
  "error": {
    "code": "ServiceAppInstallTicketInvalidConfiguration",
    "pbi.error": {
      "code": "ServiceAppInstallTicketInvalidConfiguration",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

定义

名称	说明
CreateInstallTicketRequest	创建 Power BI 安装票证的请求
InstallTicket	Power BI 模板应用的自动安装票证
TemplateAppConfigurationRequest	Power BI 模板应用的自动安装配置 (名称值对字典)
TemplateAppInstallDetails	Power BI 模板应用的安装详细信息

CreateInstallTicketRequest

创建 Power BI 安装票证的请求

名称	类型	说明
installDetails	TemplateAppInstallDetails[]	安装详细信息列表

InstallTicket

Power BI 模板应用的自动安装票证

名称	类型	说明
expiration	string	票证的过期日期和时间 (UTC)
ticket	string	安装票证
ticketId	string	安装票证的唯一 ID。 审核日志可用于将使用此票证的操作与生成票证操作相关联。

TemplateAppConfigurationRequest

Power BI 模板应用的自动安装配置 (名称值对字典)

名称	类型	说明
configuration	object

TemplateAppInstallDetails

Power BI 模板应用的安装详细信息

名称	类型	说明
appId	string	Power BI 模板应用的唯一 ID
config	TemplateAppConfigurationRequest	自动安装配置
ownerTenantId	string	Power BI 模板应用所有者的租户 ID
packageKey	string	Power BI 模板应用版本的安全密钥