{"id":1975,"date":"2018-11-05T10:00:19","date_gmt":"2018-11-05T10:00:19","guid":{"rendered":"https:\/\/developer.microsoft.com\/en-us\/office\/blogs\/?p=1975"},"modified":"2018-11-05T10:00:19","modified_gmt":"2018-11-05T10:00:19","slug":"30daysmsgraph-day-5-query-parameters-part-1","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/30daysmsgraph-day-5-query-parameters-part-1\/","title":{"rendered":"30DaysMSGraph \u2013 Day 5 \u2013 Query Parameters Part 1"},"content":{"rendered":"

List of all posts in the #30DaysMSGraph series<\/a><\/p>\n

In day 4<\/a> we discussed the syntax for Microsoft Graph requests.\u00a0 Today we’ll begin looking at query parameters available for requests against Microsoft Graph.\u00a0 For a full listing of the query parameters available and additional information \/ examples please see the full documentation: Use query parameters to customize responses<\/a>.<\/p>\n

\"\"<\/p>\n

Filter<\/a><\/h3>\n

Filter is one of the more common query parameters that you may use or encounter.\u00a0 Filter retrieves a subset of rows from the total results that match the specified conditions.<\/p>\n

Syntax<\/strong><\/p>\n

<baseGraphQuery>?$filter=<conditions><\/p>\n

Ex.<\/strong> \u2013 Get users whose display name starts with “A”<\/p>\n

https:\/\/graph.microsoft.com\/v1.0\/users?$filter=startswith(displayName,’A’)<\/p>\n

 <\/p>\n

Select<\/a><\/h3>\n

Select allows for retrieving a subset or superset of properties rather than the default properties.\u00a0 This can be especially helpful if you are returning many records that have a high number of default properties returned.\u00a0 Reduce memory usage and network bandwidth usage by limiting the number of properties returned to only the ones that your app needs.<\/p>\n

Syntax<\/strong><\/p>\n

<baseGraphQuery>?$select=<property1>,<property2>,\u2026,<propertyN><\/p>\n

Ex.<\/strong> \u2013 Get name, size, and webUrl of logged in user’s OneDrive site files<\/p>\n

https:\/\/graph.microsoft.com\/v1.0\/me\/drive\/root\/children?$select=name,size,webUrl<\/p>\n

 <\/p>\n

OrderBy<\/a><\/h3>\n

OrderBy will sort the results returned from a query using the specified property.\u00a0 Certain APIs do support multiple properties to sort on.<\/p>\n

Syntax<\/strong><\/p>\n

<baseGraphQuery>?$orderby=<property1>,<property2>,\u2026,<propertyN><\/p>\n

Ex.<\/strong> \u2013 Get logged in user’s contacts sorted by birthday (default ascending)<\/p>\n

https:\/\/graph.microsoft.com\/v1.0\/me\/contacts?$orderby=birthday<\/p>\n

 <\/p>\n

Additionally, you can specify ascending or descending order by appending a space plus “asc” (default in most cases) or “desc” to the property name.<\/p>\n

Ex.<\/strong> \u2013 Get logged in user’s contacts sorted by birthday descending.<\/p>\n

https:\/\/graph.microsoft.com\/v1.0\/me\/contacts?$orderby=birthday desc<\/p>\n

 <\/p>\n

Format<\/a><\/h3>\n

Specific endpoints from Microsoft Graph will offer the ability to return results in different formats.\u00a0 This might include CSV (comma separated value) downloadable files, JSON (JavaScript object notation), or other popular formats.\u00a0 Endpoints that support the Format query parameter will default to one format but allow alternate supported formats to be requested.<\/p>\n

Syntax<\/strong><\/p>\n

<baseGraphQuery>?$format=<formatValue><\/p>\n

Ex.<\/strong> \u2013 Get report of Office 365 Group activity in JSON format<\/p>\n

https:\/\/graph.microsoft.com\/beta\/reports\/getOffice365GroupsActivityGroupCounts(period=’D7′)?$format=application\/json<\/p>\n

Ex.<\/strong> \u2013 Get report of Office 365 Group activity in CSV format<\/p>\n

https:\/\/graph.microsoft.com\/beta\/reports\/getOffice365GroupsActivityGroupCounts(period=’D7′)?$format=text\/csv<\/p>\n

Note: To properly test out this call you will need to log into the Graph Explorer as an Office 365 Global Administrator or an Azure AD Administrator who can grant OAuth permissions to an account.\u00a0 For the time being simply note the syntax.<\/em><\/p>\n

 <\/p>\n

Try It Out<\/h2>\n

Use the query parameters covered today to filter, sort, and specify columns.\u00a0 Navigate to the Graph Explorer<\/a>.\u00a0 Execute the following commands.<\/p>\n

Day 5 repo link<\/a><\/p>\n

    \n
  1. Get logged in user’s high priority emails.\n