Search files

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.

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
object
object
Responses
200

The response for a successful files/byids, files/search or files/update operation

400

The response for a failed request.

post/files/search
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",
    • "uploaded": true,
    • "labels": {
      },
    • "geoLocation": {
      }
    },
  • "search": {
    • "name": "string"
    }
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}
➔ Next to Update files