Chilkat Online Tools

Ruby / Cognite API v1 / Aggregate files

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": {
#     "name": "irure sed",
#     "directoryPrefix": "nostrud consequat",
#     "mimeType": "dolor laborum in in",
#     "metadata": {},
#     "assetIds": [
#       7799666741900608,
#       6644214122015698
#     ],
#     "assetExternalIds": [
#       "quis voluptate laborum veniam",
#       "aute ut"
#     ],
#     "rootAssetIds": [
#       {
#         "id": 6254098074953880
#       },
#       {
#         "id": 8976017818812302
#       }
#     ],
#     "dataSetIds": [
#       {
#         "externalId": "aliquip pariatur culpa cillum laborum"
#       },
#       {
#         "id": 7695765338479954
#       }
#     ],
#     "assetSubtreeIds": [
#       {
#         "externalId": "Ut amet ex cillum"
#       },
#       {
#         "externalId": "sint"
#       }
#     ],
#     "source": "aute Ut",
#     "createdTime": {
#       "max": 56270544,
#       "min": 57758894
#     },
#     "lastUpdatedTime": {
#       "max": 52283870,
#       "min": 91808195
#     },
#     "uploadedTime": {
#       "max": 26896230,
#       "min": 27790663
#     },
#     "sourceCreatedTime": {
#       "max": 2593079,
#       "min": 10226586
#     },
#     "sourceModifiedTime": {
#       "max": 74076542,
#       "min": 32817651
#     },
#     "externalIdPrefix": "aliqua eu adipisicing",
#     "uploaded": false,
#     "labels": {
#       "containsAny": [
#         {
#           "externalId": "ad aute cupidatat mollit"
#         },
#         {
#           "externalId": "ex Duis sit"
#         }
#       ]
#     },
#     "geoLocation": {
#       "relation": "INTERSECTS",
#       "shape": {
#         "type": "Polygon",
#         "coordinates": [
#         ]
#       }
#     }
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("filter.name","irure sed")
json.UpdateString("filter.directoryPrefix","nostrud consequat")
json.UpdateString("filter.mimeType","dolor laborum in in")
json.UpdateNewObject("filter.metadata")
json.UpdateInt("filter.assetIds[0]",7799666741900608)
json.UpdateInt("filter.assetIds[1]",6644214122015698)
json.UpdateString("filter.assetExternalIds[0]","quis voluptate laborum veniam")
json.UpdateString("filter.assetExternalIds[1]","aute ut")
json.UpdateInt("filter.rootAssetIds[0].id",123)
json.UpdateInt("filter.rootAssetIds[1].id",123)
json.UpdateString("filter.dataSetIds[0].externalId","aliquip pariatur culpa cillum laborum")
json.UpdateInt("filter.dataSetIds[1].id",123)
json.UpdateString("filter.assetSubtreeIds[0].externalId","Ut amet ex cillum")
json.UpdateString("filter.assetSubtreeIds[1].externalId","sint")
json.UpdateString("filter.source","aute Ut")
json.UpdateInt("filter.createdTime.max",56270544)
json.UpdateInt("filter.createdTime.min",57758894)
json.UpdateInt("filter.lastUpdatedTime.max",52283870)
json.UpdateInt("filter.lastUpdatedTime.min",91808195)
json.UpdateInt("filter.uploadedTime.max",26896230)
json.UpdateInt("filter.uploadedTime.min",27790663)
json.UpdateInt("filter.sourceCreatedTime.max",2593079)
json.UpdateInt("filter.sourceCreatedTime.min",10226586)
json.UpdateInt("filter.sourceModifiedTime.max",74076542)
json.UpdateInt("filter.sourceModifiedTime.min",32817651)
json.UpdateString("filter.externalIdPrefix","aliqua eu adipisicing")
json.UpdateBool("filter.uploaded",false)
json.UpdateString("filter.labels.containsAny[0].externalId","ad aute cupidatat mollit")
json.UpdateString("filter.labels.containsAny[1].externalId","ex Duis sit")
json.UpdateString("filter.geoLocation.relation","INTERSECTS")
json.UpdateString("filter.geoLocation.shape.type","Polygon")
json.UpdateNewArray("filter.geoLocation.shape.coordinates")

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}}/files/aggregate","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": {
        "name": "irure sed",
        "directoryPrefix": "nostrud consequat",
        "mimeType": "dolor laborum in in",
        "metadata": {},
        "assetIds": [
            7799666741900608,
            6644214122015698
        ],
        "assetExternalIds": [
            "quis voluptate laborum veniam",
            "aute ut"
        ],
        "rootAssetIds": [
            {
                "id": 6254098074953880
            },
            {
                "id": 8976017818812302
            }
        ],
        "dataSetIds": [
            {
                "externalId": "aliquip pariatur culpa cillum laborum"
            },
            {
                "id": 7695765338479954
            }
        ],
        "assetSubtreeIds": [
            {
                "externalId": "Ut amet ex cillum"
            },
            {
                "externalId": "sint"
            }
        ],
        "source": "aute Ut",
        "createdTime": {
            "max": 56270544,
            "min": 57758894
        },
        "lastUpdatedTime": {
            "max": 52283870,
            "min": 91808195
        },
        "uploadedTime": {
            "max": 26896230,
            "min": 27790663
        },
        "sourceCreatedTime": {
            "max": 2593079,
            "min": 10226586
        },
        "sourceModifiedTime": {
            "max": 74076542,
            "min": 32817651
        },
        "externalIdPrefix": "aliqua eu adipisicing",
        "uploaded": false,
        "labels": {
            "containsAny": [
                {
                    "externalId": "ad aute cupidatat mollit"
                },
                {
                    "externalId": "ex Duis sit"
                }
            ]
        },
        "geoLocation": {
            "relation": "INTERSECTS",
            "shape": {
                "type": "Polygon",
                "coordinates": []
            }
        }
    }
}'
https://domain.com/api/v1/projects/{{project}}/files/aggregate

