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.
Not all concept/term fields are included in the decoration, but specifically the following:
| Field | Returns As | Comments |
|---|---|---|
Source Term Id | sourceTermId | |
Source Concept Id | sourceConceptId | |
Source Term (name) | sourceTerm | |
Target Term Id | id | |
Target Concept Id | conceptId | It should be the same as Source Term Id |
Target Term (name) | tgt | |
Modified By | modifiedBy | |
Modified Date | modifiedDate | |
Client Name | customer | |
Domain Name | domain | |
Term Definition | definition | |
Term Usage Status | status | |
Term Process Status | processStatus | |
Term Context | context | |
| Term Reference | reference | |
| Term Remarks | remarks | |
| Indication whether Term is an abbreviation | abbreviation | |
| Indication whether Term is deprecated | deprecated | According to TBX standards and custom template configuration of deprecated field/value |