Get file IDs

/v2/action/files/get_ids

This call allows you to get the ID for a file, which you can then use to perform operations on that particular file, or to request more information about it.

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/action/files/get_ids

Request

Example request

HTTP

POST /v2/action/files/get_ids HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96

cURL

curl --data '["/Datasets/tcga/TCGA-LUAD/ac0d7a82-82cb-4aec-b859-e37375f3de8b/analysis/1e849d63-a360-4d35-b9fe-745a3f0bf291/data/C509.TCGA-97-8547-01A-11D-2393-08.2.bam"]' -s -H "X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96" -H "content-type: application/json" -X POST "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/action/files/get_ids"

Request body

In the body, you should enter an array of strings, containing the file paths.

Body
array of strings, consisting of file paths.

Header Fields

Name	Description
X-SBG-Auth-Token required	Your authentication token.

Query parameters

Name	Data type	Description
fields	string	Selector specifying a subset of fields to include in the response.

Response

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

Example response body

JSON

[
    "567890abc9b0307bc0414164"
]

Note that if you submit an incorrect file path, the call will return the value null. Also, the resulting array will have the same order of elements as in the request.