Template Apps - Create Install Ticket

Riferimento

Service:: Power BI REST APIs

API Version:: v1.0

Genera un ticket di installazione per il flusso di installazione automatizzato dell'app modello specificata.

Autorizzazioni

Il chiamante deve usare l'entità servizio per l'autenticazione. Per altre informazioni, vedere Incorporare contenuto di Power BI con entità servizio e considerazioni e limitazioni.

Limitazioni

Il tenant che effettua questa chiamata API deve essere proprietario dell'app modello specificata.
L'app modello deve essere pubblicata in Microsoft AppSource oppure, sia l'autore del ticket che l'installazione dell'utente finale con il ticket devono avere accesso esplicito all'app.
Tutti i parametri di query nel ticket di installazione devono essere configurati.

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

Corpo della richiesta

Nome	Tipo	Descrizione
installDetails	TemplateAppInstallDetails[]	Elenco dei dettagli dell'installazione

Risposte

Nome	Tipo	Descrizione
200 OK	InstallTicket	OK

Esempio

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

Definizioni

Nome	Descrizione
CreateInstallTicketRequest	Richiesta di creazione di un ticket di installazione di Power BI
InstallTicket	Ticket di installazione automatizzato per un'app modello di Power BI
TemplateAppConfigurationRequest	Configurazione automatica dell'installazione per un'app modello di Power BI (dizionario delle coppie nome-valore)
TemplateAppInstallDetails	Dettagli dell'installazione per un'app modello di Power BI

CreateInstallTicketRequest

Richiesta di creazione di un ticket di installazione di Power BI

Nome	Tipo	Descrizione
installDetails	TemplateAppInstallDetails[]	Elenco dei dettagli dell'installazione

InstallTicket

Ticket di installazione automatizzato per un'app modello di Power BI

Nome	Tipo	Descrizione
expiration	string	Data e ora di scadenza (UTC) del ticket
ticket	string	Installare il ticket
ticketId	string	ID univoco di un ticket di installazione. I log di controllo possono essere usati per correlare le operazioni che usano questo ticket con l'operazione di generazione del ticket.

TemplateAppConfigurationRequest

Configurazione automatica dell'installazione per un'app modello di Power BI (dizionario delle coppie nome-valore)

Nome	Tipo	Descrizione
configuration	object

TemplateAppInstallDetails

Dettagli dell'installazione per un'app modello di Power BI

Nome	Tipo	Descrizione
appId	string	ID univoco dell'app modello di Power BI
config	TemplateAppConfigurationRequest	Configurazione automatica dell'installazione
ownerTenantId	string	ID tenant del proprietario dell'app modello di Power BI
packageKey	string	Chiave sicura per la versione dell'app modello di Power BI

Condividi tramite