Chilkat Online Tools

Ruby / Cognite API v1 / Filter 3D asset mappings

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "filter": {
#     "treeIndexes": [
#       49863275,
#       -56370022
#     ]
#   },
#   "limit": 100,
#   "cursor": "Ut non irure"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("filter.treeIndexes[0]",49863275)
json.UpdateInt("filter.treeIndexes[1]",-56370022)
json.UpdateInt("limit",100)
json.UpdateString("cursor","Ut non irure")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/3d/models/:modelId/revisions/:revisionId/mappings/list","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "treeIndexes": [
            49863275,
            -56370022
        ]
    },
    "limit": 100,
    "cursor": "Ut non irure"
}'
https://domain.com/api/v1/projects/{{project}}/3d/models/:modelId/revisions/:revisionId/mappings/list

Postman Collection Item JSON

{
  "id": "filter3DAssetMappings",
  "name": "Filter 3D asset mappings",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "3d",
        "models",
        ":modelId",
        "revisions",
        ":revisionId",
        "mappings",
        "list"
      ],
      "query": [
      ],
      "variable": [
        {
          "key": "modelId",
          "description": "Model ID.",
          "disabled": true,
          "type": "number"
        },
        {
          "key": "revisionId",
          "description": "Revision ID.",
          "disabled": true,
          "type": "number"
        }
      ]
    },
    "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": "Lists 3D assets mappings that match the specified filter parameter. Only\none type of filter can be specified for each request, either `assetIds`, `nodeIds` or `treeIndexes`.\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.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"treeIndexes\": [\n            49863275,\n            -56370022\n        ]\n    },\n    \"limit\": 100,\n    \"cursor\": \"Ut non irure\"\n}"
    }
  }
}