The following topics are included in this page.
OverviewYou can view or search for caDSR data by entering a URL in the address bar of a browser and passing parameters in that URL. This page provides examples to get you started, in legacy and caDSR II format:
You can display any of these formats (HTML, XML, or JSON) in an Internet browser by changing the parameter (GetHTML, GetXML, or GetJSON).
If you have trouble using any URL on this page in your Internet browser, copy and paste it into another browser. (The caDSR team tests functionality in Chrome.) Examples in caDSR II but not Legacy caDSRHeadings on this page marked with two asterisks (**) reflect functionality available in caDSR II but not in legacy caDSR. Examples for Data ElementsFind Data Element by Public ID and VersionThe following examples find a data element where Public ID = 62 and Version=6, displaying the basic metadata attributes. Legacy: Results Displayed in XMLThe URL for the results from the caDSR 4.1.x REST API is
caDSR II: Results Displayed in XMLThe URL for the results from the caDSR II REST API is
caDSR II: Results Displayed in HTMLThe URL for the results from the caDSR II REST API is
caDSR II: Results Displayed in JSONThe URL for the results from the caDSR II REST API is
**Allow Machine-to-machine Retrieval of a Data Element by Public ID and VersionThe following caDSR II example allows machine-to-machine retrieval of a data element by public ID and version. (You can test this URL only in a machine-to-machine scenario, not in a browser.)
If you want to create a REST API call from machine to machine or application to application, start your URL as follows:
Find Data Element by Public IDThe following example finds a data element with Public ID = 62, displaying the basic metadata attributes. Since the version is not known, this query can only be handled via a caDSR REST API query getting all versions. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Or the query can retrieve only the latest version.
Find Data Element by Public ID, Display All Related ComponentsThe following example finds a data element with Public ID = 62, displaying all the metadata associated with the data element's related components, not just the basic attributes. This is handled in the caDSR REST API using a parameter that produces expanded ("heavy") XML. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Find DEC Using Public ID, Display All Associated Data ElementsFind all the data elements associated with the DEC with Public ID = 2178546, displaying the basic metadata of the DEC and its data elements. LegacyThe URL for the results from the caDSR 4.0 REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Find Data Elements Associated with a Particular DEC Public ID and VersionThe following example finds only data elements associated with Version 2.1 of DEC with Public ID = 2178546. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Get Data Elements Using Concept Code or Concept NameThe following examples show how to retrieve data elements using either the concept code or the concept name where the concept is the Primary concept of the related caDSR item. In these examples, results are returned in XML. Legacy: Find All Data Elements Where Associated Concept is Primary Concept of Data Element's Object ClassThis example shows the use of either the Concept Code (C19448) or the Concept Name "Blood and Blood Products". Results are identical from these two calls, both are returned in XML.
caDSR IIThe URL for the results from the caDSR II REST API is
Legacy: Find All Data Elements Where Associated Concept is Primary Concept of Data Element's Property
caDSR IIThe URL for the results from the caDSR II REST API is
Legacy: Find All Data Elements Where Associated Concept is Primary Concept of One of Data Element's Value Domain Value Meanings
caDSR IIThe URL for the results from the caDSR II REST API is
Find All Enumerated Permissible Values for a Data ElementThe following examples find all enumerated permissible values for a data element using the data element's public ID and version or the data element's public ID (and getting latest version). Legacy
caDSR IIThe URL for the results from the caDSR II REST API is
Examples for Forms and Related ItemsFind a Form Using Form Public ID and Version, Display Basic Metadata AttributesThe following examples find a Form where Public ID = 2392775 and Version=1.0, displaying the basic metadata attributes. Legacy: Results Displayed in the Form BuilderThis method can be used to retrieve Forms only when you know both the Public ID and Version number. Legacy: Results Displayed in XMLThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Find a Form Using Only Public IDThe following example finds a Form with Public ID = 2392775, displaying the basic metadata attributes. Since the version is not known, this query can only be handled via a caDSR REST API query. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Find a Form Using Public ID, Display All Metadata Associated with Data ElementsThe following example finds a Form with Public ID = 2392775, displaying all the metadata associated with the data element's related components, not just the basic attributes. This is handled in the caDSR REST API using a parameter that produces expanded ("heavy") XML. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Find All Forms Associated with Particular Data Element Public ID and VersionThe following example finds all the Forms associated with the CDE with Public ID = 2183364, Version 1.0, displaying the basic metadata of the Form. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Get all Modules Associated with a Form Using Form Public IDThe following example gets all the modules for a form with Public ID = 2392775. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Get All the Questions for a Module Using Module Public ID and VersionThe following example gets all the questions for a module with Public ID = 2392777 and version = 1.0. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Get All the Data Elements for Question Using Question Public ID and VersionThe following example gets all the data elements for a question with Public ID = 2392779 and version = 1.0. LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
**Retrieve a caDSR Form with All Its Collections ("Flattened")The following caDSR II examples retrieve a caDSR form with all its collections, or "flattened". This means for a given form, the system returns all Modules, Questions, Valid Values and related instructions in one call. The system returns results as a JSON file. XML and HTML formats are not available for this query. You must specify a version. The following example retrieves a form without specifying a protocol:
The following example specifies a protocol:
**Return Form by Public ID and ProtocolThe following caDSR II example retrieves forms with protocol by public ID.
Examples Using ConceptsRetrieving the Value Meaning Concept Codes for a Data Element That Has an Enumerated Value DomainGiven a data element, you can retrieve the corresponding concept codes for the permissible values in a Value Domain. If there is a data element with For example
Retrieving a caDSR Item That Has Concept Using the Concept Code or Name, but Restricting the Search to Only Retrieving Items if the Concept is the Primary ConceptTo search for data elements using a concept code or name, but restrict the results to only Primary concepts in the Object Class, refer to the following examples. LegacyRetrieve data elements with Object Class Concept "C19448" (result in XML) but only if the Concept is indicated as the Primary concept. This is done using the Concept's primaryFlag indicator = "Yes".
caDSR II
Both Legacy and caDSR IIAdditionally, you can find all Data Elements where the concept is used either as a primary OR qualifier concept. This is accomplished by removing the last qualifier in the query. Removing this criteria returns 104 results instead of 88.
caDSR II
LegacyTo retrieve the next higher order "type" administered items, remove the name of the item(s) before it in the query argument list. For example, to get Data Element Concepts (DECs) with its Property Primary Concept longName E-Mail Address, remove DataElement (the first item in the query argument list): Retrieve DECs with Property Primary Concept name E-Mail Address.
caDSR II
LegacyRetrieve Data Elements with its ValueDomain having a ValueMeaning with a Primary Concept longName Blood and Blood Products (result in XML).
caDSR II
**Return Permissible Value Info Including Associated Concepts for a CDEThe following caDSR II example returns the Permissible Value information for a given CDE. If you do not specify the version, the query returns the latest version.
Retrieve all Data Elements Using a Common EVS Concept Code or Name, but Restrict Results to Only Those Where the Concept is “Primary” in the CDE’s PropertyThis can be done through any of the caDSR APIs, as well as for restricting to Property or a Value Meaning in the CDEs Enumerated Value Domain. Legacy: Retrieve data elements with Property “Primary” concept with concept code "C19448" (result in XML).
To find all data elements where the concept is used either as a primary OR qualifier concept, remove last qualifier in the query.
Removing this criteria returns 104 results instead of 88. Legacy: Retrieve DECs with Property “Primary” concept named “E-Mail Address”.
Legacy: Retrieve data elements with Value Domain's Value Meaning "Primary" concept code= C19448 (Blood and Blood Products”) (result in XML).
caDSR II: Retrieve all Data Elements where the Object Class “Primary” concept is concept name "E-mail Address" (result in XML).
Examples for Other ItemsRetrieve All Administered Components Associated with ClassSchemeClassSchemeItem with Particular IDThe following example gets all Administered Components for ClassSchemeClassSchemeItem with ID = A55C551C-1866-5ED1-E034-080020C9C0E0. This retrieves all ACs and sorts them according to type (Form, DE, DEC, and so on). LegacyThe URL for the results from the caDSR 4.1.x REST API is
caDSR IIThe URL for the results from the caDSR II REST API is
Retrieving Any Administered Component by Public IDThe following examples retrieve any administered component by public ID. Legacy
caDSR II
|
Retrieve All ClassSchemeClassSchemeItem Associated with ClassificationSchemeItem and ClassificationSchemeThe following example gets all
LegacyThe URL for the results from the caDSR 4.1.x REST API is
|