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

要求本文

名稱	類型	Description
installDetails	TemplateAppInstallDetails[]	安裝詳細資料清單

回應

名稱	類型	Description
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
    }
  }
}

定義

名稱	Description
CreateInstallTicketRequest	建立 Power BI 安裝票證的要求
InstallTicket	Power BI 範本應用程式的自動安裝票證
TemplateAppConfigurationRequest	Power BI 範本應用程式的自動安裝設定， (名稱/值組的字典)
TemplateAppInstallDetails	Power BI 範本應用程式的安裝詳細資料

CreateInstallTicketRequest

建立 Power BI 安裝票證的要求

名稱	類型	Description
installDetails	TemplateAppInstallDetails[]	安裝詳細資料清單

InstallTicket

Power BI 範本應用程式的自動安裝票證

名稱	類型	Description
expiration	string	票證的到期日期和時間 (UTC)
ticket	string	安裝票證
ticketId	string	安裝票證的唯一識別碼。 稽核記錄可用來讓使用此票證與產生票證作業的作業相互關聯。

TemplateAppConfigurationRequest

Power BI 範本應用程式的自動安裝設定， (名稱/值組的字典)

名稱	類型	Description
configuration	object

TemplateAppInstallDetails

Power BI 範本應用程式的安裝詳細資料

名稱	類型	Description
appId	string	Power BI 範本應用程式的唯一識別碼
config	TemplateAppConfigurationRequest	自動安裝組態
ownerTenantId	string	Power BI 範本應用程式擁有者的租使用者識別碼
packageKey	string	Power BI 範本應用程式版本的安全金鑰