v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Search Files (POST) (Deprecated)

🚧 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.

post/v1/fileinfo/search

Request body

categorystring

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

frominteger

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.

fromDatestring date

Search for files created on or after a specific date.

excludeTagsstring[]

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

idsstring

Returns files that match the IDS schema.

integrationIdstring

Returns files that match the specified ID for the integration.

integrationTypestring

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

metadataobject

Search for files that have specific metadata.

pipelineIdstring

Returns information about files that match the pipeline file ID.

rawFileIdstring

Returns information about files that match the RAW file ID.

sizeinteger

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.

sortstring

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

sourceIdstring

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

sourceTypestring

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

tagsstring[]

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

toDatestring date

Search for files created on or before a specific date.

traceIdstring

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.

workflowIdstring

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

Response

200

frominteger

sizeinteger

sortstring

hasNextboolean

Example response

{
  "size": 1,
  "sort": "asc",
  "hits": [
    {
      "fileId": "ac2750f0-f252-4083-90d1-7825d2b1691f",
      "filePath": "/my-machine-name/UNICORN_HDAServer12.1/Default/Folders/DefaultHome/Cheng/01/sample_01 - SPPD-17-0050 BHIC 09APR17 New Resin Run 1 001.json/0.json",
      "orgSlug": "tetrascience",
      "traceId": "6f1b19f7-fa44-43fe-9d32-ad30ac3069a1",
      "file": {
        "bucket": "myBucketName",
        "path": "tetrascience/7abaa520-726d-4182-9e17-8c830f29ae0e/IDS/my-machine-name/UNICORN_HDAServer12.1/Default/Folders/DefaultHome/Cheng/01/sample_01 - SPPD-17-0050 BHIC 09APR17 New Resin Run 1 001.json/0.json",
        "checksum": "690a567e4d58c1ea87e5cb1d8c4fd54a-2",
        "size": 5984603,
        "version": "v3.A3soqFFydk2V1PXBwXcyJgV17sUuh"
      },
      "createdAt": "2021-08-21T23:13:04.000Z",
      "category": "IDS",
      "integration": {
        "id": "d61bcba5-3ebb-4149-a59d-16f4c20b4b86",
        "type": "datapipeline",
        "name": "Liang Unicorn v2.6.0 Test 05-04-2020",
        "workflowId": "eeac26b1-5034-4a1d-a97f-0c8b8cd2ea1e",
        "masterScript": "common/akta-raw-to-ids:v3.0.0",
        "taskScript": "common/akta-raw-to-ids:v3.0.0",
        "taskSlug": "akta-raw-to-ids",
        "taskExecutionId": "12202ae7-a796-4dc8-b048-0da994b38ec2"
      },
      "source": {
        "id": "7abaa520-726d-4182-9e17-8c830f29ae0e",
        "type": "unicorn-hda",
        "name": "UNICORN-TEST-AGENT-2",
        "datapipeline": {
          "workflowId": "eeac26b1-5034-4a1d-a97f-0c8b8cd2ea1e",
          "taskExecutionId": "12202ae7-a796-4dc8-b048-0da994b38ec2",
          "taskSlug": "akta-raw-to-ids",
          "taskScript": "common/akta-raw-to-ids:v3.0.0",
          "masterScript": "common/akta-raw-to-ids:v3.0.0",
          "inputFileId": "6f1b19f7-fa44-43fe-9d32-ad30ac3069a1"
        }
      },
      "rawFileId": "6f1b19f7-fa44-43fe-9d32-ad30ac3069a1",
      "ids": "common/akta:v3.0.0",
      "metadata": {
        "Version": "v330",
        "CREATED_FOR": "PQ",
        "cheeeng": "sss"
      },
      "tags": [
        "PQ"
      ]
    }
  ]
}