Chilkat Online Tools

TCL / Cognite API v1 / List files

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateInt $queryParams "limit" 100
CkJsonObject_UpdateString $queryParams "assetExternalIds" "[\"externalId1\", \"externalId2\", \"externalId3\"]"
CkJsonObject_UpdateString $queryParams "rootAssetIds" "[363848954441724, 793045462540095, 1261042166839739]"
CkJsonObject_UpdateString $queryParams "assetSubtreeIds" "[363848954441724, 793045462540095, 1261042166839739]"
CkJsonObject_UpdateString $queryParams "assetSubtreeExternalIds" "[\"externalId1\", \"externalId2\", \"externalId3\"]"
CkJsonObject_UpdateString $queryParams "uploaded" "true"

CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://domain.com/api/v1/projects/{{project}}/files" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $queryParams

Curl Command

curl -G -d "limit=100"
	-d "assetExternalIds=%5B%22externalId1%22,%20%22externalId2%22,%20%22externalId3%22%5D"
	-d "rootAssetIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
	-d "assetSubtreeIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
	-d "assetSubtreeExternalIds=%5B%22externalId1%22,%20%22externalId2%22,%20%22externalId3%22%5D"
	-d "uploaded=true"
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/files

Postman Collection Item JSON

{
  "id": "listFiles",
  "name": "List files",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "files"
      ],
      "query": [
        {
          "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": "cursor",
          "description": "Cursor for paging through results.",
          "disabled": true
        },
        {
          "key": "name",
          "description": "Name of the file.",
          "disabled": true
        },
        {
          "key": "mimeType",
          "description": "File type. E.g. text/plain, application/pdf, ..",
          "disabled": true
        },
        {
          "key": "source",
          "description": "The source of the file.",
          "disabled": true
        },
        {
          "key": "assetIds",
          "description": "Only include files that reference these specific asset IDs.",
          "disabled": true
        },
        {
          "key": "assetExternalIds",
          "description": "Asset external IDs of related equipment that this file relates to. Takes 1..100 unique items.",
          "value": "[\"externalId1\", \"externalId2\", \"externalId3\"]",
          "disabled": true
        },
        {
          "key": "dataSetIds",
          "disabled": true
        },
        {
          "key": "rootAssetIds",
          "description": "Only include files that have a related asset in a tree rooted at any of these root assetIds.",
          "value": "[363848954441724, 793045462540095, 1261042166839739]",
          "disabled": true
        },
        {
          "key": "assetSubtreeIds",
          "description": "Only include files that have a related asset in a subtree rooted at any of these assetIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.",
          "value": "[363848954441724, 793045462540095, 1261042166839739]",
          "disabled": true
        },
        {
          "key": "assetSubtreeExternalIds",
          "description": "Only include files that have a related asset in a subtree rooted at any of these assetExternalIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.",
          "value": "[\"externalId1\", \"externalId2\", \"externalId3\"]",
          "disabled": true
        },
        {
          "key": "minCreatedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "maxCreatedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "minLastUpdatedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "maxLastUpdatedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "minUploadedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "maxUploadedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "minSourceCreatedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "maxSourceCreatedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "minSourceModifiedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "maxSourceModifiedTime",
          "description": "The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
          "disabled": true
        },
        {
          "key": "externalIdPrefix",
          "description": "Filter by this (case-sensitive) prefix for the external ID.",
          "disabled": true
        },
        {
          "key": "uploaded",
          "description": "Whether or not the actual file is uploaded. This field is returned only by the API, it has no effect in a post body.",
          "value": "true",
          "disabled": true
        },
        {
          "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
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "The GET /files operation can be used to return information for all files in a project. \n\nOptionally you can add one or more of the following query parameters. \nThe filter query parameters will filter the results to only include files that match all filter parameters."
  }
}