Retrieve files

Retrieves metadata information about multiple specific files in the same project. Results are returned in the same order as in the request. This operation does not return the file contents.

Request throttling

Please note that this endpoint is subject to the new throttling policy, which imposes limits on both request rate and concurrency. For more details, please refer to the Files resource documentation.

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

List of IDs of files to retrieve. Must be up to a maximum of 1000 IDs, and all of them must be unique.

required
Array of Select by Id (object) or Select by ExternalId (object) or Select by InstanceId (object) (FileSelectEither) [ 1 .. 1000 ] items
ignoreUnknownIds
boolean
Default: false

Ignore IDs and external IDs that are not found

Responses
200

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

400

The response for a failed request.

post/files/byids
Request samples 
res = client.files.retrieve_multiple(ids=[1, 2, 3])

res = client.files.retrieve_multiple(external_ids=["abc", "def"])
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}
➔ Next to Search files