NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Scrollbar
iconsfalse

...

Page info
title
title

Panel
titleContents of this Page
Table of Contents
minLevel2

...

LexEVS conforms to the caCORE SDK API - for more information see caCORE SDK 4.1 Programmer's Guide.

QueryOptions

QueryOptions are designed to give the user extra control over the query before it is sent to the system. QueryOptions may be used to modify a query in these ways:

  1. 'CodingScheme' - Restricts the query to the specified Coding Scheme, instead of querying every available Coding Scheme.
  2. CodingSchemeVersionOrTag' - Restricts the query to the specified Version of the Coding Scheme. Note that:
    1. This may NOT be specified without also specifying the 'CodingScheme' attribute.
    2. If left unset, it will default to the version of the Coding Scheme tagged as "PRODUCTION" in the system.
  3. 'SecurityTokens' - Security Tokens to use with the specified query. These Security Tokens are scoped to the current query ONLY. An subsequent queries will also need to specify the necessary Query Options.
  4. 'LazyLoad' - Some high use-case model Objects have bee 'lazy-load' enabled. This means that some attributes and associations of a model Object may not be fully populated when returned to the user. This allows for faster query times. This defaults to false, meaning that all attributes and associations will be eagerly fetched by the server and model Objects will always be fully populated. To enable this on applicable Objects, set to true.

    Info
    titleNote

    Lazy Loading may only be used in conjunction with specifying a Coding Scheme and Version with the 'CodingScheme' and 'CodingSchemeVersionOrTag' attributes above.

  5. 'ResultPageSize' - the page size of results to return. The higher the number, the more results the system will return to the user at once. The client will request the next group of query results transparenly. This parameter is useful for performance tuning. For example, if a query returns a result of10,000 Objects, a 'ResultPageSize' of '1000' would make 10 calls to the server returning a page of 1000 results each time. If left unset, this value will default to the default set Page Size.

...

Example, Query By Example with No Query Options

Include Page
QueryByExampleWithNoQueryOptions Snippet(Deprecated -- removed in 6.3)
QueryByExampleWithNoQueryOptions Snippet(Deprecated -- removed in 6.3)

Explanation of statements in explains specific statements in the code by line number.

...

Example, Query By Example with Query Options

Include Page
QueryByExampleWithQueryOptions Snippet(Deprecated -- removed in 6.3)
QueryByExampleWithQueryOptions Snippet(Deprecated -- removed in 6.3)

Explanation of statements in explains specific statements in the code by line number.

...

In the ./webServiceSoapClient contains a build.xml file that will construct a LexEVSAPI SOAP client. Before building, you may edit this build.xml file to customize the build process. Editable properties include 'wsdlURL' and 'webServiceNamespace'. An example configuration is below:

Code Block

<property name="wsdlURL" value="http://bmidev4:8180/lexevsapi50/services/lexevsapi50Service?wsdl"/>
<property name="webServiceNamespace" value="http://bmidev4:8180/lexevsapi50/services/lexevsapi50Service"/>

...

The CORE EVS XML-HTTP interface uses the following URL syntax:

Code Block

http://{server}/{servlet}?query={returnClass}&{criteria}
	&startIndex={index}
	&codingSchemeName={codingSchemeName}
	&codingSchemeVersion={codingSchemeVersion}

...

Criteria statements in XML-HTTP queries generally use the following syntax (although you can also build more complex statements):

Code Block

{ClassName}[@{attributeName}={value}] [@{attributeName}={value}]...

ClassName}[@{attributeName}={value}]/

{ClassName}[@{attributeName}={value}]/...

...

Info
titleNote

he servlet name GetXML in each of the examples can be replaced with GetHTML to view with layout and markup in a browser.

Query

Code Block

[http://lexevsapi.nci.nih.gov/lexevsapi50/GetXML?query=Entity[@_entityCode=C1272*]

Semantic Meaning

Find all objects of type Entity that contain an 'entityCode' matching the pattern 'C123*'.

...

The Mayo Clinic wrote the LexEVS 5.0 API. Documentation describing the LexEVS Service Model, available on the LexGRID Vocabulary Services for caBIG® GForge site"

...

archive.

LexEVS Installation and Configuration

...

The following code sample shows use of the DLB API to retrieve the list of available coding schemes in the LexEVS repository.

Include Page

...

Resolve Coding Scheme
Resolve Coding Scheme

Scrollbar
iconsfalse

...