Page History
HTML Comment | ||
---|---|---|
| ||
Note to editors of this wiki space: In DSRMWS-31, Denise said "all caDSR II urls should be .cancer.gov". |
You can find Swagger files for available caDSR II REST APIs in the following API Portal:
https://cadsrapi.cancer.gov/NCIAPIPortal/listAPIs
You can browse caDSR II API domain classes in the following API Browser. A folder icon next to a class name indicates that you can click on that node to perform a search:
The caDSR II APIs have been designed to be as easy to use as possible. There is a change to the syntax of the URLs, but everything else is the same. For example to retrieve the latest version of CDE with public Id 62 the legacy API call is formatted like this:
Legacy Format: https://cadsrapi.ncicancer.nih.gov/cadsrapi4/GetXML?query=DataElement[@publicId=62][@latestVersionIndicator=Yes]New format: caDSR/domain/browser.dsp
We have designed the primary caDSR II APIs for ease of migration for existing customers. The following example retrieves the latest version of the CDE with public ID 62:
...
NoteKeep in mind the following points:
- Both the publicId and latestVersionIndicator attribute criteria on DataElement are in brackets separated by a comma ","
- Class and attribute names are the same as in the legacy format
- .
- caDSR II offers XML, HTML, and now JSON formats are available. To switch object format, change the "Get" paramaterparameter: GetXML, GetHTML, or GetJSON
...
- .
This page family includes the following pages:
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Tip | ||||||
---|---|---|---|---|---|---|
| ||||||
|