Chilkat Online Tools

VBScript / Cognite API v1 / Search files

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

' 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": "labore",
'     "directoryPrefix": "non",
'     "mimeType": "amet",
'     "metadata": {},
'     "assetIds": [
'       2806482587450292,
'       5885270784918610
'     ],
'     "assetExternalIds": [
'       "cillum quis laborum eu in",
'       "pariatur aute incididunt minim nulla"
'     ],
'     "rootAssetIds": [
'       {
'         "id": 3434712602792354
'       },
'       {
'         "externalId": "dolor nostrud sint tempor"
'       }
'     ],
'     "dataSetIds": [
'       {
'         "id": 6643919081009120
'       },
'       {
'         "externalId": "incidid"
'       }
'     ],
'     "assetSubtreeIds": [
'       {
'         "id": 1381446255269154
'       },
'       {
'         "id": 6877534894841850
'       }
'     ],
'     "source": "in ullamco in qu",
'     "createdTime": {
'       "max": 52776204,
'       "min": 19590899
'     },
'     "lastUpdatedTime": {
'       "max": 2447871,
'       "min": 62024320
'     },
'     "uploadedTime": {
'       "max": 88446108,
'       "min": 12715733
'     },
'     "sourceCreatedTime": {
'       "max": 6470658,
'       "min": 75552038
'     },
'     "sourceModifiedTime": {
'       "max": 56421116,
'       "min": 98065077
'     },
'     "externalIdPrefix": "incididunt occaecat eiusmod ut",
'     "uploaded": true,
'     "labels": {
'       "containsAll": [
'         {
'           "externalId": "pariatur"
'         },
'         {
'           "externalId": "adipisicing occaecat"
'         }
'       ]
'     },
'     "geoLocation": {
'       "relation": "INTERSECTS",
'       "shape": {
'         "type": "Point",
'         "coordinates": [
'           -28013106.93372789,
'           67047806.90769461
'         ]
'       }
'     }
'   },
'   "search": {
'     "name": "qui"
'   }
' }

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("filter.name","labore")
success = json.UpdateString("filter.directoryPrefix","non")
success = json.UpdateString("filter.mimeType","amet")
success = json.UpdateNewObject("filter.metadata")
success = json.UpdateInt("filter.assetIds[0]",2806482587450292)
success = json.UpdateInt("filter.assetIds[1]",5885270784918610)
success = json.UpdateString("filter.assetExternalIds[0]","cillum quis laborum eu in")
success = json.UpdateString("filter.assetExternalIds[1]","pariatur aute incididunt minim nulla")
success = json.UpdateInt("filter.rootAssetIds[0].id",123)
success = json.UpdateString("filter.rootAssetIds[1].externalId","dolor nostrud sint tempor")
success = json.UpdateInt("filter.dataSetIds[0].id",123)
success = json.UpdateString("filter.dataSetIds[1].externalId","incidid")
success = json.UpdateInt("filter.assetSubtreeIds[0].id",123)
success = json.UpdateInt("filter.assetSubtreeIds[1].id",123)
success = json.UpdateString("filter.source","in ullamco in qu")
success = json.UpdateInt("filter.createdTime.max",52776204)
success = json.UpdateInt("filter.createdTime.min",19590899)
success = json.UpdateInt("filter.lastUpdatedTime.max",2447871)
success = json.UpdateInt("filter.lastUpdatedTime.min",62024320)
success = json.UpdateInt("filter.uploadedTime.max",88446108)
success = json.UpdateInt("filter.uploadedTime.min",12715733)
success = json.UpdateInt("filter.sourceCreatedTime.max",6470658)
success = json.UpdateInt("filter.sourceCreatedTime.min",75552038)
success = json.UpdateInt("filter.sourceModifiedTime.max",56421116)
success = json.UpdateInt("filter.sourceModifiedTime.min",98065077)
success = json.UpdateString("filter.externalIdPrefix","incididunt occaecat eiusmod ut")
success = json.UpdateBool("filter.uploaded",1)
success = json.UpdateString("filter.labels.containsAll[0].externalId","pariatur")
success = json.UpdateString("filter.labels.containsAll[1].externalId","adipisicing occaecat")
success = json.UpdateString("filter.geoLocation.relation","INTERSECTS")
success = json.UpdateString("filter.geoLocation.shape.type","Point")
success = json.UpdateNumber("filter.geoLocation.shape.coordinates[0]","-28013106.93372789")
success = json.UpdateNumber("filter.geoLocation.shape.coordinates[1]","67047806.90769461")
success = json.UpdateString("search.name","qui")

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

' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/files/search","application/json",json)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine(resp.StatusCode)
outFile.WriteLine(resp.BodyStr)


outFile.Close

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "name": "labore",
        "directoryPrefix": "non",
        "mimeType": "amet",
        "metadata": {},
        "assetIds": [
            2806482587450292,
            5885270784918610
        ],
        "assetExternalIds": [
            "cillum quis laborum eu in",
            "pariatur aute incididunt minim nulla"
        ],
        "rootAssetIds": [
            {
                "id": 3434712602792354
            },
            {
                "externalId": "dolor nostrud sint tempor"
            }
        ],
        "dataSetIds": [
            {
                "id": 6643919081009120
            },
            {
                "externalId": "incidid"
            }
        ],
        "assetSubtreeIds": [
            {
                "id": 1381446255269154
            },
            {
                "id": 6877534894841850
            }
        ],
        "source": "in ullamco in qu",
        "createdTime": {
            "max": 52776204,
            "min": 19590899
        },
        "lastUpdatedTime": {
            "max": 2447871,
            "min": 62024320
        },
        "uploadedTime": {
            "max": 88446108,
            "min": 12715733
        },
        "sourceCreatedTime": {
            "max": 6470658,
            "min": 75552038
        },
        "sourceModifiedTime": {
            "max": 56421116,
            "min": 98065077
        },
        "externalIdPrefix": "incididunt occaecat eiusmod ut",
        "uploaded": true,
        "labels": {
            "containsAll": [
                {
                    "externalId": "pariatur"
                },
                {
                    "externalId": "adipisicing occaecat"
                }
            ]
        },
        "geoLocation": {
            "relation": "INTERSECTS",
            "shape": {
                "type": "Point",
                "coordinates": [
                    -28013106.93372789,
                    67047806.90769461
                ]
            }
        }
    },
    "search": {
        "name": "qui"
    }
}'
https://domain.com/api/v1/projects/{{project}}/files/search

Postman Collection Item JSON

{
  "id": "searchFiles",
  "name": "Search files",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "files",
        "search"
      ],
      "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": "Search for files based on relevance. You can also supply a strict match filter as in Filter files, and search in the results from the filter. Returns first 1000 results based on relevance. This operation does not support pagination.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"labore\",\n        \"directoryPrefix\": \"non\",\n        \"mimeType\": \"amet\",\n        \"metadata\": {},\n        \"assetIds\": [\n            2806482587450292,\n            5885270784918610\n        ],\n        \"assetExternalIds\": [\n            \"cillum quis laborum eu in\",\n            \"pariatur aute incididunt minim nulla\"\n        ],\n        \"rootAssetIds\": [\n            {\n                \"id\": 3434712602792354\n            },\n            {\n                \"externalId\": \"dolor nostrud sint tempor\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"id\": 6643919081009120\n            },\n            {\n                \"externalId\": \"incidid\"\n            }\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 1381446255269154\n            },\n            {\n                \"id\": 6877534894841850\n            }\n        ],\n        \"source\": \"in ullamco in qu\",\n        \"createdTime\": {\n            \"max\": 52776204,\n            \"min\": 19590899\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 2447871,\n            \"min\": 62024320\n        },\n        \"uploadedTime\": {\n            \"max\": 88446108,\n            \"min\": 12715733\n        },\n        \"sourceCreatedTime\": {\n            \"max\": 6470658,\n            \"min\": 75552038\n        },\n        \"sourceModifiedTime\": {\n            \"max\": 56421116,\n            \"min\": 98065077\n        },\n        \"externalIdPrefix\": \"incididunt occaecat eiusmod ut\",\n        \"uploaded\": true,\n        \"labels\": {\n            \"containsAll\": [\n                {\n                    \"externalId\": \"pariatur\"\n                },\n                {\n                    \"externalId\": \"adipisicing occaecat\"\n                }\n            ]\n        },\n        \"geoLocation\": {\n            \"relation\": \"INTERSECTS\",\n            \"shape\": {\n                \"type\": \"Point\",\n                \"coordinates\": [\n                    -28013106.93372789,\n                    67047806.90769461\n                ]\n            }\n        }\n    },\n    \"search\": {\n        \"name\": \"qui\"\n    }\n}"
    }
  }
}