Versions Compared

Key

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

You can create a valid manifest file in several the following ways.

  • Using The Cancer Imaging Archive's (TCIA) data portal
  • Using the Manifest API
  • Using a shared list
  • Using JNLP data

:

Table of Contents

Creating a Manifest File Using TCIA

To use the Downloader AppNBIA Data Retriever, you must already have a manifest file that lists the files you want to download. You create the manifest file by searching the data radiology portal of The Cancer Imaging Archive. After installing the Downloader AppNBIA Data Retriever, double-click this manifest file to invoke the appapplication.

Note

Double-clicking the Downloader App NBIA Data Retriever icon alone does not invoke the Downloader AppNBIA Data Retriever.

To create a manifest file:

  1. Search for images of interest.
  2. Add those images to your data basketcart.
  3. Open Download images using the My Data Basket page and click Start DownloadNBIA Data Retriever.
    A manifest file is created and downloaded to your computer. 
    • If you have already installed the Downloader AppNBIA Data Retriever, double-click the manifest file to open it using the Downloader AppNBIA Data Retriever. Click Open when your web browser prompts you to open the file. 
    • If you want to use this manifest file to download images more than once or download images you select on other machines, click Save at the web browser prompt. You can then double-click the saved manifest file in Windows Explorer on Windows, Finder on Mac, or File Manager on Linux to invoke the Downloader AppNBIA Data Retriever.

Creating a Manifest File Using the Manifest Text API

You can also create a manifest file using the REST API. Refer to the REST API documentation Manifest Text API documentation for instructions on how to use the Manifest API. The outcome of the REST API call must be saved as a text file with the extension .tcia. 

Example Manifest Text Query 

Code Block
curl -H "Authorization:Bearer d98c390f-b53d-4456-beb3-110e63663762" -k "httphttps://localhost:8080services.cancerimagingarchive.net/nbia-api/services/getManifestTextV2" -d "list=1.3.6.1.4.1.9328.50.3.336&includeAnnotation=false"

The API returns text that can be used as a manifest file for the Downloader AppNBIA Data Retriever.

Code Block
downloadServerUrl=https://imaging-devcmservices.ncicancerimagingarchive.nih.govnet/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-1523866570303.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.9328.50.3.336

Creating a Manifest File Using a Shared List

The same is for Manifest API from Shared List, if the user has a shared list file in addition to the user account.

And also for Manifest API from JNLP Data,  the users need to have a JNLP file.

...