Get a file's metadata

files/{file_id}/metadata

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

This call returns the metadata values for the specified file.

šŸš§

Metadata on the Platform

Learn more about metadata fields and their values on CAVATICA.

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

Request

Example request

GET /v2/files/567890abc9b0307bc0414164/metadata 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/567890abc9b0307bc0414164/metadata"

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your CAVATICA authentication token.

Path parameters

NameDescription
file_idThe ID of the file whose details you want to GET.

Query parameters

NameData typeDescription
fieldsstringSelector 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

{
  "sample_id": "E16201_pool35_L1756",
  "library_id": "hg19",
  "platform_unit_id": "C18_99",
  "platform": "IonTorrent",
  "quality_scale": "sanger"
}

Language