Microsoft Graph for Office 365 - 查詢引數(一)

Justin-Liu發表於2018-12-24

部落格地址:http://blog.csdn.net/FoxDave
上一篇我們介紹了Microsoft Graph的查詢語法。本篇我們開始介紹Microsoft Graph中的請求可用的查詢引數。由於篇幅有限,所有的查詢引數可以訪問此頁面檢視。

在這裡插入圖片描述

Filter

Filter是我們使用的較普遍的一個查詢引數。即從總的結果集中通過一些條件篩選出結果的子集。

語法

<baseGraphQuery>?$filter=<conditions>

示例

獲取顯示名以大寫字母A開頭的使用者:
https://graph.microsoft.com/v1.0/users?$filter=startswith(displayName,‘A’)

Select

Select允許獲取預設屬性集合的子集或超集。這對當我們獲取了相當多數量的預設屬性的記錄集時特別有幫助。通過限制返回屬性的數量(只保留我們的應用需要的那些)以降低記憶體和網路頻寬佔用。

語法

<baseGraphQuery>?$select=<property1>,<property2>,…,<propertyN>

示例

獲取登入使用者的OneDrive網站中檔案的名稱、大小和網路URL:
https://graph.microsoft.com/v1.0/me/drive/root/children?$select=name,size,webUrl

OrderBy

OrderBy會對返回的結果以指定的屬性進行排序。某些API支援多屬性排序。

語法

<baseGraphQuery>?$orderby=<property1>,<property2>,…,<propertyN>

示例

獲取當前登入使用者的聯絡人並以生日排序(預設升序):
https://graph.microsoft.com/v1.0/me/contacts?$orderby=birthday

另外,我們可以通過在屬性名後面新增“ asc”或“ desc”來指定升序或者降序。

示例

獲取當前登入使用者的聯絡人並以生日降序排列:
https://graph.microsoft.com/v1.0/me/contacts?$orderby=birthday

Format

指定Microsoft Graph的端點可以提供以不同格式返回結果的能力。這可能包括可下載的CSV檔案、JSON或其他流行的格式。支援格式化查詢引數的端點預設會有一個格式,但是允許我們指定其他支援的格式。

語法

<baseGraphQuery>?$format=<formatValue>

示例

獲取Office 365組活動的報告的JSON格式:
https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityGroupCounts(period=‘D7’)?$format=application/json

獲取Office 365組活動的報告的CSV格式:
https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityGroupCounts(period=‘D7’)?$format=text/csv

注意:本示例需要以Office 365全域性管理員或Azure AD管理員的身份登入Graph資源管理器進行測試。

練習

練習文中介紹到的查詢引數,訪問Microsoft Graph Explorer,執行下面的命令:

  1. 獲取當前使用者高優先順序的郵件。
    https://graph.microsoft.com/v1.0/me/messages?$filter=importance eq ‘High’
  2. 獲取當前使用者OneDrive網站檔案的名稱、大小和URL。
    https://graph.microsoft.com/v1.0/me/drive/root/children?$select=name,size,webUrl
  3. 獲取當前使用者的聯絡人並以生日排序。
    https://graph.microsoft.com/v1.0/me/contacts?$orderby=birthday

在這裡插入圖片描述

相關文章