retrieveRecord (การอ้างอิง API ไคลเอ็นต์)

ดึงข้อมูลเรกคอร์ดตาราง

ไวยากรณ์

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

พารามิเตอร์

ตัวเลือกคิวรี OData สําหรับ retrieveRecord

หากต้องการควบคุมสิ่งที่วิธีการส่งกลับ ให้ใช้ $select ตัวเลือกคิวรีระบบและ $expand OData เมื่อคุณดึงข้อมูลของคุณ

$selectใช้ตัวเลือกคิวรีระบบเพื่อจํากัดคุณสมบัติที่ส่งกลับโดยรวมรายการคั่นด้วยจุลภาคของชื่อคุณสมบัติ การเลือกคุณสมบัติเฉพาะเจาะจงเป็นแนวทางปฏิบัติที่ดีที่สุดเพื่อประสิทธิภาพการทํางานที่สําคัญ ถ้าคุณไม่ได้ระบุคุณสมบัติโดยใช้ $selectเมธอด จะแสดงคุณสมบัติทั้งหมด

$expandใช้ตัวเลือกคิวรีของระบบเพื่อควบคุมว่าจะส่งกลับข้อมูลจากตารางที่เกี่ยวข้องข้อมูลใด ถ้าคุณเพียงแค่ใส่ชื่อของคุณสมบัติการนําทาง คุณจะได้รับคุณสมบัติทั้งหมดสําหรับระเบียนที่เกี่ยวข้อง คุณสามารถจํากัดคุณสมบัติที่ส่งกลับสําหรับระเบียนที่เกี่ยวข้องได้โดยใช้ $select ตัวเลือกแบบสอบถามของระบบในวงเล็บหลังชื่อคุณสมบัติการนําทาง ใช้ตัวเลือกนี้สําหรับคุณสมบัติการนําทางทั้งแบบค่าเดียวและแบบค่าคอลเลกชัน สําหรับออฟไลน์ วิธีการ จะสนับสนุนเฉพาะตัวเลือกที่ซ้อนกัน$selectภายใน$expand

คุณระบุตัวเลือกแบบสอบถามที่ขึ้นต้นด้วย? คุณยังสามารถระบุตัวเลือกแบบสอบถามได้หลายแบบโดยใช้ & เพื่อแยกตัวเลือกแบบสอบถาม เช่น:

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

หากต้องการเรียนรู้วิธีการกําหนดพารามิเตอร์ตัวเลือกสําหรับสถานการณ์การดึงข้อมูลต่างๆ โปรดดู ตัวอย่าง

ค่าที่ส่งกลับ

ในความสําเร็จ วิธีการจะส่งกลับสัญญาที่ประกอบด้วยวัตถุ JSON ที่มีคอลัมน์ที่ดึงมาและค่าของคอลัมน์ดังกล่าว ถ้าไม่มีระเบียนที่ร้องขอ เมธอด จะแสดงข้อผิดพลาด

ตัวอย่าง

ดูตัวอย่างต่อไปนี้:

• ดึงข้อมูลพื้นฐาน
• เรียกใช้ตารางที่เกี่ยวข้องสําหรับอินสแตนซ์ของตารางโดยการขยายคุณสมบัติการนําทางค่าเดียว

ดึงข้อมูลพื้นฐาน

ดึงข้อมูลชื่อและรายได้ของเรกคอร์ดบัญชีที่มีรหัสเรกคอร์ด = 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
    }
);

ตัวอย่างก่อนหน้านี้แสดงข้อความต่อไปนี้ในคอนโซลของคุณ คุณอาจเห็นค่าอื่น ๆ โดยขึ้นอยู่กับข้อมูลของคุณ:

Retrieved values: Name: Sample Account, Revenue: 5000000

เรียกใช้ตารางที่เกี่ยวข้องสําหรับอินสแตนซ์ของตารางโดยการขยายคุณสมบัติการนําทางค่าเดียว

ตัวอย่างต่อไปนี้สาธิตวิธีการเรียกใช้ผู้ติดต่อสําหรับเรกคอร์ดบัญชีที่มีรหัสเรกคอร์ด = a8a19cdd-88df-e311-b8e5-6c3be5a8b200 สําหรับระเบียนผู้ติดต่อที่เกี่ยวข้อง คุณดึงข้อมูลคุณสมบัติ contactid และ fullname เท่านั้น

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

ตัวอย่างก่อนหน้านี้แสดงข้อความต่อไปนี้ในคอนโซลของคุณ คุณอาจเห็นค่าอื่น ๆ โดยขึ้นอยู่กับข้อมูลของคุณ:

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

บทความที่เกี่ยวข้อง

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi