NIH | National Cancer Institute | NCI Wiki  

WIKI MAINTENANCE NOTICE

Please be advised that NCI Wiki will be will be undergoing maintenance on Monday, June 24th between 1000 ET and 1100 ET.
Wiki will remain available, but users may experience screen refreshes or HTTP 502 errors during the maintenance period. If you encounter these errors, wait 1-2 minutes, then refresh your page.

If you have any questions or concerns, please contact the CBIIT Atlassian Management Team.

The following page lists all the caDSR II and caDSR Legacy APIs that are currently available, as well as the deprecated APIs. Swagger files for available caDSR II APIs:

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

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 return results in JSON.
caDSR getXMLcaDSR II APIs that return content as XML.
caDSR getHTMLcaDSR II APIs that 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 XML.

caDSRII Get Model APIs

A set of caDSR II APIs that query Data Models registered in caDSR, when the models have been semantically linked. Results are in XML or JSON.

APIDescription
GetModelAttributesReturns all the tables and attributes in a Target model.
GetModelMappedElementsReturns 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. 
GetModelMappedTableElementsReturns all the attributes in a Target model that are mapped to a table in a Source Model, one-to-many. 
GetModelMappedValuesReturns 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 Collections

caDSR II API that returns a "flattened" form:

  • All of the form's Modules and their instructions.
  • All of the form's Questions and their instructions.
  • All of the form's Valid Values and their instructions.

The form can be queried using the Form ID and Version and optionally a Protocol Short Name. 

  • No labels