PureBasic / Microsoft Graph / Refine results with numeric aggregations
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "Requests": [
; {
; "entityTypes": [
; "listItem"
; ],
; "query": {
; "queryString": "contoso"
; },
; "aggregations": [
; {
; "field": "Size",
; "size": 15,
; "bucketDefinition": {
; "sortBy": "keyAsNumber",
; "isDescending": "true",
; "minimumCount": 0,
; "ranges": [
; {
; "to": "100"
; },
; {
; "from": "100",
; "to": "1000"
; },
; {
; "from": "1000"
; }
; ]
; }
; }
; ]
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"Requests[0].entityTypes[0]","listItem")
CkJsonObject::ckUpdateString(json,"Requests[0].query.queryString","contoso")
CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].field","Size")
CkJsonObject::ckUpdateInt(json,"Requests[0].aggregations[0].size",15)
CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].bucketDefinition.sortBy","keyAsNumber")
CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].bucketDefinition.isDescending","true")
CkJsonObject::ckUpdateInt(json,"Requests[0].aggregations[0].bucketDefinition.minimumCount",0)
CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].bucketDefinition.ranges[0].to","100")
CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].bucketDefinition.ranges[1].from","100")
CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].bucketDefinition.ranges[1].to","1000")
CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].bucketDefinition.ranges[2].from","1000")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://graph.microsoft.com/beta/search/query","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"Requests": [
{
"entityTypes": [
"listItem"
],
"query": {
"queryString": "contoso"
},
"aggregations": [
{
"field": "Size",
"size": 15,
"bucketDefinition": {
"sortBy": "keyAsNumber",
"isDescending": "true",
"minimumCount": 0,
"ranges": [
{
"to": "100"
},
{
"from": "100",
"to": "1000"
},
{
"from": "1000"
}
]
}
}
]
}
]
}'
https://graph.microsoft.com/beta/search/query
Postman Collection Item JSON
{
"name": "Refine results with numeric aggregations",
"event": [
{
"listen": "test",
"script": {
"exec": [
"try {\r",
" if (responseBody.indexOf(\"InvalidAuthenticationToken\") !== -1)\r",
" {\r",
" console.log(\"You need to run *On behalf of a User | Get User Access Token* request first.\");\r",
" }\r",
" else\r",
" {\r",
" if (pm.response.status === \"Forbidden\")\r",
" {\r",
" console.log(\"You need to add user delegated permissions in your application to at least *Files.ReadWrite* in portal.azure.com and then consent as user or Grant admin consent in portal. And re-run *On behalf of a User | Get User Access Token* request to update access token. \");\r",
" }\r",
" }\r",
"}\r",
"catch (e) {\r",
" console.log(e);\r",
"}\r",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"Requests\": [\n {\n \"entityTypes\": [\n \"listItem\"\n ],\n \"query\": {\n \"queryString\": \"contoso\"\n },\n \"aggregations\": [\n {\n \"field\": \"Size\",\n \"size\": 15,\n \"bucketDefinition\": {\n \"sortBy\": \"keyAsNumber\",\n \"isDescending\": \"true\",\n \"minimumCount\": 0,\n \"ranges\": [\n {\n \"to\": \"100\"\n },\n {\n \"from\": \"100\",\n \"to\": \"1000\"\n },\n {\n \"from\": \"1000\"\n }\n ]\n }\n }\n ]\n }\n ]\n}"
},
"url": {
"raw": "https://graph.microsoft.com/beta/search/query",
"protocol": "https",
"host": [
"graph",
"microsoft",
"com"
],
"path": [
"beta",
"search",
"query"
]
}
},
"response": [
]
}
