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

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

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

ส่วนประกอบของคําขอ/การตอบสนอง REST API

คู่คําขอ/การตอบสนอง REST API สามารถแยกออกเป็นห้าองค์ประกอบ:

• 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
  • สตริงคิวรี (ไม่บังคับ): ให้พารามิเตอร์ง่ายๆ อื่นๆ เช่น เวอร์ชัน API หรือเกณฑ์การเลือกทรัพยากร

• ช่องส่วนหัวของข้อความคําขอ HTTP:

  • วิธีการ HTTP ที่จําเป็น (หรือที่เรียกว่าการดําเนินการหรือคํากริยา) ซึ่งจะบอกบริการว่าคุณกําลังร้องขอการดําเนินการประเภทใด Reporting Services 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 (หรือที่เรียกว่าข้อกําหนด swagger) และเอกสารประกอบมีอยู่ใน Microsoft Learn

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

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

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

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

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

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