Skip to end of metadata
Go to start of metadata

You can create a manifest file in several ways:

Creating a Manifest File Using TCIA

To use the NBIA 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 portal of The Cancer Imaging Archive. After installing the NBIA Data Retriever, double-click this manifest file to invoke the application.

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

To create a manifest file:

  1. Search for images of interest.
  2. Add those images to your cart.
  3. Download images using the NBIA Data Retriever.
    A manifest file is created and downloaded to your computer. 
    • If you have already installed the NBIA Data Retriever, double-click the manifest file to open it using the NBIA 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 NBIA Data Retriever.

Creating a Manifest File Using the Manifest API

Refer to the Manifest API documentation for instructions on how to use the API. The outcome of the REST API call must be saved as a text file with the extension .tcia. 

Example Manifest Query 

curl -H "Authorization:Bearer d98c390f-b53d-4456-beb3-110e63663762" -k "http://localhost:8080/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 NBIA Data Retriever.

downloadServerUrl=https://imaging-devcm.nci.nih.gov/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 the Shared List API

If you have a shared list, you can use the Shared List Query API to create a manifest file. Refer to the Shared List Query API documentation for instructions on how to use the API.

Example Manifest from Shared List Query 

curl -H "Authorization:Bearer a99171a1-b289-4700-9e4e-1bd73ce1bbb5" -k "http://localhost:8080/nbia-api/services/getManifestTextFromSharedList" -d "sharedList=scottslist&includeAnnotation=false"

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

downloadServerUrl=https://imaging-devcm.nci.nih.gov/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 the JNLP Data Query API

If you have a JNLP file, you can use the JNLP Data Query API to create a manifest file. Refer to the JNLP Data Query API documentation for instructions on how to use the API.

Example Manifest from JNLP Data Query 

curl -H "Authorization:Bearer 3b2bf812-a97e-454e-af94-623b868a2955" -k "http://localhost:8080/nbia-api/services/getManifestFromJNLPFileData" -d "jnlpArgument=C:\Apps\nbia\apache-tomcat-7.0.68\temp\jnlp-data1521628213301.txt&includeAnnotation=false"

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

downloadServerUrl=https://imaging-devcm.nci.nih.gov/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


  • No labels