Finding Terms of Entry

If a term was identified that should be avoided (see also Check Usage Status), it might be interesting to retrieve other terms of the same entry which could be used instead.

Via the term, it is possible to retrieve its entry:

api/v2/Terms(key)/Entry

To retrieve all terms of the same entry, use:

api/v2/Entries(key)/Terms

This way, terms of the same language (LCID) can be identified that are recommended or synonyms (don't have "DoNotUse").

For example, if we found shoe lace via search (see also Search for Term by Text String and Searching Terminology via API), we could retrieve its entry via api/v2/Terms(key)/Entry, and in the example above we would receive ID 1 for this entry. From there on, requesting api/v2/Entries(1)/Terms will return all terms, including shoe lace and shoe string in English and Schnürband and Schnürsenkel in German. Their properties can again be found via api/v2/Terms(key)/Properties.

Tip

Usage of the $expand parameter

Instead of chaining several requests, as in the explanation above, these queries may be abbreviated with the $expand parameter. The following examples illustrate its usage:

To retrieve an entry with all its terms by term id (key) of one of the entry's terms:

GET api/v2/Terms(key)/Entry?$expand=Terms

Same as before, including properties of the entry and of all terms:

GET api/v2/Terms(key)/Entry?$expand=Properties,Terms($expand=Properties)

To retrieve all terms of an entry along with their properties:

GET api/v2/Entries(key)/Terms?$expand=Properties