Page History
Excerpt | ||
---|---|---|
| ||
Drafting content for DSRMWS-1385 (from email) and for DSRMWS-31 (from Jira comments). |
The following page lists all the caDSR II and caDSR Legacy APIs that are currently available, as well as the available REST deprecated APIs. Swagger files for available caDSR II APIs:
https://cadsrapi-dev.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.
Example page
https://cadsrapi-dev.cancer.gov/caDSR/
(TBD: Is there someone who can add an example URL for example 14, so I can resolve the TBD in caDSR II - caDSR APIs?)
Data Element Example
Panel | |||||
---|---|---|---|---|---|
| |||||
|
Forms Example
Panel | |||||
---|---|---|---|---|---|
| |||||
|
Forms Example with Protocol
Panel | |||||
---|---|---|---|---|---|
| |||||
|
REST API Example
...
borderColor | silver |
---|---|
borderStyle | solid |
...
AllowLineWrap | true |
---|
...
The following table describes each API:
API | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
caDSR getJSON | caDSR II APIs that return results in JSON. | ||||||||||
caDSR getXML | caDSR II APIs that return content as XML. | ||||||||||
caDSR getHTML | caDSR II APIs that 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 are 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. |
Include Page | ||||
---|---|---|---|---|
|