Sdílet prostřednictvím


Template Apps - Create Install Ticket

Vygeneruje lístek instalace pro automatizovaný tok instalace zadané aplikace šablony.

Oprávnění

Volající musí k ověřování použít instanční objekt. Další informace najdete v tématu Vložení obsahu Power BI s instančním objektem a důležitými informacemi a omezeními.

Omezení

  • Tenant, který volá toto rozhraní API , musí vlastnit zadanou aplikaci šablony.
  • Aplikace šablony musí být buď publikovaná v Microsoft AppSource, nebo musí mít autor lístku i koncový uživatel, který s tímto lístkem instaluje, explicitní přístup k aplikaci.
  • Všechny parametry dotazu v lístku instalace musí být nakonfigurované.

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

Text požadavku

Name Typ Description
installDetails

TemplateAppInstallDetails[]

Seznam podrobností o instalaci

Odpovědi

Name Typ Description
200 OK

InstallTicket

OK

Příklady

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

Sample Request

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

Sample Response

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

Definice

Name Description
CreateInstallTicketRequest

Žádost o vytvoření lístku instalace Power BI

InstallTicket

Lístek automatizované instalace pro aplikaci šablony Power BI

TemplateAppConfigurationRequest

Automatická konfigurace instalace pro aplikaci šablony Power BI (slovník párů name-value)

TemplateAppInstallDetails

Podrobnosti o instalaci aplikace šablony Power BI

CreateInstallTicketRequest

Žádost o vytvoření lístku instalace Power BI

Name Typ Description
installDetails

TemplateAppInstallDetails[]

Seznam podrobností o instalaci

InstallTicket

Lístek automatizované instalace pro aplikaci šablony Power BI

Name Typ Description
expiration

string

Datum a čas vypršení platnosti lístku (UTC)

ticket

string

Instalace lístku

ticketId

string

Jedinečné ID lístku instalace. Protokoly auditu lze použít ke korelaci operací, které používají tento lístek, s operací generování lístku.

TemplateAppConfigurationRequest

Automatická konfigurace instalace pro aplikaci šablony Power BI (slovník párů name-value)

Name Typ Description
configuration

object

TemplateAppInstallDetails

Podrobnosti o instalaci aplikace šablony Power BI

Name Typ Description
appId

string

Jedinečné ID aplikace šablony Power BI

config

TemplateAppConfigurationRequest

Konfigurace automatizované instalace

ownerTenantId

string

ID tenanta vlastníka aplikace šablony Power BI

packageKey

string

Zabezpečený klíč pro verzi aplikace šablony Power BI