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	Уникальный идентификатор билета установки. Журналы аудита можно использовать для сопоставления операций, использующих этот билет, с операцией создания билета.

TemplateAppConfigurationRequest

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

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

TemplateAppInstallDetails

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

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

Поделиться через