The swagger files for available caDSR II REST APIs can be found here at the caDSR II API Portal. A new caDSR II API has been created for retrieving a caDSR form with all its collections, or "flattened". This means for a given form, all Modules, Questions, Valid Values and related instructions are returned in one call. The results are returned as a JSON file. To see what this file looks like use this link: https://cadsrapi.cancer.gov/invoke/ctsu.test/getJSON?query=Form[@publicId=3813416,@version=1]
The primary caDSR II APIs have been designed with ease of migration for existing customers. 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:
Legacy Format: cadsrapi.nci.nih.gov/cadsrapi4/GetXML?query=DataElement[@publicId=62][@latestVersionIndicator=Yes]
New format: https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=DataElement[@publicId=62,@latestVersionIndicator=yes]
Note:
- 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
- XML, HTML and now JSON formats are available. To switch object format change the "Get" parameter: GetXML, GetHTML, GetJSON
