NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Revised avoid future tense & passive voice. Otherwise revised to be consistent.

...

In the above example, the Target Format is GetXML, the Target is DataElement, and the Implicit Criteria are @publicId=62,@version=6. In the Implicit Criteria, one ID is publicID publicId and the corresponding Value is 62, while the other ID is version and the corresponding Value is 6. 

...

Parameter

Description

<Target Format>

Result format (XMLGetXML, JSONGetJSON, HTMLor GetHTML).  The Target Format is preceded with Use the prefix “Get” Get followed by the format (one of XML, JSON, or HTML) concatenated as one word. :  

  • If your Target Format =XML:  … is XML, use … /GetXML?query= …   will to return Target in the form XML.
  • If your Target Format = is JSON, use … /GetJSON?query= … will to return Target in the form JSON.
  • If your Target Format = is HTML: , use … /GetHTTP?query= … will to return Target in the form HTML.

<Target>

Result class name. Use a valid caDSR Class name, such as DataElement, Form, (full list TBD).

For example,   use … query=Form[ … ]   will to return caDSR Form class information.

<Criteria>

The criteria class that identifies the association to be traversed when retrieving the target/result class.    The The Criteria will constrain the target/result based on the associated id/id value ID and ID_VALUE pair or pairs provided that you provide in the braces square brackets [ … ].

Note: The Criteria can be nested within the braces You can nest Criteria in the square brackets [ … ]. If the Criteria =is the Target, then a short hand can be used and the Criteria is assumed you can use a shorthand and the system assumes the Criteria to be equal to the Target. (this is referred to as an This is considered Implicit Criteria.).

  • Implicit Example: Use GetXML?query=DataElement[@publicId=62]   Return to return a Data Element with Data Element Public IdpublicId=62 in XML format.
  • Nested and Implicit Example:   Use GetXML?query=Form[Protocol[@preferredName=C3D ADOPTER TEMPLATES],@publicId=2392775]  Returns to return Form with Protocol preferredName=C3D ADOPTER TEMPLATES AND and Form publicId=2392775

<ID>

Attribute of the Criteria class used to constrain the query.   For more than one attribute, use a comma between each attribute.   The query will perform performs the “AND” AND operation for all id/id value all ID and ID_VALUE pair parameters you have provided for the Criteria class class you have identified.

For example,  use [@publicId= …]   combined with the ID_VALUE below will be used to identify the constraints for the result returned.

<ID_VALUE>

A string identifying the qualified criteria class data to be used as a filter on the result set.  1  One or more idID-criteria pair pairs may be used.

For example, use [@publicId=62,@version=6] to identify the qualified criteria class. 


Comparing the format of The following examples demonstrate the differences between the legacy caDSR to format and the caDSR II format:

A legacy caDSR (old) example:

...