แชร์ผ่าน

ใช้งานส่วนประกอบ API เว็บกับพอร์ทัลตัวอย่าง

  • บทความ

ต่อไปนี้คือตัวอย่างของการใช้ส่วนประกอบของโค้ดที่ใช้ Web API ของพอร์ทัล เพื่อสร้าง, เรียกข้อมูล, อัปเดต, และลบการดำเนินการ ส่วนประกอบแสดงปุ่มสี่ปุ่ม ซึ่งสามารถคลิกเพื่อเรียกใช้การดำเนินการต่างๆ ของ Web API ได้ ผลลัพธ์ของการเรียก Web API ถูกแทรกลงในองค์ประกอบ div ของ HTML ที่ด้านล่างขององค์ประกอบโค้ด

ส่วนประกอบตัวอย่างที่ใช้ Web API ของพอร์ทัล

ข้อกำหนดเบื้องต้น

  • เวอร์ชันพอร์ทัลของคุณต้องเป็น 9.3.10.x หรือสูงกว่า
  • แพคเกจพอร์ทัลเริ่มต้นของคุณต้องเป็น 9.2.2103.x หรือสูงกว่า
  • คุณต้องเปิดใช้งานการตั้งค่าไซต์เพื่อเปิดใช้งานพอร์ทัล Web API สำหรับพอร์ทัลของคุณ การตั้งค่าไซต์สำหรับ Web API
  • ตั้งค่าคอนฟิกความปลอดภัยของตารางโดยใช้สิทธิ์ของตาราง สิทธิ์อนุญาตใช้ตาราง

โค้ด

คุณสามารถดาวน์โหลดส่วนประกอบตัวอย่างที่สมบูรณ์ได้จาก ที่นี่

ตามค่าเริ่มต้น ในตัวอย่างนี้ ส่วนประกอบได้รับการตั้งค่าคอนฟิกให้ดำเนินการสร้าง, เรียกข้อมูล, ตั้งค่าฟิลด์ชื่อและรายได้ในตัวอย่าง Web API

หากต้องการเปลี่ยนการตั้งค่าคอนฟิกเริ่มต้นเป็นตารางหรือคอลัมน์ใดๆ ให้อัปเดตค่าการตั้งค่าคอนฟิกด้านล่างตามที่แสดง

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";

วิธีการ createRecord แสดงปุ่มสามปุ่ม ซึ่งช่วยให้คุณสามารถสร้างเรกคอร์ดลูกค้าองค์กรได้โดยตั้งค่าฟิลด์รายได้เป็นค่าต่างๆ (100, 200, 300)

เมื่อคุณเลือกปุ่มสร้างปุ่มใดปุ่มหนึ่ง ตัวจัดการเหตุการณ์ onClick ของปุ่มจะตรวจสอบค่าของปุ่มที่เลือกและใช้การดำเนินการของ Web API เพื่อสร้างเรกคอร์ดลูกค้าองค์กรโดยมีการตั้งค่าฟิลด์รายได้เป็นค่าของปุ่ม ฟิลด์ชื่อของเรกคอร์ดลูกค้าองค์กรจะถูกตั้งค่าเป็น ส่วนประกอบโค้ดของ Web API (ตัวอย่าง) โดยมี int แบบสุ่มที่ผนวกไปยังส่วนท้ายของสตริง วิธีการติดต่อกลับจากการเรียก Web API ใส่ผลลัพธ์ของการเรียก (สำเร็จหรือล้มเหลว) ลงในผลลัพธ์ของตัวควบคุมแบบกำหนดเอง div

วิธีการ deleteRecord แสดงปุ่มที่จะลบเรกคอร์ดที่เลือกในรายการแบบหล่นลง การควบคุมรายการแบบหล่นลงช่วยให้คุณสามารถเลือกเรกคอร์ดลูกค้าองค์กรที่คุณต้องการลบ เมื่อเลือกเรกคอร์ดลูกค้าองค์กรจากรายการแบบหล่นลง และปุ่ม ลบเรกคอร์ด ถูกเลือก เรกคอร์ดจะถูกลบ วิธีการติดต่อกลับจากการเรียก Web API ใส่ผลลัพธ์ของการเรียก (สำเร็จหรือล้มเหลว) ลงในผลลัพธ์ของตัวควบคุมแบบกำหนดเอง div

FetchXMLretrieveMultiple เมธอดแสดงปุ่มในส่วนประกอบโค้ด เมื่อเรียกใช้ onClick เมธอดของปุ่มนี้ FetchXML จะถูกสร้างขึ้นและส่งผ่านไปยังฟังก์ชัน retrieveMultiple เพื่อคำนวณค่าเฉลี่ยของช่องรายได้สำหรับบัญชีทั้งหมด บันทึก วิธีการติดต่อกลับจากการเรียก Web API ใส่ผลลัพธ์ของการเรียก (สำเร็จหรือล้มเหลว) ลงในผลลัพธ์ของตัวควบคุมแบบกำหนดเอง div

วิธีการ retrieveMultiple ของ OData แสดงปุ่มในส่วนประกอบโค้ด เมื่อวิธีการ onClick ของปุ่มนี้ถูกเรียก สตริง OData จะถูกสร้างขึ้นและส่งผ่านไปยังฟังก์ชัน retrieveMultiple เพื่อดึงเรกคอร์ดลูกค้าองค์กรทั้งหมดที่มีฟิลด์ชื่อที่เหมือนกับ Web API ของส่วนประกอบโค้ด (ตัวอย่าง) ซึ่งเป็นจริงสำหรับเรกคอร์ดลูกค้าองค์กรทั้งหมดที่สร้างโดยส่วนประกอบโค้ดนี้

เมื่อเรียกเรกคอร์ดที่สำเร็จ ส่วนประกอบโค้ดจะมีตรรกะในการนับจำนวนเรกคอร์ดลูกค้าองค์กรที่มีการตั้งค่าฟิลด์รายได้เป็น 100, 200 หรือ 300 และแสดงจำนวนนี้ลงใน div คอนเทนเนอร์สถานะของ OData บนส่วนประกอบโค้ด วิธีการติดต่อกลับจากการเรียก Web API ใส่ผลลัพธ์ของการเรียก (สำเร็จหรือล้มเหลว) ลงในผลลัพธ์ของตัวควบคุมแบบกำหนดเอง div

ดูเพิ่มเติม