Chilkat Online Tools

delphiAx / Cognite API v1 / Search time series

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;

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

http := TChilkatHttp.Create(Self);

// 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": {
//     "name": "dolor eiusmod nostrud ea cillum",
//     "unit": "sint culpa voluptate",
//     "isString": true,
//     "isStep": true,
//     "metadata": {},
//     "assetIds": [
//       8392988761056162,
//       2911403766826494
//     ],
//     "assetExternalIds": [
//       "esse non aute",
//       "dolor in amet et minim"
//     ],
//     "rootAssetIds": [
//       4628243625090460,
//       3862854227867686
//     ],
//     "assetSubtreeIds": [
//       {
//         "id": 229005040467072
//       },
//       {
//         "externalId": "aute in elit aliquip"
//       }
//     ],
//     "dataSetIds": [
//       {
//         "externalId": "voluptate adipisicing ex in dolore"
//       },
//       {
//         "externalId": "irure laboris consectetur veniam velit"
//       }
//     ],
//     "externalIdPrefix": "veniam",
//     "createdTime": {
//       "max": 11556036,
//       "min": 65169412
//     },
//     "lastUpdatedTime": {
//       "max": 47360518,
//       "min": 36601806
//     }
//   },
//   "search": {
//     "name": "cupi",
//     "description": "aliqua ut mi",
//     "query": "in id fugiat"
//   },
//   "limit": 100
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateString('filter.name','dolor eiusmod nostrud ea cillum');
json.UpdateString('filter.unit','sint culpa voluptate');
json.UpdateBool('filter.isString',1);
json.UpdateBool('filter.isStep',1);
json.UpdateNewObject('filter.metadata');
json.UpdateInt('filter.assetIds[0]',8392988761056162);
json.UpdateInt('filter.assetIds[1]',2911403766826494);
json.UpdateString('filter.assetExternalIds[0]','esse non aute');
json.UpdateString('filter.assetExternalIds[1]','dolor in amet et minim');
json.UpdateInt('filter.rootAssetIds[0]',4628243625090460);
json.UpdateInt('filter.rootAssetIds[1]',3862854227867686);
json.UpdateInt('filter.assetSubtreeIds[0].id',123);
json.UpdateString('filter.assetSubtreeIds[1].externalId','aute in elit aliquip');
json.UpdateString('filter.dataSetIds[0].externalId','voluptate adipisicing ex in dolore');
json.UpdateString('filter.dataSetIds[1].externalId','irure laboris consectetur veniam velit');
json.UpdateString('filter.externalIdPrefix','veniam');
json.UpdateInt('filter.createdTime.max',11556036);
json.UpdateInt('filter.createdTime.min',65169412);
json.UpdateInt('filter.lastUpdatedTime.max',47360518);
json.UpdateInt('filter.lastUpdatedTime.min',36601806);
json.UpdateString('search.name','cupi');
json.UpdateString('search.description','aliqua ut mi');
json.UpdateString('search.query','in id fugiat');
json.UpdateInt('limit',100);

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

resp := http.PostJson3('https://domain.com/api/v1/projects/{{project}}/timeseries/search','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "name": "dolor eiusmod nostrud ea cillum",
        "unit": "sint culpa voluptate",
        "isString": true,
        "isStep": true,
        "metadata": {},
        "assetIds": [
            8392988761056162,
            2911403766826494
        ],
        "assetExternalIds": [
            "esse non aute",
            "dolor in amet et minim"
        ],
        "rootAssetIds": [
            4628243625090460,
            3862854227867686
        ],
        "assetSubtreeIds": [
            {
                "id": 229005040467072
            },
            {
                "externalId": "aute in elit aliquip"
            }
        ],
        "dataSetIds": [
            {
                "externalId": "voluptate adipisicing ex in dolore"
            },
            {
                "externalId": "irure laboris consectetur veniam velit"
            }
        ],
        "externalIdPrefix": "veniam",
        "createdTime": {
            "max": 11556036,
            "min": 65169412
        },
        "lastUpdatedTime": {
            "max": 47360518,
            "min": 36601806
        }
    },
    "search": {
        "name": "cupi",
        "description": "aliqua ut mi",
        "query": "in id fugiat"
    },
    "limit": 100
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/search

Postman Collection Item JSON

{
  "id": "searchTimeSeries",
  "name": "Search time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "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 time series 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": "{\n    \"filter\": {\n        \"name\": \"dolor eiusmod nostrud ea cillum\",\n        \"unit\": \"sint culpa voluptate\",\n        \"isString\": true,\n        \"isStep\": true,\n        \"metadata\": {},\n        \"assetIds\": [\n            8392988761056162,\n            2911403766826494\n        ],\n        \"assetExternalIds\": [\n            \"esse non aute\",\n            \"dolor in amet et minim\"\n        ],\n        \"rootAssetIds\": [\n            4628243625090460,\n            3862854227867686\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 229005040467072\n            },\n            {\n                \"externalId\": \"aute in elit aliquip\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"voluptate adipisicing ex in dolore\"\n            },\n            {\n                \"externalId\": \"irure laboris consectetur veniam velit\"\n            }\n        ],\n        \"externalIdPrefix\": \"veniam\",\n        \"createdTime\": {\n            \"max\": 11556036,\n            \"min\": 65169412\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 47360518,\n            \"min\": 36601806\n        }\n    },\n    \"search\": {\n        \"name\": \"cupi\",\n        \"description\": \"aliqua ut mi\",\n        \"query\": \"in id fugiat\"\n    },\n    \"limit\": 100\n}"
    }
  }
}