Chilkat Online Tools

C / Cognite API v1 / Retrieve time series

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;

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

    http = CkHttp_Create();

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

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

    // {
    //   "items": [
    //     {
    //       "id": 6075144121281512
    //     },
    //     {
    //       "externalId": "irure ipsum"
    //     }
    //   ],
    //   "ignoreUnknownIds": false
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateInt(json,"items[0].id",123);
    CkJsonObject_UpdateString(json,"items[1].externalId","irure ipsum");
    CkJsonObject_UpdateBool(json,"ignoreUnknownIds",FALSE);

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

    resp = CkHttp_PostJson3(http,"https://domain.com/api/v1/projects/{{project}}/timeseries/byids","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);

    }

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "id": 6075144121281512
        },
        {
            "externalId": "irure ipsum"
        }
    ],
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/byids

Postman Collection Item JSON

{
  "id": "getTimeSeriesByIds",
  "name": "Retrieve time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "byids"
      ],
      "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": "Retrieve one or more time series by ID or external ID. The time series are returned in the same order as in the request.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"id\": 6075144121281512\n        },\n        {\n            \"externalId\": \"irure ipsum\"\n        }\n    ],\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}