Chilkat Online Tools

PureBasic / Microsoft Graph / Search result template

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": [
    ;         "externalItem"
    ;       ],
    ;       "contentSources": [
    ;         "/external/connections/sampleConnectionId"
    ;       ],
    ;       "query": {
    ;         "queryString": "sample"
    ;       },
    ;       "resultTemplateOptions": {
    ;         "enableResultTemplate": true
    ;       }
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"requests[0].entityTypes[0]","externalItem")
    CkJsonObject::ckUpdateString(json,"requests[0].contentSources[0]","/external/connections/sampleConnectionId")
    CkJsonObject::ckUpdateString(json,"requests[0].query.queryString","sample")
    CkJsonObject::ckUpdateBool(json,"requests[0].resultTemplateOptions.enableResultTemplate",1)

    ; 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": [
                "externalItem"
            ],
            "contentSources": [
                "/external/connections/sampleConnectionId"
            ],
            "query": {
                "queryString": "sample"
            },
            "resultTemplateOptions": {
                "enableResultTemplate": true
            }
        }
    ]
}'
https://graph.microsoft.com/beta/search/query

Postman Collection Item JSON

{
  "name": "Search result template",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"requests\": [\r\n        {\r\n            \"entityTypes\": [\r\n                \"externalItem\"\r\n            ],\r\n            \"contentSources\": [\r\n                \"/external/connections/sampleConnectionId\"\r\n            ],\r\n            \"query\": {\r\n                \"queryString\": \"sample\"\r\n            },\r\n            \"resultTemplateOptions\": {\r\n                \"enableResultTemplate\": true\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": [
  ]
}