Compartilhar via

Template Apps - Create Install Ticket

Serviço:
Power BI REST APIs
Versão da API:
v1.0

Gera um tíquete de instalação para o fluxo de instalação automatizado do aplicativo de modelo especificado.

Permissões

O chamador deve usar a entidade de serviço para autenticação. Para obter mais informações, consulte Inserir conteúdo do Power BI com de entidade de serviço e considerações e limitações .

Limitações

  • O locatário que está fazendo essa chamada de API deve possuir o aplicativo de modelo especificado.
  • O aplicativo de modelo deve ser publicado no Microsoft AppSource ou, o criador do tíquete e o usuário final que está instalando com o tíquete devem ter acesso explícito ao aplicativo.
  • Todos os parâmetros de consulta no tíquete de instalação devem ser configurados. 

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

Corpo da solicitação

Nome Tipo Description
installDetails

TemplateAppInstallDetails[]

Lista de detalhes da instalação

Respostas

Nome Tipo Description
200 OK

InstallTicket

OKEY

Exemplos

Create an install ticket for a template app, specifying two query parameters example.

Solicitação de exemplo

POST https://api.powerbi.com/v1.0/myorg/CreateTemplateAppInstallTicket
Corpo da solicitação
{
  "appId": "91ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "packageKey": "g632bb64...OfsoqT56xEM=",
  "ownerTenantId": "d43e3248-3d83-44aa-a94d-c836bd7f9b79",
  "config": {
    "configuration": {
      "param1": "value1",
      "param2": "value2"
    }
  }
}

Resposta de exemplo

Código de status:
200 
{
  "ticket": "H4sI....AAA=",
  "ticketId": "4b76f5ed-5a06-4150-8d1b-60f8e4c186f4",
  "expiration": "2020-07-29T17:58:19Z"
}
Código de status:
401 
{
  "error": {
    "code": "ServiceAppApplicationOwnershipValidationFailed",
    "pbi.error": {
      "code": "ServiceAppApplicationOwnershipValidationFailed",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}
Código de status:
400 
{
  "error": {
    "code": "ServiceAppInstallTicketInvalidConfiguration",
    "pbi.error": {
      "code": "ServiceAppInstallTicketInvalidConfiguration",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

Definições

Nome Description
CreateInstallTicketRequest

Uma solicitação para criar um tíquete de instalação do Power BI
InstallTicket

Um tíquete de instalação automatizado para um aplicativo de modelo do Power BI
TemplateAppConfigurationRequest

Uma configuração de instalação automatizada para um aplicativo de modelo do Power BI (dicionário de pares nome-valor)
TemplateAppInstallDetails

Os detalhes de instalação de um aplicativo de modelo do Power BI

CreateInstallTicketRequest

Objeto

Uma solicitação para criar um tíquete de instalação do Power BI

Nome Tipo Description
installDetails

TemplateAppInstallDetails[]

Lista de detalhes da instalação

InstallTicket

Objeto

Um tíquete de instalação automatizado para um aplicativo de modelo do Power BI

Nome Tipo Description
expiration

string (date-time)

A data e a hora de expiração (UTC) do tíquete
ticket

string

Instalar tíquete
ticketId

string (uuid)

A ID exclusiva de um tíquete de instalação. Os logs de auditoria podem ser usados para correlacionar as operações que usam esse tíquete com a operação de geração de tíquete.

TemplateAppConfigurationRequest

Objeto

Uma configuração de instalação automatizada para um aplicativo de modelo do Power BI (dicionário de pares nome-valor)

Nome Tipo Description
configuration

object

TemplateAppInstallDetails

Objeto

Os detalhes de instalação de um aplicativo de modelo do Power BI

Nome Tipo Description
appId

string (uuid)

A ID exclusiva do aplicativo de modelo do Power BI
config

TemplateAppConfigurationRequest

A configuração de instalação automatizada
ownerTenantId

string (uuid)

A ID do locatário do proprietário do aplicativo de modelo do Power BI
packageKey

string

A chave segura para a versão do aplicativo de modelo do Power BI