...
Code Block | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <methodResponse> <params> <param><value><array><data><value> <struct> <member><name>__objtype</name><value>IndexTerm</value></member> <member><name>term</name><value>poisson</value></member> <member><name>conceptEntryID</name><value>436</value></member> <member><name>termEntryID</name><value>440</value></member> </struct> </value></data></array></value></param> </params> </methodResponse> |
Getting concept and term entries
For retrieving concepts and terms the following custom methods exist:
Method | Returns | Return type | Description |
---|---|---|---|
getConceptEntry(sessionID, objID) | A concept entry | struct | Returns the concept entry with specified oid from current dictionary. Same as generic method call getObject(sessionID, 'conceptentry', objID) |
getConceptEntryByCID(sessionID, conceptID) | A concept entry | struct | Returns the concept entry with specified concept ID from current dictionary. |
getTermEntry(sessionID, objID) | A term entry | struct | Returns the term entry with specified oid from current dictionary. Same as generic method call getObject(sessionID, 'termentry', objID) |
getTermEntryByTID(sessionID, termID) | A term entry | struct | Returns the term entry with specified term ID from current dictionary. |
getTermEntries(sessionID, searchCondition, targetLang) | List of term entries | array | Returns the matching term entries for the specified search condition and translated into the specified target language. |
Filters
For more advanced search functionality you can use search filters. With the generic methods getAll
, getObject
, getObjectByName
, getSelected
and setSelected
you can retrieve existing filters and set a filter to be applied when searching.
Creating and updating filters
To create a new filter for search, you construct a data object for filter, including the filter criteria for the fields you wish to include, and then call the create
method. No value is needed for id
fields in Filter
or FilterCriteria
.
To update, you modify the filter criteria in an existing method, and then call the update
method.
Info |
---|
To find the IDs for dictionary and fields to include in the data objects you retrieve the |
Remember to call setSelected
to apply the new or updated filter.