Template Apps - Create Install Ticket

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

Generuje bilet instalacyjny dla zautomatyzowanego przepływu instalacji określonej aplikacji szablonu.

Uprawnienia

Obiekt wywołujący musi używać jednostki usługi do uwierzytelniania. Aby uzyskać więcej informacji, zobacz Osadzanie zawartości usługi Power BI przy użyciu jednostki usługi i zagadnień i ograniczeń.

Ograniczenia

Dzierżawa wykonująca to wywołanie interfejsu API musi być właścicielem określonej aplikacji szablonu.
Aplikacja szablonu musi zostać opublikowana w usłudze Microsoft AppSource lub zarówno twórca biletu, jak i użytkownik końcowy instalowany z biletem muszą mieć jawny dostęp do aplikacji.
Wszystkie parametry zapytania w bilecie instalacji muszą być skonfigurowane.

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

Treść żądania

Nazwa	Typ	Opis
installDetails	TemplateAppInstallDetails[]	Lista szczegółów instalacji

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InstallTicket	OK

Przykłady

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
    }
  }
}

Definicje

Nazwa	Opis
CreateInstallTicketRequest	Żądanie utworzenia biletu instalacji usługi Power BI
InstallTicket	Bilet automatycznej instalacji dla aplikacji szablonu usługi Power BI
TemplateAppConfigurationRequest	Automatyczna konfiguracja instalacji aplikacji szablonu usługi Power BI (słownik par name-value)
TemplateAppInstallDetails	Szczegóły instalacji aplikacji szablonu usługi Power BI

CreateInstallTicketRequest

Żądanie utworzenia biletu instalacji usługi Power BI

Nazwa	Typ	Opis
installDetails	TemplateAppInstallDetails[]	Lista szczegółów instalacji

InstallTicket

Bilet automatycznej instalacji dla aplikacji szablonu usługi Power BI

Nazwa	Typ	Opis
expiration	string	Data i godzina wygaśnięcia biletu (UTC)
ticket	string	Instalowanie biletu
ticketId	string	Unikatowy identyfikator biletu instalacji. Dzienniki inspekcji mogą służyć do korelowania operacji korzystających z tego biletu z operacją generowania biletu.

TemplateAppConfigurationRequest

Automatyczna konfiguracja instalacji aplikacji szablonu usługi Power BI (słownik par name-value)

Nazwa	Typ	Opis
configuration	object

TemplateAppInstallDetails

Szczegóły instalacji aplikacji szablonu usługi Power BI

Nazwa	Typ	Opis
appId	string	Unikatowy identyfikator aplikacji szablonu usługi Power BI
config	TemplateAppConfigurationRequest	Konfiguracja automatycznej instalacji
ownerTenantId	string	Identyfikator dzierżawy właściciela aplikacji szablonu usługi Power BI
packageKey	string	Bezpieczny klucz dla wersji aplikacji szablonu usługi Power BI

Udostępnij za pośrednictwem