Chilkat Online Tools

Objective-C / Cognite API v1 / Retrieve a 3D file

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

[http SetRequestHeader: @"api-key" value: @"{{api-key}}"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://domain.com/api/v1/projects/{{project}}/3d/files/:threedFileId" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%@%d",@"Response status code = ",[http.LastStatus intValue]);
NSLog(@"%@",[sbResponseBody GetAsString]);

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."
  }
}