Chilkat Online Tools

autoit / Cognite API v1 / Retrieve assets

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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": "magna minim consequat ipsum"
;     },
;     {
;       "externalId": "occaecat"
;     }
;   ],
;   "ignoreUnknownIds": false,
;   "aggregatedProperties": [
;   ]
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("items[0].externalId","magna minim consequat ipsum")
$oJson.UpdateString("items[1].externalId","occaecat")
$oJson.UpdateBool("ignoreUnknownIds",False)
$oJson.UpdateNewArray("aggregatedProperties")

$oHttp.SetRequestHeader "content-type","application/json"
$oHttp.SetRequestHeader "api-key","{{api-key}}"

Local $oResp = $oHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/assets/byids","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "magna minim consequat ipsum"
        },
        {
            "externalId": "occaecat"
        }
    ],
    "ignoreUnknownIds": false,
    "aggregatedProperties": []
}'
https://domain.com/api/v1/projects/{{project}}/assets/byids

Postman Collection Item JSON

{
  "id": "byIdsAssets",
  "name": "Retrieve assets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "assets",
        "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 assets by IDs or external IDs. If you specify to get aggregates then be aware that the aggregates are eventually consistent.\n",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"magna minim consequat ipsum\"\n        },\n        {\n            \"externalId\": \"occaecat\"\n        }\n    ],\n    \"ignoreUnknownIds\": false,\n    \"aggregatedProperties\": []\n}"
    }
  }
}