Template Apps - Create Install Ticket

Service:

Power BI REST APIs

API Version:

v1.0

Genera un vale de instalación para el flujo de instalación automatizado de la aplicación de plantilla especificada.

Permisos

El autor de la llamada debe usar la entidad de servicio para la autenticación. Para más información, consulte Inserción de contenido de Power BI con la entidad de servicio y consideraciones y limitaciones.

Limitaciones

• El inquilino que realiza esta llamada API debe ser propietario de la aplicación de plantilla especificada.
• La aplicación de plantilla debe publicarse en Microsoft AppSource o, tanto el creador de vales como la instalación del usuario final con el vale deben tener acceso explícito a la aplicación.
• Todos los parámetros de consulta del vale de instalación deben configurarse.
  
  

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

Cuerpo de la solicitud

Nombre	Tipo	Description
installDetails	TemplateAppInstallDetails[]	Lista de detalles de instalación

Respuestas

Nombre	Tipo	Description
200 OK	InstallTicket	Aceptar

Ejemplos

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

Definiciones

Nombre	Description
CreateInstallTicketRequest	Solicitud para crear un vale de instalación de Power BI
InstallTicket	Una incidencia de instalación automatizada para una aplicación de plantilla de Power BI
TemplateAppConfigurationRequest	Una configuración de instalación automatizada para una aplicación de plantilla de Power BI (diccionario de pares nombre-valor)
TemplateAppInstallDetails	Detalles de instalación de una aplicación de plantilla de Power BI

CreateInstallTicketRequest

Solicitud para crear un vale de instalación de Power BI

Nombre	Tipo	Description
installDetails	TemplateAppInstallDetails[]	Lista de detalles de instalación

InstallTicket

Una incidencia de instalación automatizada para una aplicación de plantilla de Power BI

Nombre	Tipo	Description
expiration	string	Fecha y hora de expiración (UTC) del vale
ticket	string	Instalar vale
ticketId	string	Identificador único de un vale de instalación. Los registros de auditoría se pueden usar para correlacionar las operaciones que usan este vale con la operación de generación de vales.

TemplateAppConfigurationRequest

Una configuración de instalación automatizada para una aplicación de plantilla de Power BI (diccionario de pares nombre-valor)

Nombre	Tipo	Description
configuration	object

TemplateAppInstallDetails

Detalles de instalación de una aplicación de plantilla de Power BI

Nombre	Tipo	Description
appId	string	Identificador único de la aplicación de plantilla de Power BI
config	TemplateAppConfigurationRequest	Configuración de instalación automatizada
ownerTenantId	string	Identificador de inquilino del propietario de la aplicación de plantilla de Power BI
packageKey	string	Clave segura para la versión de la aplicación de plantilla de Power BI