Get file details

/files/{file_id}

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call returns details about a specified file. The call returns the file's name, and all of its metadata.

Files are specified by their IDs, which you can obtain by making the API call to list files in a project.

https://cavatica-api.sbgenomics.com/v2/files/{file_id}

šŸš§

Metadata

Learn more about metadata fields and their values on CAVATICA.

Request

Example request

GET /v2/files/567890abc4f3066bc3750174 HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 1e43fEXampLEa5523dfd14exAMPle3e5
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/files/567890abc4f3066bc3750174"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Path parameters

Name

Description

file_id

The ID of the file whose details you want to GET.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

Response

See a list of CAVATICA-specific response codes that may be contained in the body of the response.

Example response body

{
  "href": "https://cavatica-api.sbgenomics.com/v2/files/567890abc4f3066bc3750174",
  "id": "567890abc4f3066bc3750174",
  "name": "_1_1000G_phase1.snps.high_confidence.b37.vcf",
  "size": 363,
  "project": "RFranklin/my-project",
  "created_on": "2015-12-11T11:01:49Z",
  "modified_on": "2015-12-11T11:01:49Z",
  "origin": {},
  "metadata": {
    "file_type": "vcf",
    "file_extension": "VCF"
  }
}

šŸ‘

Interpreting the response body

The object origin denotes the task that produced the file, if it was created by a task on CAVATICA.
The dictionary object metadata lists the metadata fields and values for the file.


Language
Click Try It! to start a request and see the response here!