Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxLevel1

Overview

The Cancer Imaging Archive )TCIA) is a publisher of cancer related data. Each Collection is issued a Digital Object Identifier (DOI) through DataCIte. DataCIte provides a REST API that can be used to search metadata according to their published schema. Please note that this API was not developed by TCIA and is not supported through the TCIA help desk. 

Please refer to the Documentation below for how to use the DataCite REST API to query TCIA metadata

The Cancer Imaging Archive is identified within DataCite as

  • prefix-id 10.7937
  • client-id = sml.tcia
  • provider-id = tciar

Properties

TCIA utilizes the following Properties of the DataCite schema.

Table 1: DataCite Mandatory Properties ID 

Property Obligation 
Identifier (DOI of the Dataset)
Creator (Authors of the Dataset, preferably with ORCIDID))
Title (Published Title of the Dataset) 
Publisher (The Cancer Imaging Archive)
PublicationYear (The Year the Dataset was published in TCIA)
10 ResourceType (Dataset; Equivalent to a TCIA Collection) 


Table 2: DataCite Recommended and Optional Properties ID 

Property Obligation 
11AlternateIdentifier (TCIA Short Name for the Dataset)O
15Version (The Current Version of the Dataset)O
16Rights (Licensing Information)O
17 Description (Dataset Abstract)


Examples


Info
titleRetrieve a single DataCite record in JSON format.

For this example we are using a Published Collection called "Pseudo-PHI-DICOM-Data":

https://api.datacite.org/dois/10.7937/s17z-r072


Info
titleReturn a list of DOIs using the TCIA provider id (tciar)

https://api.datacite.org/dois?provider-id=tciar

By default, only 25 records are returned. You can control the number of records returned using pagination options. For example, to return only 5 records

https://api.datacite.org/dois?provider-id=tciar&page[size]=5 

or

https://api.datacite.org/providers/tciar/dois?page[size]=5


Info
titleQuery on specific information populated in the DataCite schema

For instance, return the records published by The Cancer Imaging Archive that were published in 2016:

https://api.datacite.org/dois?query=publisher:%22The%20Cancer%20Imaging%20Archive%22+publicationYear:2016

or

https://api.datacite.org/providers/tciar/dois?created=2016


Info
titleUse the "activities" endpoint to see metadata updates in JSON format for a specified DataCite record.

For this example we are using a Published Collection called "Pseudo-PHI-DICOM-Data":

https://api.datacite.org/dois/10.7937/s17z-r072/activities