get https://api.tetrascience.com/v1/fileinfo/file/
Description
Displays file information, such as the file creation date, size, and location.
Authentication
Use the JSON Web Token (JWT) and the name of the organization to authenticate. For more information on how to do this, see https://developers.tetrascience.com/reference/authentication.
Responses
Responses are in JSON format.
200 OK
Request was completed successfully. Results of the request appear in the table below.
| Parameter | Description | Type |
|---|---|---|
| orgSlug | Name of your organization. | string |
| fileId | UUID for the file in the data lake. | uuid |
| traceId | 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. | uuid |
| rawFileId | UUID for the RAW file that this file was generated from. | uuid |
| category | File category. Values are RAW, IDS, and PROCESSED. | string |
| ids | Name, type, and version of the schema used to create the IDS file. Format is {namespace}/{idsType}:{idsVersion}. | string |
| filePath | Path to the IDS JSON file. | string |
| createdAt | Date and time that the file was created. Note that the date/timestamp is in Zulu (UTC) time. | date (timestamp) |
| integration | Tetrascience integrates with many different products, such as Box, Dotmatics, and DataHub. The response contains the integration type, file type that is produced, the source, source type, integration ID and source ID. | mixed (uuid, string) |
| integration.id | ID for the integration. | uuid |
| integration.type | Integration type. Values are EGNYTE, BOX, DOTMATICS, HRB CELLARIO, DATAHUB, PIPELINE, RAW, and API. | string |
| source | Indicates the source of the file. This is typically the source ID, the name of an instrument that generated the data, and a brief description of the file data. | string |
| source.id | ID for the source. | uuid |
| source.type | Type of source, which is typically the name of the instrument or other lab equipment used to generate the data or report. | string |
| source.name | Name of the source. | string |
| file | Provides file location information including the bucket, path, checksum, size, type, and version. | mixed (string, number) |
| file.bucket | Name of the data lake S3 bucket the file is assigned to. | string |
| file.path | Path to the data lake S3 bucket where the file is stored, starting with the organization’s root directory. | string |
| file.checksum | Checksum (number of bits used to verify file integrity) assigned by the data lake S3 bucket. | string |
| file.size | Size of the file. | number |
| file.type | Type of file. | string |
| file.version | File version’s ID. | uuid |
| metadata | Lists metadata, if present. Metadata could include items like the instrument or other lab equipment used to create the file and/or custom metadata the user added to the file (if any). | mixed (object, string) |
| tags | Lists tags that the user added to the file. | array of strings |
| deleted | Indicates whether the file was deleted. Values are TRUE, FALSE. | boolean |
| outdated | Indicates whether there is at least one newer version of the file available. If a newer version is available, outdated is set to TRUE. Values are TRUE, FALSE. | boolean |
401 Unauthorized
There is a problem with authorization. See https://developers.tetrascience.com/reference/authentication for details.
404 Not Found
There was no api method associated with the endpoint you indicated.
500 Internal Server Error
There was a problem with the website’s server or a network issue.