Date: Fri, 29 Mar 2024 03:09:54 -0400 (EDT) Message-ID: <2086939169.928.1711696194049@ip-10-208-27-219.ec2.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_927_1365110960.1711696194047" ------=_Part_927_1365110960.1711696194047 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
You can try the caDSR APIs to search for caDSR data by entering = a URL in the address bar of a browser and passing parameters in that URL. T= his page provides examples to get you started.
A URL in caDSR II format returns HTML, XML, or JSON. Using the API, you can allow an application= to connect to caDSR and search the database. The caDSR II Domain Class Browser page is a web browser interface tha= t allows you to test the caDSR II API.
You can display any of these formats (HTML, XML, or JSON) in an Internet= browser by changing the parameter (GetHTML, GetXML, or <= em>GetJSON).
Multiple AND IN Note
You cannot enter multiple "and"
or "in"
values=
for search criteria when using the REST (XML-HTTP) API.
If you have trouble using any URL on this page in your Internet browser,= copy and paste it into a Google Chrome browser before contacting Applicati= on Support (NCIAppSupport@mail.nih.gov).
This page includes the following topics.
The following examples find a data element where Public ID =3D 62 and Ve= rsion=3D6, displaying the basic metadata attributes.
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=3DDataElement[@publicId=3D62= ,@version=3D6]
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetHTML?query=3DDataElement[@publicId=3D6= 2,@version=3D6]
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetJSON?query=3DDataElement[@publicId=3D6= 2,@version=3D6]
The 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 mac= hine-to-machine scenario, not in a browser.)
https:/= /cadsrapi.cancer.gov/rad/caDSR.restapi:GetXML_rad/GetXML/query=3DDataElemen= t[@publicId=3D62,@version=3D6]
If you want to create a REST API call from machine to machine or applica= tion to application, start your URL as follows:
https:/= /cadsrapi.cancer.gov/rad/caDSR.restapi:GetXML_rad/
The following example finds a data element with Public ID =3D 62, displa= ying the basic metadata attributes. Since the version is not known, this qu= ery can only be handled via a caDSR REST API query getting all versions.
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetHTML?query=3DDataElement[@publicId=3D6= 2]
Or the query can retrieve only the latest version.
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetHTML?query=3DDataElement[@publicId=3D6= 2,@latestVersionIndicator=3Dyes]
The following example finds a data element with Public ID =3D 62, d= isplaying all the metadata associated with the data element's related compo= nents, not just the basic attributes. This is handled in the caDSR REST API= using a parameter that produces expanded ("heavy") XML.
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=3DDataElement[@publicId=3D62= ]&returnHeavyXML=3Dtrue
The following example finds all the data elements associated with the DE= C with Public ID =3D 2178546, displaying the basic metadata of the DEC and = its data elements.
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetHTML?query=3DDataElement&DataEleme= ntConcept[@publicId=3D2178546]
The following example finds only data elements associated with Version 2= .1 of DEC with Public ID =3D 2178546.
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=3DDataElement&DataElemen= tConcept[@publicId=3D2178546,@version=3D2.1]
The following examples show how to retrieve data elements using either t= he concept code or the concept name where the concept is the Primary concep= t of the related caDSR item. In these examples, results are returned in XML= .
This example shows the use of the Concept Code (C19448). Results are ret= urned in XML.
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=3DDataElement,DataElementCon= cept,ObjectClass&ComponentConcept[Concept[@preferredName=3DC19448],@pri= maryFlag=3DYes]
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=3DDataElement,DataElementCon= cept,Property&ComponentConcept[Concept[@preferredName=3DC42775],@primar= yFlag=3DYes]
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=3DDataElement,ValueDomain,Va= lueDomainPermissibleValue,PermissibleValue,ValueMeaning&ComponentConcep= t[Concept[@preferredName=3DC19448],@primaryFlag=3DYes]
The 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). You must specify either version = or latestVersionIndicator. If you specify latestVersionIndicator=3DNo, the = query returns all permissible values across all versions of the CDE.
The URL for the results from the caDSR II REST API is
https:/= /cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=3DPermissibleValue,ValueDoma= inPermissibleValue,ValueDomain&DataElement[@publicId=3D106,@version=3D5= .1] https://cadsrapi.cancer.gov/invoke/caDSR/GetXML?query=3DPermissibleValue,Va= lueDomainPermissibleValue,ValueDomain&DataElement[@publicId=3D106,@late= stVersionIndicator=3DYes]