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