Chilkat Online Tools

PureBasic / Cognite API v1 / Update 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": [
    ;     {
    ;       "update": {
    ;         "externalId": {
    ;           "set": "in sint aliquip esse"
    ;         },
    ;         "name": {
    ;           "setNull": true
    ;         },
    ;         "metadata": {
    ;           "add": {},
    ;           "remove": [
    ;           ]
    ;         },
    ;         "unit": {
    ;           "setNull": true
    ;         },
    ;         "assetId": {
    ;           "setNull": true
    ;         },
    ;         "description": {
    ;           "set": "officia nulla in"
    ;         },
    ;         "securityCategories": {
    ;           "set": [
    ;           ]
    ;         },
    ;         "dataSetId": {
    ;           "set": 12304700
    ;         }
    ;       },
    ;       "id": 8146739874146772
    ;     },
    ;     {
    ;       "update": {
    ;         "externalId": {
    ;           "setNull": true
    ;         },
    ;         "name": {
    ;           "set": "nisi proident voluptate non"
    ;         },
    ;         "metadata": {
    ;           "add": {},
    ;           "remove": [
    ;           ]
    ;         },
    ;         "unit": {
    ;           "setNull": true
    ;         },
    ;         "assetId": {
    ;           "setNull": true
    ;         },
    ;         "description": {
    ;           "set": "ullamco"
    ;         },
    ;         "securityCategories": {
    ;           "set": [
    ;           ]
    ;         },
    ;         "dataSetId": {
    ;           "set": -60750056
    ;         }
    ;       },
    ;       "externalId": "nisi nostrud"
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"items[0].update.externalId.set","in sint aliquip esse")
    CkJsonObject::ckUpdateBool(json,"items[0].update.name.setNull",1)
    CkJsonObject::ckUpdateNewObject(json,"items[0].update.metadata.add")
    CkJsonObject::ckUpdateNewArray(json,"items[0].update.metadata.remove")
    CkJsonObject::ckUpdateBool(json,"items[0].update.unit.setNull",1)
    CkJsonObject::ckUpdateBool(json,"items[0].update.assetId.setNull",1)
    CkJsonObject::ckUpdateString(json,"items[0].update.description.set","officia nulla in")
    CkJsonObject::ckUpdateNewArray(json,"items[0].update.securityCategories.set")
    CkJsonObject::ckUpdateInt(json,"items[0].update.dataSetId.set",12304700)
    CkJsonObject::ckUpdateInt(json,"items[0].id",123)
    CkJsonObject::ckUpdateBool(json,"items[1].update.externalId.setNull",1)
    CkJsonObject::ckUpdateString(json,"items[1].update.name.set","nisi proident voluptate non")
    CkJsonObject::ckUpdateNewObject(json,"items[1].update.metadata.add")
    CkJsonObject::ckUpdateNewArray(json,"items[1].update.metadata.remove")
    CkJsonObject::ckUpdateBool(json,"items[1].update.unit.setNull",1)
    CkJsonObject::ckUpdateBool(json,"items[1].update.assetId.setNull",1)
    CkJsonObject::ckUpdateString(json,"items[1].update.description.set","ullamco")
    CkJsonObject::ckUpdateNewArray(json,"items[1].update.securityCategories.set")
    CkJsonObject::ckUpdateInt(json,"items[1].update.dataSetId.set",-60750056)
    CkJsonObject::ckUpdateString(json,"items[1].externalId","nisi nostrud")

    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/update","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": [
        {
            "update": {
                "externalId": {
                    "set": "in sint aliquip esse"
                },
                "name": {
                    "setNull": true
                },
                "metadata": {
                    "add": {},
                    "remove": []
                },
                "unit": {
                    "setNull": true
                },
                "assetId": {
                    "setNull": true
                },
                "description": {
                    "set": "officia nulla in"
                },
                "securityCategories": {
                    "set": []
                },
                "dataSetId": {
                    "set": 12304700
                }
            },
            "id": 8146739874146772
        },
        {
            "update": {
                "externalId": {
                    "setNull": true
                },
                "name": {
                    "set": "nisi proident voluptate non"
                },
                "metadata": {
                    "add": {},
                    "remove": []
                },
                "unit": {
                    "setNull": true
                },
                "assetId": {
                    "setNull": true
                },
                "description": {
                    "set": "ullamco"
                },
                "securityCategories": {
                    "set": []
                },
                "dataSetId": {
                    "set": -60750056
                }
            },
            "externalId": "nisi nostrud"
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/update

Postman Collection Item JSON

{
  "id": "alterTimeSeries",
  "name": "Update time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "update"
      ],
      "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": "Updates one or more time series. Fields that are not included in the request, are not changed.\n\nFor primitive fields (String, Long Int), use 'set': 'value' to update the value; use 'setNull': true to set the field to null.\n\nFor JSON Array fields (for example securityCategories), use 'set': [value1, value2] to update the value; use 'add': [v1, v2] to add values; use 'remove': [v1, v2] to remove values.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"update\": {\n                \"externalId\": {\n                    \"set\": \"in sint aliquip esse\"\n                },\n                \"name\": {\n                    \"setNull\": true\n                },\n                \"metadata\": {\n                    \"add\": {},\n                    \"remove\": []\n                },\n                \"unit\": {\n                    \"setNull\": true\n                },\n                \"assetId\": {\n                    \"setNull\": true\n                },\n                \"description\": {\n                    \"set\": \"officia nulla in\"\n                },\n                \"securityCategories\": {\n                    \"set\": []\n                },\n                \"dataSetId\": {\n                    \"set\": 12304700\n                }\n            },\n            \"id\": 8146739874146772\n        },\n        {\n            \"update\": {\n                \"externalId\": {\n                    \"setNull\": true\n                },\n                \"name\": {\n                    \"set\": \"nisi proident voluptate non\"\n                },\n                \"metadata\": {\n                    \"add\": {},\n                    \"remove\": []\n                },\n                \"unit\": {\n                    \"setNull\": true\n                },\n                \"assetId\": {\n                    \"setNull\": true\n                },\n                \"description\": {\n                    \"set\": \"ullamco\"\n                },\n                \"securityCategories\": {\n                    \"set\": []\n                },\n                \"dataSetId\": {\n                    \"set\": -60750056\n                }\n            },\n            \"externalId\": \"nisi nostrud\"\n        }\n    ]\n}"
    }
  }
}