PureBasic / Cognite API v1 / Aggregate files
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"filter.name","irure sed")
CkJsonObject::ckUpdateString(json,"filter.directoryPrefix","nostrud consequat")
CkJsonObject::ckUpdateString(json,"filter.mimeType","dolor laborum in in")
CkJsonObject::ckUpdateNewObject(json,"filter.metadata")
CkJsonObject::ckUpdateInt(json,"filter.assetIds[0]",7799666741900608)
CkJsonObject::ckUpdateInt(json,"filter.assetIds[1]",6644214122015698)
CkJsonObject::ckUpdateString(json,"filter.assetExternalIds[0]","quis voluptate laborum veniam")
CkJsonObject::ckUpdateString(json,"filter.assetExternalIds[1]","aute ut")
CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[0].id",123)
CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[1].id",123)
CkJsonObject::ckUpdateString(json,"filter.dataSetIds[0].externalId","aliquip pariatur culpa cillum laborum")
CkJsonObject::ckUpdateInt(json,"filter.dataSetIds[1].id",123)
CkJsonObject::ckUpdateString(json,"filter.assetSubtreeIds[0].externalId","Ut amet ex cillum")
CkJsonObject::ckUpdateString(json,"filter.assetSubtreeIds[1].externalId","sint")
CkJsonObject::ckUpdateString(json,"filter.source","aute Ut")
CkJsonObject::ckUpdateInt(json,"filter.createdTime.max",56270544)
CkJsonObject::ckUpdateInt(json,"filter.createdTime.min",57758894)
CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.max",52283870)
CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.min",91808195)
CkJsonObject::ckUpdateInt(json,"filter.uploadedTime.max",26896230)
CkJsonObject::ckUpdateInt(json,"filter.uploadedTime.min",27790663)
CkJsonObject::ckUpdateInt(json,"filter.sourceCreatedTime.max",2593079)
CkJsonObject::ckUpdateInt(json,"filter.sourceCreatedTime.min",10226586)
CkJsonObject::ckUpdateInt(json,"filter.sourceModifiedTime.max",74076542)
CkJsonObject::ckUpdateInt(json,"filter.sourceModifiedTime.min",32817651)
CkJsonObject::ckUpdateString(json,"filter.externalIdPrefix","aliqua eu adipisicing")
CkJsonObject::ckUpdateBool(json,"filter.uploaded",0)
CkJsonObject::ckUpdateString(json,"filter.labels.containsAny[0].externalId","ad aute cupidatat mollit")
CkJsonObject::ckUpdateString(json,"filter.labels.containsAny[1].externalId","ex Duis sit")
CkJsonObject::ckUpdateString(json,"filter.geoLocation.relation","INTERSECTS")
CkJsonObject::ckUpdateString(json,"filter.geoLocation.shape.type","Polygon")
CkJsonObject::ckUpdateNewArray(json,"filter.geoLocation.shape.coordinates")
CkHttp::ckSetRequestHeader(http,"content-type","application/json")
CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/projects/{{project}}/files/aggregate","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
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}"
}
}
}
