retrieveRecord (Referensi API Klien)

Mengambil rekaman tabel.

Syntax

Xrm.WebApi.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Parameter-parameternya

Nama Tipe Diperlukan Description
entityLogicalName String Yes Nama logis tabel rekaman yang ingin Anda ambil. Misalnya: account.
id String Yes GUID rekaman tabel yang ingin Anda ambil.
options String Tidak. Opsi kueri sistem OData untuk mengontrol apa yang dikembalikan. Lihat Opsi
successCallback Function Tidak. Fungsi untuk memanggil saat catatan diambil. Objek JSON dengan properti dan nilai yang diambil diteruskan ke fungsi .
errorCallback Function Tidak. Fungsi untuk memanggil saat operasi gagal. Objek dengan properti berikut diteruskan:
- errorCode:Angka. Kode kesalahan sebagai angka desimal positif. Misalnya, kode kesalahan yang didokumenkan sebagai 0x80040333 akan dikembalikan sebagai 2147746611.
- message:Tali. Pesan kesalahan yang menjelaskan masalah.

Opsi

Untuk mengontrol apa yang dikembalikan, gunakan $select opsi kueri sistem OData dan $expand untuk mengambil data Anda.

$select Gunakan opsi kueri sistem untuk membatasi properti yang dikembalikan dengan menyertakan daftar nama properti yang dipisahkan koma. Memilih properti tertentu adalah praktik terbaik performa penting. Jika properti tidak ditentukan menggunakan $select, semua properti dikembalikan.

$expand Gunakan opsi kueri sistem untuk mengontrol data apa dari tabel terkait yang dikembalikan. Jika Anda hanya menyertakan nama properti navigasi, Anda menerima semua properti untuk rekaman terkait. Anda bisa membatasi properti yang dikembalikan untuk rekaman terkait menggunakan $select opsi kueri sistem dalam tanda kurung setelah nama properti navigasi. Gunakan ini untuk properti navigasi bernilai tunggal dan bernilai koleksi . Untuk offline, kami hanya mendukung opsi berlapis $select di $expanddalam .

Anda menentukan opsi kueri yang dimulai dengan ?. Anda juga dapat menentukan beberapa opsi kueri dengan menggunakan & untuk memisahkan opsi kueri. Contohnya:

?$select=name&$expand=primarycontactid($select=contactid,fullname)

Lihat Contoh untuk melihat bagaimana Anda dapat menentukan parameter opsi untuk berbagai skenario pengambilan.

Mengembalikan Nilai

Setelah berhasil, mengembalikan janji yang berisi objek JSON dengan kolom yang diambil dan nilainya. Jika rekaman yang diminta tidak ada, mengembalikan kesalahan.

Examples

Lihat contoh berikut:

Pengambilan dasar

Mengambil nama dan pendapatan rekaman akun dengan ID rekaman = 5531d753-95af-e711-a94e-000d3a11e605.

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name,revenue").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Revenue: " + result.revenue);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Contoh di atas menampilkan teks berikut di konsol Anda; Anda mungkin melihat nilai lain tergantung pada data Anda:

Retrieved values: Name: Sample Account, Revenue: 5000000

Contoh berikut menunjukkan cara mengambil kontak untuk rekaman akun dengan ID rekaman = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. Untuk rekaman kontak terkait, kami hanya mengambil properti contactid dan nama lengkap .

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name&$expand=primarycontactid($select=contactid,fullname)").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Primary Contact ID: " + result.primarycontactid.contactid +
                ", Primary Contact Name: " + result.primarycontactid.fullname);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Contoh di atas menampilkan teks berikut di konsol Anda; Anda mungkin melihat nilai lain tergantung pada data Anda:

Retrieved values: Name: Adventure Works, Primary Contact ID: 49a0e5b9-88df-e311-b8e5-6c3be5a8b200, Primary Contact Name: Adrian Dumitrascu

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi

  • Last updated on