Chilkat Online Tools

PureBasic / Cognite API v1 / Create time series

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.

    ; {
    ;   "items": [
    ;     {
    ;       "externalId": "Lorem sint adipisicing",
    ;       "name": "anim exercitation amet",
    ;       "legacyName": "dolor velit",
    ;       "isString": false,
    ;       "metadata": {},
    ;       "unit": "ipsum",
    ;       "assetId": 1144756346410214,
    ;       "isStep": false,
    ;       "description": "in in eiusmod quis cillum",
    ;       "securityCategories": [
    ;       ],
    ;       "dataSetId": 3020326818746230
    ;     },
    ;     {
    ;       "externalId": "ullamco et",
    ;       "name": "occaecat amet s",
    ;       "legacyName": "minim nostrud sed laboris",
    ;       "isString": false,
    ;       "metadata": {},
    ;       "unit": "veni",
    ;       "assetId": 7145761864584356,
    ;       "isStep": false,
    ;       "description": "adipisicing magna",
    ;       "securityCategories": [
    ;       ],
    ;       "dataSetId": 5711055041423714
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"items[0].externalId","Lorem sint adipisicing")
    CkJsonObject::ckUpdateString(json,"items[0].name","anim exercitation amet")
    CkJsonObject::ckUpdateString(json,"items[0].legacyName","dolor velit")
    CkJsonObject::ckUpdateBool(json,"items[0].isString",0)
    CkJsonObject::ckUpdateNewObject(json,"items[0].metadata")
    CkJsonObject::ckUpdateString(json,"items[0].unit","ipsum")
    CkJsonObject::ckUpdateInt(json,"items[0].assetId",123)
    CkJsonObject::ckUpdateBool(json,"items[0].isStep",0)
    CkJsonObject::ckUpdateString(json,"items[0].description","in in eiusmod quis cillum")
    CkJsonObject::ckUpdateNewArray(json,"items[0].securityCategories")
    CkJsonObject::ckUpdateInt(json,"items[0].dataSetId",123)
    CkJsonObject::ckUpdateString(json,"items[1].externalId","ullamco et")
    CkJsonObject::ckUpdateString(json,"items[1].name","occaecat amet s")
    CkJsonObject::ckUpdateString(json,"items[1].legacyName","minim nostrud sed laboris")
    CkJsonObject::ckUpdateBool(json,"items[1].isString",0)
    CkJsonObject::ckUpdateNewObject(json,"items[1].metadata")
    CkJsonObject::ckUpdateString(json,"items[1].unit","veni")
    CkJsonObject::ckUpdateInt(json,"items[1].assetId",123)
    CkJsonObject::ckUpdateBool(json,"items[1].isStep",0)
    CkJsonObject::ckUpdateString(json,"items[1].description","adipisicing magna")
    CkJsonObject::ckUpdateNewArray(json,"items[1].securityCategories")
    CkJsonObject::ckUpdateInt(json,"items[1].dataSetId",123)

    CkHttp::ckSetRequestHeader(http,"content-type","application/json")
    CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/projects/{{project}}/timeseries","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 "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "Lorem sint adipisicing",
            "name": "anim exercitation amet",
            "legacyName": "dolor velit",
            "isString": false,
            "metadata": {},
            "unit": "ipsum",
            "assetId": 1144756346410214,
            "isStep": false,
            "description": "in in eiusmod quis cillum",
            "securityCategories": [],
            "dataSetId": 3020326818746230
        },
        {
            "externalId": "ullamco et",
            "name": "occaecat amet s",
            "legacyName": "minim nostrud sed laboris",
            "isString": false,
            "metadata": {},
            "unit": "veni",
            "assetId": 7145761864584356,
            "isStep": false,
            "description": "adipisicing magna",
            "securityCategories": [],
            "dataSetId": 5711055041423714
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/timeseries

Postman Collection Item JSON

{
  "id": "postTimeSeries",
  "name": "Create time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries"
      ],
      "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": "Create one or more time series.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"Lorem sint adipisicing\",\n            \"name\": \"anim exercitation amet\",\n            \"legacyName\": \"dolor velit\",\n            \"isString\": false,\n            \"metadata\": {},\n            \"unit\": \"ipsum\",\n            \"assetId\": 1144756346410214,\n            \"isStep\": false,\n            \"description\": \"in in eiusmod quis cillum\",\n            \"securityCategories\": [],\n            \"dataSetId\": 3020326818746230\n        },\n        {\n            \"externalId\": \"ullamco et\",\n            \"name\": \"occaecat amet s\",\n            \"legacyName\": \"minim nostrud sed laboris\",\n            \"isString\": false,\n            \"metadata\": {},\n            \"unit\": \"veni\",\n            \"assetId\": 7145761864584356,\n            \"isStep\": false,\n            \"description\": \"adipisicing magna\",\n            \"securityCategories\": [],\n            \"dataSetId\": 5711055041423714\n        }\n    ]\n}"
    }
  }
}