Search Files (POST) (Deprecated)

post

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

🚧 IMPORTANT The Search Files (POST) 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

category

string

Returns information on files from the RAW, IDS, or PROCESSED categories.

from

int32

Defaults to 0

Display files started from 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.

fromDate

date

Search for files created on or after a specific date.

excludeTags

array of strings

Exclude files that have the specified tags from the search results.

excludeTags

ids

string

Returns files that match the IDS schema.

integrationId

string

Returns files that match the specified ID for the integration.

integrationType

string

Returns files that are of the specified integration type. Types include: EGNYTE, BOX, DOTMATICS, HRB CELLARIO, DATAHUB, PIPELINE, RAW, and API.

pipelineId

string

Returns information about files that match the pipeline file ID.

rawFileId

string

Returns information about files that match the RAW file ID.

size

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.

sort

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

sourceId

string

Returns files that match the specified ID for the source (typically an instrument that generated the RAW file).

sourceType

string

Returns files that match the specified type of source. This is typically the name of an instrument.

tags

array of strings

Include files that have the specified tags in the search results.

tags

toDate

date

Search for files created on or before a specific date.

traceId

string

Returns information about files that match the ID number generated when the RAW file is first uploaded to the data lake. To maintain traceability, all files derived from the RAW file, such as the IDS file, have the same traceId.

workflowId

string

(Added in TDP 3.1.0) ID of the pipeline workflow.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json