- You access a resource by sending an HTTP request to the TCIA API server. The server replies with a response that either contains the data you requested, or a status indicator.
- You can access the metadata of an API by appending /metadata to the end of the query. See examples. The metadata is in JSON format and conforms to this schema
- Most APIs can return results as CSV/JSON/XML/HTML. You can specify the return format by including the query parameter format
- An API request takes the following structure:
For example, the API shown below is a request to get all studies in the TCGA-GBM collection for patient GBM-0123 as CSV (note this example patID is not a valid TCGA-GBM ID and this call will fail if entered without editsreturn only column headers)
This can be broken down as follows: