คิวรี Microsoft Graph โดยใช้ REST

เสร็จสมบูรณ์เมื่อ

Microsoft Graph เป็น API เว็บ RESTful ที่ช่วยให้คุณสามารถเข้าถึงทรัพยากรบริการระบบคลาวด์ของ Microsoft หลังจากที่คุณลงทะเบียนแอปของคุณและรับโทเค็นการรับรองความถูกต้องสําหรับผู้ใช้หรือบริการ คุณสามารถร้องขอไปยัง API ของ Microsoft Graph ได้

API ของ Microsoft Graph จะกําหนดทรัพยากร วิธีการ และการแจกแจงส่วนใหญ่ใน namespace OData microsoft.graphในเมตาดาต้า ของ microsoft Graph มีการกําหนดชุด API สองสามชุดในเนมสเปซย่อย เช่น เรียกใช้ระเบียน API ซึ่งกําหนดทรัพยากร เช่น callRecord ใน microsoft.graph.callRecords

เว้นแต่จะระบุไว้อย่างชัดเจนในหัวข้อที่สอดคล้องกัน สมมติว่า ชนิด เมธอด และการแจกแจงเป็นส่วนหนึ่งของ microsoft.graph namespace

เรียกใช้เมธอด REST API

หากต้องการอ่านจากหรือเขียนไปยังทรัพยากร เช่น ผู้ใช้หรือข้อความอีเมล ให้สร้างคําขอที่มีลักษณะดังต่อไปนี้:

{HTTP method} https://graph.microsoft.com/{version}/{resource}?{query-parameters}

คอมโพเนนต์ของคําขอประกอบด้วย:

• {HTTP method} - เมธอด HTTP ที่ใช้ในคําขอไปยัง Microsoft Graph
• {version} - เวอร์ชันของ Microsoft Graph API ที่แอปพลิเคชันของคุณกําลังใช้งาน
• {resource} - ทรัพยากรใน Microsoft Graph ที่คุณกําลังอ้างอิง
• {query-parameters} - ตัวเลือกคิวรี OData ทางเลือกหรือพารามิเตอร์เมธอด REST ที่กําหนดการตอบสนองเอง

หลังจากที่คุณทําการร้องขอ การตอบกลับจะถูกส่งกลับที่มี:

• รหัสสถานะ - รหัสสถานะ HTTP ที่แสดงความสําเร็จหรือล้มเหลว
• ข้อความตอบสนอง - ข้อมูลที่คุณร้องขอหรือผลลัพธ์ของการดําเนินการ ข้อความตอบสนองอาจว่างเปล่าสําหรับการดําเนินการบางอย่าง
• nextLink - ถ้าคําขอของคุณส่งกลับข้อมูลจํานวนมาก คุณจําเป็นต้องทําเพจโดยใช้ URL ที่ส่งกลับมาใน @odata.nextLink

วิธีการ HTTP

Microsoft Graph ใช้วิธีการ HTTP ในคําขอของคุณเพื่อกําหนดว่าคําขอของคุณกําลังทําอะไร API สนับสนุนวิธีการต่อไปนี้

วิธี	คำอธิบาย
รับ	อ่านข้อมูลจากทรัพยากร
ประกาศ	สร้างทรัพยากรใหม่ หรือดําเนินการ
ปะ	อัปเดตทรัพยากรด้วยค่าใหม่
วาง	แทนที่ทรัพยากรด้วยทรัพยากรใหม่
ลบ	ลบทรัพยากร

• สําหรับวิธีการ CRUD GET และ DELETEไม่จําเป็นต้องมีเนื้อความคําขอ
• วิธี POST, PATCHและ PUT ต้องการเนื้อความคําขอที่ระบุในรูปแบบ JSON ที่มีข้อมูลเพิ่มเติม เช่น ค่าสําหรับคุณสมบัติของทรัพยากร

เวอร์ชัน

ในขณะนี้ Microsoft Graph สนับสนุนสองเวอร์ชัน: v1.0 และ beta

• v1.0 รวมถึง API ที่พร้อมใช้งานโดยทั่วไป ใช้เวอร์ชัน v1.0 สําหรับแอปการผลิตทั้งหมด
• beta รวมถึง API ที่กําลังอยู่ในช่วงการแสดงตัวอย่าง เนื่องจากเราอาจนําการเปลี่ยนแปลงแบบเบต้า API ของเรามาใช้เราขอแนะนําให้คุณใช้เวอร์ชันเบต้าเพื่อทดสอบแอปที่อยู่ในระหว่างการพัฒนาเท่านั้น อย่าใช้ API รุ่นเบต้าในแอปการผลิตของคุณ

ทรัพยากร

ทรัพยากรสามารถเป็นเอนทิตีหรือชนิดที่ซับซ้อน โดยทั่วไปแล้วจะกําหนดด้วยคุณสมบัติ เอนทิตีแตกต่างจากชนิดที่ซับซ้อนโดยการรวมคุณสมบัติ id เสมอ

URL ของคุณรวมถึงทรัพยากรที่คุณกําลังโต้ตอบด้วยในคําขอ เช่น meผู้ใช้กลุ่มไดรฟ์และไซต์ บ่อยครั้งแหล่งข้อมูลระดับบนสุดยังรวมถึง ความสัมพันธ์ ซึ่งคุณสามารถใช้เพื่อเข้าถึงทรัพยากรอื่น ๆ เช่น me/messages หรือ me/drive คุณยังสามารถโต้ตอบกับทรัพยากรโดยใช้วิธีการ ตัวอย่างเช่น เมื่อต้องการส่งอีเมล ให้ใช้ me/sendMail

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

พารามิเตอร์คิวรี

พารามิเตอร์คิวรีอาจเป็นตัวเลือกคิวรีระบบ OData หรือสตริงอื่น ๆ ที่เมธอดยอมรับในการปรับแต่งการตอบกลับ

คุณสามารถใช้ตัวเลือกคิวรีระบบ OData ที่เลือกได้เพื่อรวมคุณสมบัติให้มากกว่าหรือน้อยกว่าการตอบสนองเริ่มต้น คุณสามารถกรองการตอบกลับสําหรับรายการที่ตรงกับคิวรีแบบกําหนดเอง หรือใส่พารามิเตอร์อื่นสําหรับเมธอด

ตัวอย่างเช่น การเพิ่มพารามิเตอร์ filter ต่อไปนี้จะจํากัดข้อความที่แสดงด้วยคุณสมบัติ emailAddress ของ jon@contoso.com

GET https://graph.microsoft.com/v1.0/me/messages?filter=emailAddress eq 'jon@contoso.com'

แหล่งข้อมูลอื่น ๆ

ต่อไปนี้คือลิงก์ไปยังเครื่องมือบางอย่างที่คุณสามารถใช้เพื่อสร้างและทดสอบคําขอโดยใช้ Microsoft Graph API

• ตัวสํารวจกราฟ
• Postman