Template Apps - Create Install Ticket

Служба:: Power BI REST APIs

Версия API:: v1.0

Создает запрос на установку для автоматического потока установки указанного приложения-шаблона.

Permissions

Вызывающий объект должен использовать субъект-службу для проверки подлинности. Дополнительные сведения см. в статье Внедрение содержимого 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.

Образец запроса

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

Текст запроса

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

Пример ответа

Код состояния:: 200

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

Код состояния:: 401

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

Код состояния:: 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

Object

Запрос на создание запроса на установку Power BI

Имя	Тип	Описание
installDetails	TemplateAppInstallDetails[]	Список сведений об установке

InstallTicket

Object

Автоматический запрос на установку для приложения шаблона Power BI

Имя	Тип	Описание
expiration	string (date-time)	Дата и время окончания срока действия билета (UTC)
ticket	string	Установка билета
ticketId	string (uuid)	Уникальный идентификатор билета на установку. Журналы аудита можно использовать для сопоставления операций, которые используют этот билет с операцией создания билета.

TemplateAppConfigurationRequest

Object

Автоматическая конфигурация установки для приложения шаблона Power BI (словарь пар "имя-значение")

Имя	Тип	Описание
configuration	object

TemplateAppInstallDetails

Object

Сведения об установке для приложения шаблона Power BI

Имя	Тип	Описание
appId	string (uuid)	Уникальный идентификатор приложения шаблона Power BI
config	TemplateAppConfigurationRequest	Конфигурация автоматической установки
ownerTenantId	string (uuid)	Идентификатор клиента владельца приложения шаблона Power BI
packageKey	string	Безопасный ключ для версии приложения шаблона Power BI