Chilkat Online Tools

VB6 / Cognite API v1 / Retrieve files

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

' 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": [
'     {
'       "id": 8647257624772522
'     },
'     {
'       "externalId": "reprehenderit Excep"
'     }
'   ],
'   "ignoreUnknownIds": false
' }

Dim json As New ChilkatJsonObject
success = json.UpdateInt("items[0].id",123)
success = json.UpdateString("items[1].externalId","reprehenderit Excep")
success = json.UpdateBool("ignoreUnknownIds",0)

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

Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/files/byids","application/json",json)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print resp.StatusCode
Debug.Print resp.BodyStr

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "id": 8647257624772522
        },
        {
            "externalId": "reprehenderit Excep"
        }
    ],
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/files/byids

Postman Collection Item JSON

{
  "id": "byIdsFiles",
  "name": "Retrieve files",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "files",
        "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": "Retrieves metadata information about multiple specific files in the same project. \nResults are returned in the same order as in the request. This operation does not return the file contents.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"id\": 8647257624772522\n        },\n        {\n            \"externalId\": \"reprehenderit Excep\"\n        }\n    ],\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}