The endpoint that is responsible for decorating a segment (translating a segment) in TermWeb Web Services is the Stemmer Endpoint. You can use two methods in order to get a response, segmentSearch and segmentSearchTemplate. The first one returns a translation by using default configuration and by searching in the user's currently or lastly viewed dictionary. The second one returns a translation by using configuration from a specific template defined in TermWeb.
Until TermWeb version 3.17.8 not all concept/term fields are included in the decoration, but specifically the following:
...
Source Term Id
...
Source Concept Id
...
Source Term (name)
...
Target Term Id
...
Target Concept Id
...
Target Term (name)
...
Modified By
...
Modified Date
...
Client Name
...
Domain Name
...
Term Definition
...
Term Usage Status
...
Term Process Status
...
Term Context
...
Since TermWeb version 3.17.8 all concept and term fields are included in the decoration.
Segment Decoration Details
...
| Code Block | ||
|---|---|---|
| ||
api.search.limit=<limit> |
Note
Until TermWeb version 3.17.8 not all concept/term fields are included in the decoration, but specifically the following:
| Source | Field | Returns As | Comments | Date Implemented |
|---|---|---|---|---|
| Source Term | Source Term Id | sourceTermId | Initial version | |
| Source Term | Source Concept Id | sourceConceptId | Initial version | |
| Source Term | Source Term (name) | sourceTerm | Initial version | |
| Target Term | Target Term Id | id | Initial version | |
| Target Term | Target Concept Id | conceptId | It should be the same as Source Concept Id | Initial version |
| Target Term | Target Term (name) | tgt | Initial version | |
| Target Term | Modified By | modifiedBy | Initial version | |
| Target Term | Modified Date | modifiedDate | Initial version | |
| Target Term | Client Name | customer | Initial version | |
| Target Term | Domain Name | domain | Initial version | |
| Target Term | Term Definition | definition | Initial version | |
| Target Term | Term Usage Status | status | Initial version | |
| Target Term | Term Process Status | processStatus | Initial version | |
| Target Term | Term Context | context | Initial version | |
| Target Term | Term Reference | reference | Initial version | |
| Target Term | Term Remarks | remarks | Initial version | |
| Target Term | Indication whether Term is an abbreviation | abbreviation | Initial version | |
| Target Term | Indication whether Term is deprecated | deprecated | According to TBX standards and custom template configuration of deprecated field/value | 20-10-2016 (3.17.3) |
| Target Term | Indication whether Term is accepted | accepted | According to custom template configuration of accepted field/value | 15-2-2017 (3.17.4) |