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:
API | Description |
---|---|
caDSR getJSON | caDSR II APIs that mimic the Legacy caDSR APIs but return results in JSON. |
caDSR getXML | caDSR II APIs that mimic the Legacy caDSR APIs and return content as XML. |
caDSR getHTML | caDSR 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 JSON | caDSR II API that directly returns the Permissible Values for a CDE. Results are in JSON. |
caDSRII Get PV XML | caDSR 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 can be retrieved in XML or JSON.
|
caDSRII Get Form with Collections | caDSR II API that returns a "flattened" form:
The form can be queried using the Form ID and Version and optionally a Protocol Short Name. |