Chilkat Online Tools

Objective-C / Cognite API v1 / List 3D asset mappings

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.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;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateInt: @"limit" value: [NSNumber numberWithInt: 100]];

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

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/api/v1/projects/{{project}}/3d/models/:modelId/revisions/:revisionId/mappings" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -G -d "limit=100"
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/3d/models/:modelId/revisions/:revisionId/mappings

Postman Collection Item JSON

{
  "id": "get3DMappings",
  "name": "List 3D asset mappings",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "3d",
        "models",
        ":modelId",
        "revisions",
        ":revisionId",
        "mappings"
      ],
      "query": [
        {
          "key": "cursor",
          "description": "Cursor for paging through results.",
          "disabled": true
        },
        {
          "key": "limit",
          "description": "Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.",
          "value": "100",
          "disabled": true
        },
        {
          "key": "nodeId",
          "disabled": true
        },
        {
          "key": "assetId",
          "disabled": true
        },
        {
          "key": "intersectsBoundingBox",
          "description": "Example: `{\"min\":[0.0, 0.0, 0.0], \"max\":[1.0, 1.0, 1.0]}`\n\nIf given, only return asset mappings for assets whose bounding box\nintersects the given bounding box.\n\nMust be a JSON object with `min`, `max` arrays of coordinates.\n",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "modelId",
          "description": "Model ID.",
          "disabled": true,
          "type": "number"
        },
        {
          "key": "revisionId",
          "description": "Revision ID.",
          "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": "List all asset mappings\n\n\nAsset references obtained from a mapping - through asset ids - may be\ninvalid, simply by the non-transactional nature of HTTP.\nThey are NOT maintained by any means from CDF, meaning they will be stored until the\nreference is removed through the delete endpoint of 3d asset mappings."
  }
}