 |
Page History
...
- 'CodingScheme' - Restricts the query to the specified Coding Scheme, instead of querying every available Coding Scheme.
- CodingSchemeVersionOrTag' - Restricts the query to the specified Version of the Coding Scheme. Note that:
- This may NOT be specified without also specifying the 'CodingScheme' attribute.
- If left unset, it will default to the version of the Coding Scheme tagged as "PRODUCTION" in the system.
- '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.
- '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 title Note Lazy Loading may only be used in conjunction with specifying a Coding Scheme and Version with the 'CodingScheme' and 'CodingSchemeVersionOrTag' attributes above.
- '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
Examples of Use
*Example 4.1: Query By Example with No Query Options *
| Include Page | ||||
|---|---|---|---|---|
|
...
The following table explains the URL syntax used by the caCORE LexEVS XML-HTTP interface, indicates whether specific elements are required, and gives examples. The following table explains the URL syntax used by the caCORE LexEVS XML-HTTP interface_
Element | Meaning | Required | Example | ||
|---|---|---|---|---|---|
<tt>server</tt> server | Name of the Web server on which the caCORE LexEVS 5.0 Web application is deployed. | Yes <tt>lexevsapi |
| ||
servlet lexevsapi50</tt> <tt>servlet</tt> | URI and name of the servlet that will accept the HTTP GET requests. | Yes |
|
<tt>lexevsapi50/GetXML</tt>
<tt>lexevsapi50/GetHTML</tt> |
| |||||
returnClass <tt>returnClass</tt> | Class name indicating the type of objects that this query should return. | Yes |
| ||
criteria <tt>criteria</tt> | Search request criteria describing the requested objects. | Yes |
| ||
index <tt>index</tt> | Starting index of the result set. | No |
| ||
codingSchemeName <tt>codingSchemeName</tt> | Restrict the query to a specific Coding Scheme Name. | No |
| ||
codingSchemeVersion <tt>codingSchemeVersion</tt> | Restrict the query to a specific Coding Scheme Version. |
No
...
|
...
No |
|
The caCORE LexEVS architecture currently provides two servlets that accept incoming requests:
...
| Code Block |
|---|
{ClassName}[@{attributeName}={value}] [@{attributeName}={value}]...
ClassName}[@{attributeName}={value}]/
{ClassName}[@{attributeName}={value}]/... |
...
Description: | Returns the set of all (or all active) concepts in the specified coding scheme. | ||||||||
|---|---|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification | ||||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.CodedNodeSet.stubs.types.CodedNodeSetReference | ||||||||
Exception: | RemoteException | ||||||||
Implementation Details: | Implementation:
|
...
Description: | Returns an instance of the filter extension registered with the given name. | ||||||
|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification | ||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Filter.stubs.types.FilterReference | ||||||
Exception: | RemoteException | ||||||
Implementation Details: | Implementation:
|
...
Description: | Returns an instance of the sort extension registered with the given name. | ||||||
|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification | ||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort.stubs.types.SortReference | ||||||
Exception: | RemoteException | ||||||
Implementation Details: | Implementation:
|
...
Description: | Return an interface to perform system-wide query over metadata for loaded code systems and providers. | ||||
|---|---|---|---|---|---|
Input: | none | ||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.LexBIGServiceMetadata. | ||||
Exception: | RemoteException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns the node graph as represented in the particular relationship set in the coding scheme. | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification | ||||||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices. | ||||||||||
Exception: | RemoteException | ||||||||||
Implementation Details: | Implementation:
|
...
Description: | Resolve a reference to the history api servicing the given coding scheme. | ||||||
|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification | ||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.HistoryService.stubs.types.HistoryServiceReference | ||||||
Exception: | RemoteException | ||||||
Implementation Details: | Implementation:
|
...
