Chilkat Online Tools

PureBasic / Microsoft Graph / Apply refined query passing the aggregationToken

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": [
    ;         "driveItem"
    ;       ],
    ;       "query": {
    ;         "queryString": "contoso"
    ;       },
    ;       "aggregationFilters": [
    ;         "contentclass:\"5354535f4c6973744974656d5f446f63756d656e744c696272617279\"",
    ;         "FileType:\"646f6378\""
    ;       ],
    ;       "aggregations": [
    ;         {
    ;           "field": "FileType",
    ;           "size": 20,
    ;           "bucketDefinition": {
    ;             "sortBy": "count",
    ;             "isDescending": "true",
    ;             "minimumCount": 0
    ;           }
    ;         },
    ;         {
    ;           "field": "contentclass",
    ;           "size": 15,
    ;           "bucketDefinition": {
    ;             "sortBy": "keyAsString",
    ;             "isDescending": "true",
    ;             "minimumCount": 0
    ;           }
    ;         }
    ;       ]
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"Requests[0].entityTypes[0]","driveItem")
    CkJsonObject::ckUpdateString(json,"Requests[0].query.queryString","contoso")
    CkJsonObject::ckUpdateString(json,"Requests[0].aggregationFilters[0]","contentclass:" + Chr(34) + "5354535f4c6973744974656d5f446f63756d656e744c696272617279" + Chr(34))
    CkJsonObject::ckUpdateString(json,"Requests[0].aggregationFilters[1]","FileType:" + Chr(34) + "646f6378" + Chr(34))
    CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].field","FileType")
    CkJsonObject::ckUpdateInt(json,"Requests[0].aggregations[0].size",20)
    CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[0].bucketDefinition.sortBy","count")
    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[1].field","contentclass")
    CkJsonObject::ckUpdateInt(json,"Requests[0].aggregations[1].size",15)
    CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[1].bucketDefinition.sortBy","keyAsString")
    CkJsonObject::ckUpdateString(json,"Requests[0].aggregations[1].bucketDefinition.isDescending","true")
    CkJsonObject::ckUpdateInt(json,"Requests[0].aggregations[1].bucketDefinition.minimumCount",0)

    ; 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": [
                "driveItem"
            ],
            "query": {
                "queryString": "contoso"
            },
            "aggregationFilters": [
                "contentclass:\"ǂǂ5354535f4c6973744974656d5f446f63756d656e744c696272617279\"",
                "FileType:\"ǂǂ646f6378\""                
            ],
            "aggregations": [
                {
                    "field": "FileType",
                    "size": 20,
                    "bucketDefinition": {
                        "sortBy": "count",
                        "isDescending": "true",
                        "minimumCount": 0
                    }
                },
                {
                    "field": "contentclass",
                    "size": 15,
                    "bucketDefinition": {
                        "sortBy": "keyAsString",
                        "isDescending": "true",
                        "minimumCount": 0
                    }
                }
            ]
        }
    ]
}'
https://graph.microsoft.com/beta/search/query

Postman Collection Item JSON

{
  "name": "Apply refined query passing the aggregationToken",
  "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                \"driveItem\"\n            ],\n            \"query\": {\n                \"queryString\": \"contoso\"\n            },\n            \"aggregationFilters\": [\n                \"contentclass:\\\"ǂǂ5354535f4c6973744974656d5f446f63756d656e744c696272617279\\\"\",\n                \"FileType:\\\"ǂǂ646f6378\\\"\"                \n            ],\n            \"aggregations\": [\n                {\n                    \"field\": \"FileType\",\n                    \"size\": 20,\n                    \"bucketDefinition\": {\n                        \"sortBy\": \"count\",\n                        \"isDescending\": \"true\",\n                        \"minimumCount\": 0\n                    }\n                },\n                {\n                    \"field\": \"contentclass\",\n                    \"size\": 15,\n                    \"bucketDefinition\": {\n                        \"sortBy\": \"keyAsString\",\n                        \"isDescending\": \"true\",\n                        \"minimumCount\": 0\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": [
  ]
}