Template Apps - Create Install Ticket

Referensi

Service:: Power BI REST APIs

API Version:: v1.0

Menghasilkan tiket penginstalan untuk alur penginstalan otomatis dari aplikasi templat yang ditentukan.

Izin

Penelepon harus menggunakan perwakilan layanan untuk autentikasi. Untuk informasi selengkapnya, lihat Menyematkan konten Power BI dengan perwakilan layanan dan Pertimbangan dan batasan.

Batasan

Penyewa yang melakukan panggilan API ini harus memiliki aplikasi templat yang ditentukan.
Aplikasi templat harus dipublikasikan ke Microsoft AppSource, atau, pembuat tiket dan pengguna akhir yang menginstal dengan tiket harus memiliki akses eksplisit ke aplikasi.
Semua parameter kueri dalam tiket penginstalan harus dikonfigurasi.

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

Isi Permintaan

Nama	Jenis	Deskripsi
installDetails	TemplateAppInstallDetails[]	Daftar detail penginstalan

Respons

Nama	Jenis	Deskripsi
200 OK	InstallTicket	OK

Contoh

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

Definisi

Nama	Deskripsi
CreateInstallTicketRequest	Permintaan untuk membuat tiket penginstalan Power BI
InstallTicket	Tiket penginstalan otomatis untuk aplikasi templat Power BI
TemplateAppConfigurationRequest	Konfigurasi penginstalan otomatis untuk aplikasi templat Power BI (kamus pasangan nama-nilai)
TemplateAppInstallDetails	Detail penginstalan untuk aplikasi templat Power BI

CreateInstallTicketRequest

Permintaan untuk membuat tiket penginstalan Power BI

Nama	Jenis	Deskripsi
installDetails	TemplateAppInstallDetails[]	Daftar detail penginstalan

InstallTicket

Tiket penginstalan otomatis untuk aplikasi templat Power BI

Nama	Jenis	Deskripsi
expiration	string	Tanggal dan waktu kedaluwarsa (UTC) tiket
ticket	string	Pasang tiket
ticketId	string	ID unik tiket penginstalan. Log audit dapat digunakan untuk menghubungkan operasi yang menggunakan tiket ini dengan operasi hasilkan tiket.

TemplateAppConfigurationRequest

Konfigurasi penginstalan otomatis untuk aplikasi templat Power BI (kamus pasangan nama-nilai)

Nama	Jenis	Deskripsi
configuration	object

TemplateAppInstallDetails

Detail penginstalan untuk aplikasi templat Power BI

Nama	Jenis	Deskripsi
appId	string	ID unik aplikasi templat Power BI
config	TemplateAppConfigurationRequest	Konfigurasi penginstalan otomatis
ownerTenantId	string	ID penyewa pemilik aplikasi templat Power BI
packageKey	string	Kunci aman untuk versi aplikasi templat Power BI

Bagikan melalui