Postman Collection Item JSON

{
  "id": "aggregateFiles",
  "name": "Aggregate files",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "files",
        "aggregate"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "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": "Calculate aggregates for files, based on optional filter specification. Returns the following aggregates: `count`",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"irure sed\",\n        \"directoryPrefix\": \"nostrud consequat\",\n        \"mimeType\": \"dolor laborum in in\",\n        \"metadata\": {},\n        \"assetIds\": [\n            7799666741900608,\n            6644214122015698\n        ],\n        \"assetExternalIds\": [\n            \"quis voluptate laborum veniam\",\n            \"aute ut\"\n        ],\n        \"rootAssetIds\": [\n            {\n                \"id\": 6254098074953880\n            },\n            {\n                \"id\": 8976017818812302\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"aliquip pariatur culpa cillum laborum\"\n            },\n            {\n                \"id\": 7695765338479954\n            }\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"externalId\": \"Ut amet ex cillum\"\n            },\n            {\n                \"externalId\": \"sint\"\n            }\n        ],\n        \"source\": \"aute Ut\",\n        \"createdTime\": {\n            \"max\": 56270544,\n            \"min\": 57758894\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 52283870,\n            \"min\": 91808195\n        },\n        \"uploadedTime\": {\n            \"max\": 26896230,\n            \"min\": 27790663\n        },\n        \"sourceCreatedTime\": {\n            \"max\": 2593079,\n            \"min\": 10226586\n        },\n        \"sourceModifiedTime\": {\n            \"max\": 74076542,\n            \"min\": 32817651\n        },\n        \"externalIdPrefix\": \"aliqua eu adipisicing\",\n        \"uploaded\": false,\n        \"labels\": {\n            \"containsAny\": [\n                {\n                    \"externalId\": \"ad aute cupidatat mollit\"\n                },\n                {\n                    \"externalId\": \"ex Duis sit\"\n                }\n            ]\n        },\n        \"geoLocation\": {\n            \"relation\": \"INTERSECTS\",\n            \"shape\": {\n                \"type\": \"Polygon\",\n                \"coordinates\": []\n            }\n        }\n    }\n}"
    }
  }
}