Template Apps - Create Install Ticket

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Génère un ticket d’installation pour le flux d’installation automatisé de l’application modèle spécifiée.

Autorisations

L’appelant doit utiliser le principal de service pour l’authentification. Pour plus d’informations, consultez Incorporer du contenu Power BI avec le principal de service et les considérations et limitations.

Limites

Le locataire effectuant cet appel d’API doit posséder l’application modèle spécifiée.
L’application modèle doit être publiée sur Microsoft AppSource ou, à la fois, le créateur de ticket et l’installation de l’utilisateur final avec le ticket doivent avoir un accès explicite à l’application.
Tous les paramètres de requête dans le ticket d’installation doivent être configurés.

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

Corps de la demande

Nom	Type	Description
installDetails	TemplateAppInstallDetails[]	Liste des détails de l’installation

Réponses

Nom	Type	Description
200 OK	InstallTicket	Ok

Exemples

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

Définitions

Nom	Description
CreateInstallTicketRequest	Demande de création d’un ticket d’installation Power BI
InstallTicket	Ticket d’installation automatisé pour une application modèle Power BI
TemplateAppConfigurationRequest	Configuration d’installation automatisée pour une application modèle Power BI (dictionnaire de paires nom-valeur)
TemplateAppInstallDetails	Détails d’installation d’une application modèle Power BI

CreateInstallTicketRequest

Demande de création d’un ticket d’installation Power BI

Nom	Type	Description
installDetails	TemplateAppInstallDetails[]	Liste des détails de l’installation

InstallTicket

Ticket d’installation automatisé pour une application modèle Power BI

Nom	Type	Description
expiration	string	Date et heure d’expiration (UTC) du ticket
ticket	string	Installer le ticket
ticketId	string	ID unique d’un ticket d’installation. Les journaux d’audit peuvent être utilisés pour mettre en corrélation les opérations qui utilisent ce ticket avec l’opération de génération de ticket.

TemplateAppConfigurationRequest

Configuration d’installation automatisée pour une application modèle Power BI (dictionnaire de paires nom-valeur)

Nom	Type	Description
configuration	object

TemplateAppInstallDetails

Détails d’installation d’une application modèle Power BI

Nom	Type	Description
appId	string	ID unique de l’application modèle Power BI
config	TemplateAppConfigurationRequest	Configuration de l’installation automatisée
ownerTenantId	string	ID de locataire du propriétaire de l’application modèle Power BI
packageKey	string	Clé sécurisée pour la version de l’application modèle Power BI

Partager via