This page documents the OODT File Manager REST API


Download a product (by ID) from the CAS REST API

Sample REST URL

http://host/fmprod/data?productID=3abc2ec0-721e-11de-831c-abb3b8e32d26

Parameters

query:
 productId <UUID>
 format (optional) application/x-zip

Response

  HTTP 200 OK
     - Raw Data Content if format is not application/x-zip
     - Zipped Data Content containing product .met XML file, 
       along with raw data content

Download an entire datast (by ID) from the CAS REST API

Sample REST URL

http://host/fmprod/dataset?typeID=urn:ns:Dataset

Parameters

query:
 typeID <A valid product type name>

Response

  HTTP 200 OK
     - Zipped Data Content containing product zip files containing 
       their .met XML files, along with raw data content

Get an RDF stream of current datasets from CAS

Sample REST URL

https://host/fmprod/rdf/dataset?filter=SomeMetKey:SomeMetValue&type=ALL

Parameters

query:
 type <A valid product type name, or ALL to denote all of them>
 typeID <A valid product type id; only use this when not using ALL>
 filter (optional) A query in Lucene-style syntax to limit returned 
              RDF to only those datasets that match the filter 
              criteria

Response

  HTTP 200 OK
     - MIME: application/x-rdf
     - RDF description of all matching datasets for filter if 
       provided, for all datasets, if ALL is used, or as 
       identified by type and typeID.

Sample

<?xml version="1.0" ?>
<rdf:RDF xmlns:cas="urn:oodt:" xmlns:edrn="urn:edrn:" 
     xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
     xmlns:x="http://edrn.nci.nih.gov/rdf/schema.rdf#">
 
 <edrn:WHIColonUniversityofMichiganChinnaiyan 
     rdf:about="http://host/prodserver//dataset/ID">
   
   <edrn:Date>
     2011-08-30T03:46:00.000Z
   </edrn:Date>
   <edrn:PubMedID>
     TBD
   </edrn:PubMedID>
   <x:protocol 
     rdf:resource="http://edrn.nci.nih.gov/data/protocols/126"/>
   <edrn:DataCustodian>
     Arul Chinnaiyan
   </edrn:DataCustodian>
 </edrn:WHIColonUniversityofMichiganChinnaiyan>
 
</rdf:RDF>

Get an RDF stream of current products from CAS

Sample REST URL

https://host/fmprod/rdf?id=urn:ns:Dataset&type=Dataset

Parameters

query:
 type <A valid product type name, or ALL to denote all of them>
 id <A valid product type id; only use this when not using ALL>

Response

  HTTP 200 OK
     - MIME: application/x-rdf
     - RDF description of all matching product metadata for all 
       products, if ALL is used, or as identified by type and 
       id.

Sample

<?xml version="1.0" ?>
  <rdf:RDF xmlns:cas="urn:oodt:" xmlns:edrn="urn:edrn:" 
       xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
       xmlns:x="http://edrn.nci.nih.gov/rdf/schema.rdf#">
 
  <edrn:WHIColonKarmanosCancerInstituteTainsky 
 rdf:about="http://host/prodserver//data?productID=..">
   
   <edrn:ProductDescription>
     TBD
   </edrn:ProductDescription>
   <edrn:SpecimenType>
     Plasma
   </edrn:SpecimenType>
   <cas:FileLocation>
     /data/archive/kci/110901/Colon/Unknown
   </cas:FileLocation>
   <cas:CAS.ProductName>
     EDRN_WHI_Tainsky-rawData.csv
   </cas:CAS.ProductName>
   <edrn:DateProductFrozen>
     TBD
   </edrn:DateProductFrozen>
   
 </edrn:WHIColonKarmanosCancerInstituteTainsky>
 
</rdf:RDF>

Get an RSS 2.0 feed of current products from CAS

Sample REST URL

https://host/fmprod/viewRecent?channel=ALL

Parameters

query:
 channel <A valid product type name, or ALL to denote all of them>
 id <A valid product type id; only use this when not using ALL>
 topn The number, by default 20, of results to show

Response

  HTTP 200 OK
     - MIME: application/x-rss
     - RSS description of all matching product metadata and link 
       for all products, if ALL is used, or as identified by type 
       and id.

Sample

<?xml version="1.0" ?>
 <rss version="2.0" xmlns:cas="http://oodt.jpl.nasa.gov/1.0/cas">
 
 <channel>
   <title>
     ALL
   </title>
   <link>
   http://host/prodserver//rdf/dataset?type=ALL
   </link>
   <description>
     ALL
   </description>
   <language>
     en-us
   </language>
   <copyright>
     Copyright 2010: Apache Software Foundation
   </copyright>
   <pubDate>
     Tue, 31 Jan 2012 13:56:27 PST
   </pubDate>
   <category>
     ALL
   </category>
   <generator>
     CAS File Manager
   </generator>
   <lastBuildDate>
     Tue, 31 Jan 2012 13:56:27 PST
   </lastBuildDate>
   <item>
     <title>
       05L54__UTSW Tumor Batch1 Illumina Expression processed
     </title>
     <description>
       UTSW_GeneExpressionAnalyzedData
     </description>
     <link>
     http://host/prodserver//data?productID=...
     </link>
     <pubDate>
       Tue, 06 Sep 2011 20:43:37 PDT
     </pubDate>
     <cas:source>
       UTSW_GeneExpressionAnalyzedData
     </cas:source>
     <source>
       UTSW_GeneExpressionAnalyzedData
     </source>
     
   </item>
 </channel>
 
</rss>
  • No labels