แชร์ผ่าน

พัฒนาด้วย REST API สําหรับเซิร์ฟเวอร์รายงาน Power BI

  • บทความ

เซิร์ฟเวอร์รายงาน Power BI สนับสนุนการถ่ายโอนสถานะตัวแทน (REST) API REST API เป็นจุดบริการที่สนับสนุนการดําเนินการ HTTP (วิธีการ) ซึ่งให้สร้าง เรียกใช้ อัปเดต หรือลบทรัพยากรภายในเซิร์ฟเวอร์รายงาน

REST API ให้การเข้าถึงวัตถุทางโปรแกรมในแค็ตตาล็อกเซิร์ฟเวอร์รายงาน Power BI ตัวอย่างของวัตถุ คือ โฟลเดอร์ รายงาน KPI แหล่งข้อมูล ชุดข้อมูล แผนการรีเฟรช การสมัครใช้งาน และอื่น ๆ เมื่อใช้ REST API คุณสามารถนําทางลําดับชั้นของโฟลเดอร์ ค้นหาเนื้อหาของโฟลเดอร์ หรือดาวน์โหลดข้อกําหนดของรายงาน คุณยังสามารถสร้าง อัปเดต และลบวัตถุได้ ตัวอย่างของการทํางานกับวัตถุเป็นการอัปโหลดรายงาน ดําเนินการตามแผนการรีเฟรช ลบโฟลเดอร์ และอื่น ๆ

หมายเหตุ

ถ้าคุณสนใจที่จะดูหรือลบข้อมูลส่วนบุคคล โปรดดูคําแนะนําของ Microsoft ในไซต์คําขอเจ้าของข้อมูล Windows สําหรับ GDPR ถ้าคุณกําลังมองหาข้อมูลทั่วไปเกี่ยวกับ GDPR ดูส่วน GDPR ของ Service Trust Portal

คอมโพเนนต์ของคําขอ/การตอบสนอง REST API

สามารถแยกคู่คําขอ/คําตอบ REST API เป็นส่วนประกอบได้ 5 ส่วน:

  • คําขอ URI ซึ่งประกอบด้วย: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string} แม้ว่าคําขอ URI จะรวมอยู่ในส่วนหัวของข้อความคําขอ เรานําส่วนนี้แยกออกต่างหากที่นี่เนื่องจากภาษาหรือเฟรมเวิร์กส่วนใหญ่ต้องการให้คุณส่งส่วนนี้แยกต่างหากจากข้อความคําขอ

    • แบบแผน URI: ระบุโพรโทคอลที่ใช้ในการส่งคําขอ ตัวอย่างเช่น http หรือhttps
    • โฮสต์ URI: ระบุชื่อโดเมนหรือที่อยู่ IP ของเซิร์ฟเวอร์ที่โฮสต์จุดปลายทางบริการ REST เช่นmyserver.contoso.com
    • เส้นทางทรัพยากร: ระบุทรัพยากรหรือคอลเลกชันทรัพยากร ซึ่งอาจรวมถึงเซกเมนต์หลายรายการที่บริการใช้ ในการกําหนดการเลือกทรัพยากรเหล่านั้น ตัวอย่างเช่น: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties สามารถใช้เพื่อรับคุณสมบัติที่ระบุสําหรับ CatalogItem
    • Query string (ตัวเลือก): ให้พารามิเตอร์เพิ่มเติมอย่างง่าย เช่น เกณฑ์การเลือกเวอร์ชันหรือทรัพยากรของ API

  • เขตข้อมูลส่วนหัวของข้อความคําขอ HTTP:

    • เมธอด HTTP ที่จําเป็น (หรือที่เรียกว่าการดําเนินการหรือคํากริยา) ซึ่งบอกบริการว่าคุณกําลังขอการดําเนินการประเภทใด บริการรายงานของ REST API สนับสนุนวิธีการ DELETE, GET, HEAD, PUT, POST และ PATCH
    • เขตข้อมูลส่วนหัวที่เป็นตัวเลือก ตามที่ URI และเมธอด HTTP ต้องการ

  • HTTP เพิ่มเติมร้องขอเขตข้อมูลตัวเนื้อความ เพื่อสนับสนุน URI และการดําเนินการ HTTP ตัวอย่างเช่น การดําเนินการ POST ประกอบด้วยวัตถุที่เข้ารหัส MIME ที่ส่งผ่านเป็นพารามิเตอร์ที่ซับซ้อน สําหรับ POST หรือการดําเนินการ PUT ควรระบุชนิดการเข้ารหัสแบบ MIME สําหรับเนื้อความในส่วนหัวของ Content-type คําขอด้วย บริการบางอย่างกําหนดให้คุณใช้ MIME บางชนิด เช่นapplication/json

  • เขตข้อมูลส่วนหัวของข้อความคําตอบ HTTP:

    • รหัสสถานะ HTTP ตั้งแต่รหัสความสําเร็จ 2xx ไปจนถึงรหัสข้อผิดพลาด 4xx หรือ 5xx อีกวิธีหนึ่งคือ อาจส่งกลับรหัสสถานะที่บริการกําหนด ตามที่ระบุในเอกสาร API
    • เขตข้อมูลส่วนหัวที่เป็นตัวเลือก ตามที่จําเป็นเพื่อสนับสนุนการตอบสนองของคําขอ เช่น Content-type ส่วนหัวของคําตอบ

  • เขตข้อมูลเนื้อหาของข้อความคําตอบ HTTP เพิ่มเติม:

    • วัตถุตอบสนองที่เข้ารหัส MIME จะถูกส่งกลับในตัวเนื้อหาคําตอบ HTTP เช่นคําตอบจาก GET เมธอดที่กําลังส่งกลับข้อมูล โดยทั่วไปแล้ว วัตถุเหล่านี้จะถูกส่งกลับในรูปแบบที่มีโครงสร้าง เช่น JSON หรือ XML ตามที่ระบุโดยส่วนหัวของ Content-type คําตอบ

เอกสาร API

เรียกใช้ REST API ที่ทันสมัยสําหรับเอกสาร API ที่ทันสมัย REST API ถูกสร้างขึ้นบนข้อมูลจําเพาะของ OpenAPI (a.k.a ข้อกําหนด swagger) และเอกสารมีพร้อมใช้งานบน Microsoft Learn

การทดสอบการเรียกใช้ API

เครื่องมือสําหรับการทดสอบข้อความคําขอ/คําตอบ HTTP คือ Fiddler Fiddler คือ พร็อกซี่ที่ดีบักเว็บฟรีที่สามารถดักคําขอ REST ของคุณ ทําให้วิเคราะห์ข้อความคําขอ/ คําตอบ HTTP ได้อย่างง่ายดาย

เนื้อหาที่เกี่ยวข้อง

ตรวจทาน API ที่พร้อมใช้งานบน Microsoft Learn

มีตัวอย่างบน GitHub ตัวอย่างรวมถึงแอป HTML5 ที่สร้างขึ้นบน TypeScript, React และ webpack พร้อมกับตัวอย่าง PowerShell

มีคำถามเพิ่มเติมหรือไม่? ลองถามชุมชน Power BI