Chilkat Online Tools

Foxpro / Cognite API v1 / Download files

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

loHttp = CreateObject('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": [
*     {
*       "id": 1224696479187012
*     },
*     {
*       "externalId": "laboris officia sint nulla"
*     }
*   ]
* }

loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateInt("items[0].id",123)
loJson.UpdateString("items[1].externalId","laboris officia sint nulla")

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

loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpJson("POST","https://domain.com/api/v1/projects/{{project}}/files/downloadlink",loJson,"application/json",loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loResp
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr

RELEASE loHttp
RELEASE loJson
RELEASE loResp

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "id": 1224696479187012
        },
        {
            "externalId": "laboris officia sint nulla"
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/files/downloadlink

Postman Collection Item JSON

{
  "id": "downloadLinks",
  "name": "Download files",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "files",
        "downloadlink"
      ],
      "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 a list of download URLs for the specified list of file IDs. After getting the download links, the client has to issue a GET request to the returned URLs, which will respond with the contents of the file. The link will expire after 30 seconds.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"id\": 1224696479187012\n        },\n        {\n            \"externalId\": \"laboris officia sint nulla\"\n        }\n    ]\n}"
    }
  }
}