Ikhtisar Laporan

Ikhtisar Laporan #

Sumber daya Laporan menyediakan kemampuan untuk mengkueri dan menjalankan laporan yang dikonfigurasi di ruang kerja yang direferensikan.

/{VERSION}/workspaces/{WORKSPACE_ID}/reports

Antarmuka yang Tersedia #

Antarmuka Deskripsi
Dapatkan Semua Mengembalikan kumpulan laporan yang dikonfigurasi.
Permintaan Posting Memposting permintaan untuk menjalankan laporan.
Dapatkan Status Mengkueri status permintaan yang disediakan.
Dapatkan Hasil Mengkueri data hasil dari permintaan yang disediakan.

Skema #

Laporan #

Kunci Deskripsi Jenis
Id Pengidentifikasi unik untuk mereferensikan laporan ini GUID
Nama Nama yang mudah digunakan untuk instance laporan tali

Status Laporan #

Data Deskripsi Jenis
tanggalDibuat Stempel waktu tanggal pembuatan permintaan TanggalWaktu
tenantId ID penyewa pelanggan permintaan GUID
requestId ID unik untuk permintaan. GUID
Lapor ID unik untuk instans laporan. GUID
keadaan Enum of the report request's < c0> status</c0> tali
statusPesan Pesan yang diperluas untuk status tali
laporanTemplateName Nama templat untuk reportId. Setiap jenis templat berisi informasi panggilan yang berbeda. (misalnya daftar, ringkasan, dll) tali
rowLimitExceeded Nilai Bool yang menunjukkan apakah output laporan dipotong berdasarkan batas baris yang dikonfigurasi. bool

Laporan Hasil #

Minta Deskripsi Jenis
requestId ID unik untuk permintaan. GUID
tenantId ID penyewa pelanggan permintaan GUID
minta Objek permintaan berisi detail tentang laporan, termasuk informasi tentang bidang yang ditampilkan, pengurutan, dan filter yang diterapkan. Minta Objek
queryDuration Waktu yang dibutuhkan untuk mengekstrak data untuk permintaan dalam milidetik. Int
totalDurasi Waktu yang dibutuhkan untuk mengeksekusi permintaan dalam milidetik. tali
queryCount Jumlah rekaman yang diproses untuk laporan Int
jumlah total Jumlah rekaman yang ditampilkan dalam laporan tali
rowLimitExceeded Nilai Bool yang menunjukkan apakah output laporan dipotong berdasarkan batas baris yang dikonfigurasi tali
data Array baris data yang berisi hasil laporan. Gunakan informasi displayFields dalam objek Request untuk mengidentifikasi detail data yang dikembalikan. Catatan: Jika bidang tertentu direferensikan dalam ' displayFields' tidak ada di baris data, itu kosong (string) atau false (bool). Array
ringkasan Jika berlaku, ini berisi data baris ringkasan untuk setiap baris dalam array data. Array

Minta Objek #

Minta Deskripsi Jenis
requestId ID unik untuk permintaan. GUID
tanggalDibuat Stempel waktu tanggal pembuatan permintaan TanggalWaktu
tenantId ID penyewa pelanggan permintaan GUID
Lapor ID unik untuk instans laporan. GUID
laporanTemplateName Nama templat untuk reportId. Setiap jenis templat berisi informasi panggilan yang berbeda. (misalnya daftar, ringkasan, dll) tali
filterKondisi Detail filter yang diterapkan ke laporan Benda
sortFields Array urutan pengurutan yang diterapkan ke 1 bidang atau lebih. Array (< c0> Sort Order</c0>)
tampilanBidang Array bidang yang ditampilkan untuk setiap baris dalam laporan Array (< c0> Display Field</c0>)
childDisplayFields Array bidang turunan yang dikembalikan untuk setiap baris dalam laporan (jika ada) tali
metaData Informasi lain mengenai laporan yang dikembalikan Benda

Urutkan Objek Pesanan #

Minta Deskripsi Jenis
nama bidang Nama id untuk bidang tali
arah Enum untuk urutan pengurutan yang diterapkan ke bidang ini Urutan Urutkan

Tampilkan Objek Bidang #

Minta Deskripsi Jenis
nama bidang Nama id untuk bidang tali
Wajib Bool yang menunjukkan apakah bidang tersebut wajib untuk laporan bool

Enum #

Keadaan #

Nilai Deskripsi
Mulai Menginisialisasi kueri
Menghitung Menghitung baris data yang berlaku
Query Mengkueri data yang berlaku untuk database
Diproses Memproses data laporan.
Penyortiran Mengurutkan data laporan.
Total Mengisi kolom total
TotalPersentase Mengisi % total kolom
Mengkonversi Convertig return dataset
Lengkap Selesai

Filter Tanggal Preset #

Nilai Deskripsi
Hari Ini Data mulai hari ini hingga 15 menit sebelum laporan dijalankan
Kemarin Data dari hari sebelumnya.
Minggu Ini Data dari minggu ini.
Minggu Terakhir Data dari minggu sebelumnya.
Bulan Ini Data dari bulan berjalan.
Bulan Terakhir Data dari bulan sebelumnya.
Kuartal Ini Data dari kuartal saat ini

Urutan Urutkan #

Nilai Deskripsi
Naik 1
Turun 2