NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

The following page lists the Swagger files for available caDSR II REST APIs:

https://cadsrapi.cancer.gov/NCIAPIPortal/listAPIs

For example, the "Get Form Data with Collections" API accepts a Form ID and Protocol ID as input and returns all the components of the form: Form information, Modules, Questions, and Valid Values, including all instructions for each section of the form.

The following table describes each API: 

APIDescription
caDSR getJSONcaDSR II APIs that mimic the Legacy caDSR APIs but return results in JSON.
caDSR getXMLcaDSR II APIs that mimic the Legacy caDSR APIs and return content as XML.
caDSR getHTMLcaDSR II APIs that mimic the Legacy caDSR APIs and return content as HTML for viewing and linking to Collections from a web browser.
caDSRII Get PV JSONcaDSR II API that directly returns the Permissible Values for a CDE. Results are in JSON.
caDSRII Get PV XMLcaDSR II API that directly returns the Permissible Values for a CDE. Results are in JSON.
caDSRII Get Model APIs

A set of caDSR II APIs that query Data Models registered in caDSR.  When the models have been semantically linked.

  • GetModelAttributes - returns all the tables and attributes in a Target model
  • GetModelMappedElements - returns the table/attribute in a Target model that is mapped to a table/attribute in a Source model - usually one-to-one but can return more than one
  • GetModelMappedTableElements - returns all the attributes in a Target model that are mapped to a table in a Source Model - one-to-many
  • GetModelMappedValues - returns the valid value for an attribute in a Target model that is mapped to a valid value in the Source Model table/attribute - usually one-to-one  
caDSRII Get Form with CollectionscaDSR II API that returns a "flattened" form. All of it's Modules with its instructions, Questions and their instructions, and Valid Values and their instructions. It can be queried using the Form ID and Version and optionally a Protocol Short Name. 


  • No labels