API ReferenceProduct Documentation
API Reference

Search Files (GET) (Deprecated)

get
https://api.tetrascience.com/v1/fileinfo/search

šŸš§ IMPORTANT The Search Files (GET) endpoint is on a deprecation path and does not support searching for files by metadata. It's recommended that you use the /searchEql endpoint instead. For more information, see Search Files, Search Workflow, and Paginate through All Pipeline Details API Endpoints Deprecation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Query Params
string

File category. Values are RAW, IDS, and PROCESSED.

int32
Defaults to 0

Display files started from a specified number in the results array. By default, files are displayed from the start of the array (the number 0). This parameter is included if the result set is large, pagination might be required. This parameter is typically used in conjunction with size.

date

Search for files created on or after a specific date.

excludeTags
array of strings

Lists the tags that should be excluded. Files that have the specified tags associated with them do not appear in search results.

excludeTags
string

Name, type, and version of the schema used to create the IDS file. Format is {namespace}/{idsType}:{idsVersion}.

string

UUID for the integration.

string

Integration type. Values are EGNYTE, BOX, DOTMATICS, HRB CELLARIO, DATAHUB, PIPELINE, RAW, and API.

string

Searches for files that have specific metadata.

string

UUID for the pipeline.

string

UUID for the RAW file that this file was generated from.

int32
Defaults to 100

Indicates the number of results to return in the request. This parameter is included if the result set is large, pagination might be required. This parameter is typically used in conjunction with from.

string
Defaults to asc

Indicates the sort order for the search results. Sort occurs on the date (createAt timestamp, which occurred when the file was created in the data lake. Options: desc, asc

string

UUID for the source.

string

Type of source, which is typically the name of the instrument or other lab equipment used to generate the data or report.

string

UUID generated when the RAW file is first uploaded to the data lake. All files derived from the RAW file, such as an IDS file, have the same traceId.

tags
array of strings

Lists tags that the user added to the file.

tags
date

Search for files created on or before a specific date.

string

ID for the pipeline workflow.

Responses

Updated 3 months ago

Language
Credentials
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago