Chilkat Online Tools

phpExt / Cognite API v1 / Update time series

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

// 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 = new CkJsonObject();
$json->UpdateString('items[0].update.externalId.set','in sint aliquip esse');
$json->UpdateBool('items[0].update.name.setNull',true);
$json->UpdateNewObject('items[0].update.metadata.add');
$json->UpdateNewArray('items[0].update.metadata.remove');
$json->UpdateBool('items[0].update.unit.setNull',true);
$json->UpdateBool('items[0].update.assetId.setNull',true);
$json->UpdateString('items[0].update.description.set','officia nulla in');
$json->UpdateNewArray('items[0].update.securityCategories.set');
$json->UpdateInt('items[0].update.dataSetId.set',12304700);
$json->UpdateInt('items[0].id',123);
$json->UpdateBool('items[1].update.externalId.setNull',true);
$json->UpdateString('items[1].update.name.set','nisi proident voluptate non');
$json->UpdateNewObject('items[1].update.metadata.add');
$json->UpdateNewArray('items[1].update.metadata.remove');
$json->UpdateBool('items[1].update.unit.setNull',true);
$json->UpdateBool('items[1].update.assetId.setNull',true);
$json->UpdateString('items[1].update.description.set','ullamco');
$json->UpdateNewArray('items[1].update.securityCategories.set');
$json->UpdateInt('items[1].update.dataSetId.set',-60750056);
$json->UpdateString('items[1].externalId','nisi nostrud');

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

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/api/v1/projects/{{project}}/timeseries/update','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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