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

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

In Day 5<\/a> we began discussing the query parameters available for Microsoft Graph requests.\u00a0 Today we’ll continue looking at query parameters available for requests against Microsoft Graph.<\/p>\n

\"\"<\/p>\n

Count<\/a><\/h3>\n

Count is a useful query parameter to use when your app needs to know the number of records that exist for a given endpoint.\u00a0 The count of records will be returned as a property.<\/p>\n

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

<baseGraphQuery>?$count=<boolean><\/p>\n

Ex.<\/strong> \u2013 Get number of contacts for the logged in user<\/p>\n

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

 <\/p>\n

Top<\/a><\/h3>\n

Queries to Microsoft Graph sometimes have more records in the result than can be returned in a single response.\u00a0 You can use the Top query parameter to set the maximum number of results to be returned.<\/p>\n

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

<baseGraphQuery>?$top=<int><\/p>\n

Ex.<\/strong> \u2013 Get the logged in user’s OneNote notebooks, 2 per page<\/p>\n

https:\/\/graph.microsoft.com\/v1.0\/me\/onenote\/notebooks?$top=2<\/p>\n

 <\/p>\n

Skip<\/a><\/h3>\n

Skip is another query parameter primarily used when paging results back from Microsoft Graph.\u00a0 An @odata.nextlink will typically contain a Skip or SkipToken query parameter.\u00a0 When used by itself a Skip query parameter will skip the first N number of items in the results.<\/p>\n

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

<baseGraphQuery>?$skip=<int><\/p>\n

Ex.<\/strong> \u2013 Get the logged in user’s emails starting with the 11th<\/sup> email<\/p>\n

https:\/\/graph.microsoft.com\/v1.0\/me\/messages?$skip=10<\/p>\n

 <\/p>\n

Search<\/a><\/h3>\n

Search is like Filter in that you are restricting the response to a subset of results.\u00a0 Search has the benefit of allowing for free-text search expressions at the cost of only being available for the “message” and “person” resources.<\/p>\n

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

<baseGraphQuery>?$search=<searchCriteria><\/p>\n

Ex.<\/strong> \u2013 Get the logged in user’s emails that contain the word “Contoso” in the message body<\/p>\n

https:\/\/graph.microsoft.com\/v1.0\/me\/messages?$search=”body:Contoso”<\/p>\n

 <\/p>\n

Expand<\/a><\/h3>\n

As mentioned on Day 4<\/a>, many times entities on Microsoft Graph will have relationships to each other.\u00a0 Use the Expand query parameter to return more information about complex data types or related entities.<\/p>\n

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

<baseGraphQuery>?$expand=<property><\/p>\n

Ex.<\/strong> \u2013 Get expanded information for logged in user’s manager<\/p>\n

https:\/\/graph.microsoft.com\/beta\/me?$expand=manager<\/p>\n

Note: this example uses the beta endpoint as User entities only support the Expand query parameter on the beta version of APIs as of time of writing (Nov 2018).<\/em><\/p>\n

 <\/p>\n

Try It Out<\/h2>\n

Use query parameters we covered today to count, search, expand, and restrict results.\u00a0 Navigate to the Graph Explorer<\/a>.\u00a0 Execute the following commands.<\/p>\n

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

    \n
  1. Get number of contacts for the logged in user\n