Filter files

Retrieves a list of all files in a project. Criteria can be supplied to select a subset of files. This operation supports pagination with cursors.

Request throttling

This endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage. It is a subject of the new throttling schema (limited request rate and concurrency). Please check Files resource description for more information.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

The project name

object
partition
string (PartitionLimited10)

Splits the data set into N partitions. The attribute is specified as a "M/N" string, where M is a natural number in the interval of [1, N]. You need to follow the cursors within each partition in order to receive all the data.

The maximum number of allowed partitions (N) is 10.

Cognite rejects requests if you specify more than 10 partitions. When Cognite enforces this behavior, the requests result in a 400 Bad Request status.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100

<- Maximum number of items that the client want to get back.

cursor
string
Responses
200

The response for a successful files/list operation

400

The response for a failed request.

post/files/list
Request samples
application/json
{
  • "filter": {
    • "name": "string",
    • "directoryPrefix": "/my/known/directory",
    • "mimeType": "image/jpeg",
    • "metadata": {
      },
    • "assetIds": [
      ],
    • "assetExternalIds": [
      ],
    • "rootAssetIds": [
      ],
    • "dataSetIds": [
      ],
    • "assetSubtreeIds": [
      ],
    • "source": "string",
    • "createdTime": {
      },
    • "lastUpdatedTime": {
      },
    • "uploadedTime": {
      },
    • "sourceCreatedTime": {
      },
    • "sourceModifiedTime": {
      },
    • "externalIdPrefix": "my.known.prefix",
    • "space": "string",
    • "instanceExternalIdPrefix": "my.known.prefix",
    • "uploaded": true,
    • "labels": {
      },
    • "geoLocation": {
      }
    },
  • "partition": "1/3",
  • "limit": 100,
  • "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}
➔ Next to Get icon