Chilkat Online Tools

C++ / Cognite API v1 / Search assets

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>

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

    CkHttp http;
    bool success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "filter": {
    //     "parentIds": [
    //       1293812938,
    //       293823982938
    //     ]
    //   },
    //   "search": {
    //     "name": "flow",
    //     "description": "upstream"
    //   }
    // }

    CkJsonObject json;
    json.UpdateInt("filter.parentIds[0]",1293812938);
    json.UpdateInt("filter.parentIds[1]",293823982938);
    json.UpdateString("search.name","flow");
    json.UpdateString("search.description","upstream");

    http.SetRequestHeader("content-type","application/json");
    http.SetRequestHeader("api-key","{{api-key}}");

    CkHttpResponse *resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/assets/search","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    std::cout << resp->get_StatusCode() << "\r\n";
    std::cout << resp->bodyStr() << "\r\n";
    delete resp;
    }

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{"filter":{"parentIds":[1293812938,293823982938]},"search":{"name":"flow","description":"upstream"}}'
https://domain.com/api/v1/projects/{{project}}/assets/search

Postman Collection Item JSON

{
  "id": "searchAssets",
  "name": "Search assets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "assets",
        "search"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "description": "Fulltext search for assets based on result relevance. Primarily meant\nfor human-centric use-cases, not for programs, since matching and\nordering may change over time. Additional filters can also be\nspecified. This operation does not support pagination.",
    "body": {
      "mode": "raw",
      "raw": "{\"filter\":{\"parentIds\":[1293812938,293823982938]},\"search\":{\"name\":\"flow\",\"description\":\"upstream\"}}"
    }
  }
}