Chilkat Online Tools

C# / Cognite API v1 / Search assets

Back to Collection Items

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

Chilkat.Http http = new Chilkat.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"
//   }
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
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}}");

Chilkat.HttpResponse resp = new Chilkat.HttpResponse();
success = http.HttpJson("POST","https://domain.com/api/v1/projects/{{project}}/assets/search",json,"application/json",resp);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);

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\"}}"
    }
  }
}