Chilkat Online Tools

Powershell / Cognite API v1 / Update sequences

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

# 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": {
#         "name": {
#           "set": "commodo consectetur labore adipisicing et"
#         },
#         "description": {
#           "set": "minim do officia commodo enim"
#         },
#         "assetId": {
#           "setNull": true
#         },
#         "externalId": {
#           "setNull": true
#         },
#         "metadata": {
#           "set": {}
#         },
#         "dataSetId": {
#           "setNull": false
#         },
#         "columns": {
#           "modify": [
#           ],
#           "add": [
#           ],
#           "remove": [
#           ]
#         }
#       },
#       "id": 2341818327837744
#     },
#     {
#       "update": {
#         "name": {
#           "setNull": true
#         },
#         "description": {
#           "setNull": false
#         },
#         "assetId": {
#           "setNull": false
#         },
#         "externalId": {
#           "set": "ea non cupidatat"
#         },
#         "metadata": {
#           "add": {},
#           "remove": [
#           ]
#         },
#         "dataSetId": {
#           "set": -97287500
#         },
#         "columns": {
#           "modify": [
#           ],
#           "add": [
#           ],
#           "remove": [
#           ]
#         }
#       },
#       "externalId": "do"
#     }
#   ]
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("items[0].update.name.set","commodo consectetur labore adipisicing et")
$json.UpdateString("items[0].update.description.set","minim do officia commodo enim")
$json.UpdateBool("items[0].update.assetId.setNull",$true)
$json.UpdateBool("items[0].update.externalId.setNull",$true)
$json.UpdateNewObject("items[0].update.metadata.set")
$json.UpdateBool("items[0].update.dataSetId.setNull",$false)
$json.UpdateNewArray("items[0].update.columns.modify")
$json.UpdateNewArray("items[0].update.columns.add")
$json.UpdateNewArray("items[0].update.columns.remove")
$json.UpdateInt("items[0].id",123)
$json.UpdateBool("items[1].update.name.setNull",$true)
$json.UpdateBool("items[1].update.description.setNull",$false)
$json.UpdateBool("items[1].update.assetId.setNull",$false)
$json.UpdateString("items[1].update.externalId.set","ea non cupidatat")
$json.UpdateNewObject("items[1].update.metadata.add")
$json.UpdateNewArray("items[1].update.metadata.remove")
$json.UpdateInt("items[1].update.dataSetId.set",-97287500)
$json.UpdateNewArray("items[1].update.columns.modify")
$json.UpdateNewArray("items[1].update.columns.add")
$json.UpdateNewArray("items[1].update.columns.remove")
$json.UpdateString("items[1].externalId","do")

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

$resp = $http.PostJson3("https://domain.com/api/v1/projects/{{project}}/sequences/update","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$($resp.StatusCode)
$($resp.BodyStr)

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "update": {
                "name": {
                    "set": "commodo consectetur labore adipisicing et"
                },
                "description": {
                    "set": "minim do officia commodo enim"
                },
                "assetId": {
                    "setNull": true
                },
                "externalId": {
                    "setNull": true
                },
                "metadata": {
                    "set": {}
                },
                "dataSetId": {
                    "setNull": false
                },
                "columns": {
                    "modify": [],
                    "add": [],
                    "remove": []
                }
            },
            "id": 2341818327837744
        },
        {
            "update": {
                "name": {
                    "setNull": true
                },
                "description": {
                    "setNull": false
                },
                "assetId": {
                    "setNull": false
                },
                "externalId": {
                    "set": "ea non cupidatat"
                },
                "metadata": {
                    "add": {},
                    "remove": []
                },
                "dataSetId": {
                    "set": -97287500
                },
                "columns": {
                    "modify": [],
                    "add": [],
                    "remove": []
                }
            },
            "externalId": "do"
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/sequences/update

Postman Collection Item JSON

{
  "id": "updateSequences",
  "name": "Update sequences",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "sequences",
        "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": "Update one or more sequences. Fields that are not included in the request, are not changed.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"update\": {\n                \"name\": {\n                    \"set\": \"commodo consectetur labore adipisicing et\"\n                },\n                \"description\": {\n                    \"set\": \"minim do officia commodo enim\"\n                },\n                \"assetId\": {\n                    \"setNull\": true\n                },\n                \"externalId\": {\n                    \"setNull\": true\n                },\n                \"metadata\": {\n                    \"set\": {}\n                },\n                \"dataSetId\": {\n                    \"setNull\": false\n                },\n                \"columns\": {\n                    \"modify\": [],\n                    \"add\": [],\n                    \"remove\": []\n                }\n            },\n            \"id\": 2341818327837744\n        },\n        {\n            \"update\": {\n                \"name\": {\n                    \"setNull\": true\n                },\n                \"description\": {\n                    \"setNull\": false\n                },\n                \"assetId\": {\n                    \"setNull\": false\n                },\n                \"externalId\": {\n                    \"set\": \"ea non cupidatat\"\n                },\n                \"metadata\": {\n                    \"add\": {},\n                    \"remove\": []\n                },\n                \"dataSetId\": {\n                    \"set\": -97287500\n                },\n                \"columns\": {\n                    \"modify\": [],\n                    \"add\": [],\n                    \"remove\": []\n                }\n            },\n            \"externalId\": \"do\"\n        }\n    ]\n}"
    }
  }
}