Chilkat Online Tools

C++ / Cognite API v1 / Retrieve a 3D file

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

    http.SetRequestHeader("api-key","{{api-key}}");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://domain.com/api/v1/projects/{{project}}/3d/files/:threedFileId",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    std::cout << "Response status code = " << http.get_LastStatus() << "\r\n";
    std::cout << sbResponseBody.getAsString() << "\r\n";
    }

Curl Command

curl -X GET
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/3d/files/:threedFileId

Postman Collection Item JSON

{
  "id": "get3DFile",
  "name": "Retrieve a 3D file",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "3d",
        "files",
        ":threedFileId"
      ],
      "query": [
      ],
      "variable": [
        {
          "key": "threedFileId",
          "description": "The ID of the 3D file to retrieve.",
          "disabled": true,
          "type": "number"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "Retrieve the contents of a 3D file.\n\nThis endpoint supported tag-based caching.\n\nThis endpoint is only compatible with 3D file IDs from the 3D API, and not compatible with\nfile IDs from the Files API."
  }
}