Chilkat Online Tools

phpAx / Microsoft Graph / Search with multi-level collapse

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// 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": "cat"
//       },
//       "fields": [
//         "title",
//         "createdBy"
//       ],
//       "collapseProperties": [
//         {
//           "fields": [
//             "title"
//           ],
//           "limit": 3
//         },
//         {
//           "fields": [
//             "createdBy"
//           ],
//           "limit": 2
//         }
//       ]
//     }
//   ]
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('requests[0].entityTypes[0]','listItem');
$json->UpdateString('requests[0].query.queryString','cat');
$json->UpdateString('requests[0].fields[0]','title');
$json->UpdateString('requests[0].fields[1]','createdBy');
$json->UpdateString('requests[0].collapseProperties[0].fields[0]','title');
$json->UpdateInt('requests[0].collapseProperties[0].limit',3);
$json->UpdateString('requests[0].collapseProperties[1].fields[0]','createdBy');
$json->UpdateInt('requests[0].collapseProperties[1].limit',2);

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://graph.microsoft.com/beta/search/query','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "requests": [
        {
            "entityTypes": [
                "listItem"
            ],
            "query": {
                "queryString": "cat"
            },
            "fields": [
                "title",
                "createdBy"
            ],
            "collapseProperties": [
                {
                    "fields": [
                        "title"
                    ],
                    "limit": 3
                },
                {
                    "fields": [
                        "createdBy"
                    ],
                    "limit": 2
                }
            ]
        }
    ]
}'
https://graph.microsoft.com/beta/search/query

Postman Collection Item JSON

{
  "name": "Search with multi-level collapse",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"requests\": [\r\n        {\r\n            \"entityTypes\": [\r\n                \"listItem\"\r\n            ],\r\n            \"query\": {\r\n                \"queryString\": \"cat\"\r\n            },\r\n            \"fields\": [\r\n                \"title\",\r\n                \"createdBy\"\r\n            ],\r\n            \"collapseProperties\": [\r\n                {\r\n                    \"fields\": [\r\n                        \"title\"\r\n                    ],\r\n                    \"limit\": 3\r\n                },\r\n                {\r\n                    \"fields\": [\r\n                        \"createdBy\"\r\n                    ],\r\n                    \"limit\": 2\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://graph.microsoft.com/beta/search/query",
      "protocol": "https",
      "host": [
        "graph",
        "microsoft",
        "com"
      ],
      "path": [
        "beta",
        "search",
        "query"
      ]
    }
  },
  "response": [
  ]
}