Menerapkan sampel komponen Web API portal
Berikut adalah contoh penerapan komponen kode yang menggunakan API Web portal untuk melakukan tindakan buat, ambil, perbarui, dan hapus. Komponen menampilkan empat tombol, yang dapat diklik untuk mengaktifkan tindakan Web API yang berbeda. Hasil dari panggilan Web API diinjeksikan ke elemen div
HTML di bagian bawah komponen kode.
Prasyarat
- Versi portal Anda harus 9.3.10.x atau yang lebih tinggi.
- Paket portal pemula Anda harus 9.2.2103.x atau lebih tinggi.
- Anda harus mengaktifkan pengaturan lokasi untuk mengaktifkan portal web API untuk portal Anda. Pengaturan situs untuk API Web
- Mengkonfigurasi keamanan tabel menggunakan izin tabel. Izin tabel
Kode
Anda dapat mengunduh komponen sampel lengkap dari sini.
Secara default, dalam sampel, komponen dikonfigurasi untuk melakukan pembuatan, pengambilan, atur bidang nama dan pendapatan di contoh API Web.
Untuk mengubah konfigurasi default ke tabel atau kolom mana pun, perbarui nilai konfigurasi di bawah ini seperti ditunjukkan
private static \_entityName = "account";
private static \_requiredAttributeName = "name";
private static \_requiredAttributeValue = "Web API Custom Control (Sample)";
private static \_currencyAttributeName = "revenue";
private static \_currencyAttributeNameFriendlyName = "annual revenue";
Metode createRecord
akan menampilkan tiga tombol, yang memungkinkan Anda membuat rekaman akun dengan bidang pendapatan yang diatur ke nilai yang berbeda (100, 200, 300).
Bila Anda memilih salah satu tombol buat, penanganan aktivitas onClick
tombol akan memeriksa nilai tombol yang dipilih dan menggunakan tindakan Web API untuk membuat rekaman akun dengan bidang pendapatan yang diatur ke nilai tombol tersebut. Bidang nama rekaman akun akan diatur ke komponen kode WEB API (Sampel) dengan lampiran int
acak ke akhir string. Metode panggilan balik dari panggilan Web API menyuntikkan hasil panggilan (keberhasilan atau kegagalan) ke hasil kontrol kustom div
.
Metode deleteRecord
menampilkan tombol yang akan menghapus rekaman yang dipilih di dropdown. Kontrol dropdown memungkinkan Anda memilih rekaman akun yang akan dihapus. Setelah rekaman akun dipilih dari dropdown dan tombol Hapus Rekaman dipilih, rekaman akan dihapus. Metode panggilan balik dari panggilan Web API menyuntikkan hasil panggilan (keberhasilan atau kegagalan) ke hasil kontrol kustom div
.
Metode ini FetchXMLretrieveMultiple
merender tombol dalam komponen kode. Ketika onClick
metode tombol ini dipanggil, FetchXML dihasilkan dan diteruskan ke retrieveMultiple
fungsi untuk menghitung nilai rata-rata bidang pendapatan untuk semua catatan akun. Metode panggilan balik dari panggilan Web API menyuntikkan hasil panggilan (keberhasilan atau kegagalan) ke hasil kontrol kustom div
.
Metode retrieveMultiple
OData menampilkan tombol pada komponen kode. Bila metode onClick
tombol ini dipanggil, string OData dibuat dan diteruskan ke fungsi retrieveMultiple
untuk mengambil semua rekaman akun dengan bidang nama yang seperti komponen kode Web API (Sampel), yang benar untuk semua rekaman akun yang dibuat oleh komponen kode ini.
Saat berhasil mengambil rekaman, komponen kode memiliki logika untuk menghitung seberapa banyak rekaman akun memiliki bidang pendapatan yang diatur ke 100, 200, atau 300, dan menampilkan hitungan ini ke dalam div kontainer status OData pada komponen kode. Metode panggilan balik dari panggilan Web API menyuntikkan hasil panggilan (keberhasilan atau kegagalan) ke hasil kontrol kustom div
.