Chilkat Online Tools

Android / Cognite API v1 / List 3D nodes

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkHttp http = new CkHttp();
    boolean success;

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateInt("limit",100);
    queryParams.UpdateString("sortByNodeId","false");

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

    CkHttpResponse resp = http.QuickRequestParams("GET","https://domain.com/api/v1/projects/{{project}}/3d/models/:modelId/revisions/:revisionId/nodes",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    Log.i(TAG, String.valueOf(resp.get_StatusCode()));
    Log.i(TAG, resp.bodyStr());


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

Curl Command

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

Postman Collection Item JSON

{
  "id": "get3DNodes",
  "name": "List 3D nodes",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "3d",
        "models",
        ":modelId",
        "revisions",
        ":revisionId",
        "nodes"
      ],
      "query": [
        {
          "key": "partition",
          "description": "Splits the data set into N partitions.\nYou need to follow the cursors within each partition in order to receive all the data.\nExample: 1/10\n",
          "disabled": true
        },
        {
          "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": "depth",
          "description": "Get sub nodes up to this many levels below the specified node. Depth 0 is the root node.",
          "disabled": true
        },
        {
          "key": "nodeId",
          "description": "ID of a node that are the root of the subtree you request (default is the root node).",
          "disabled": true
        },
        {
          "key": "sortByNodeId",
          "description": "Enable sorting by nodeId. When this parameter is `true`, nodes will be listed in order of ascending nodeId. Enabling this option will likely result in faster response for many requests.",
          "value": "false",
          "disabled": true
        },
        {
          "key": "properties",
          "description": "Example: `{\"category1\":{\"property1\":\"value1\"}}`\n\nFilter for node properties. Only nodes that match all the given properties exactly will be listed.\nThe filter must be a JSON object with the same format as the `properties` field.\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": "Retrieves a list of nodes from the hierarchy in the 3D model. You can also request a specific subtree with the 'nodeId' query parameter and limit the depth of the resulting subtree with the 'depth' query parameter. By default, nodes are returned in order of ascending treeIndex. We suggest trying to set the query parameter `sortByNodeId` to `true` to check whether it makes your use case faster. The `partition` parameter can only be used if `sortByNodeId` is set to `true`. This operation supports pagination."
  }
}