- General Information
- Connecting Third-party Systems
- crossConnect for content systems
- crossConnect for External Editing
- Purpose and usage
- Across XLIFF format
- Across-specific Extensions
- <xliff> Element Attributes
- <file> Element Extensions
- <trans-unit> Element Extension
- Paragraph States
- Paragraph State Flags
- <source> and <target> Element Content
- <bpt> Element Attributes
- <ph> Element Attributes
- <x> Element Attributes
- Across-specific Properties
- Analysis Results
- Sample Files
- Across XLIFF - import, export and segmentation
- Context information
- Exporting best matches in Across XLIFF
- Hyperlinks to XLIFF
- Secure file handling with C#
- Secure file handling with JAVA
- Workflow and vendor configuration
- Sample code - Integrated solution
- Across XLIFF format
- Generic File Connector
- Display Texts
- Solution approaches
- The Across solution in detail
- The display text format
- The display text package
- APIs - Technology
- crossTank API v1
- crossTank API v2
- crossTerm API v1
- crossTerm API v2
- crossAPI SI
- Function Return Types
- crossAPI SI and Java
- List of Objects in crossAPI SI
- ObjectManager - Overview
- ProjectManager - Overview
- WanGridManager - Overview
- Sample - transferring checkout files via FileManager
- Sample - VBS
- Text Preprocessing API
Example - finding terms
If a term was identified that should be avoided, 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:
To retrieve all terms of the same entry, use:
This way, terms of the same language can be identified that are not discouraged (do not have DoNotUse).
For example, if we found "shoe lace" via search (see below for search), we could retrieve its entry via api/v1/Terms(key)/Entry, and in the example above we would receive ID 1 for this entry. From there on, requesting api/v1/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/v1/Terms(key)/Properties.
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:
Same as before, including properties of the entry and of all terms:
To retrieve all terms of an entry along with their properties:
To search for a set of strings in crossTerm and receive the matching terms (if any are present) from the crossTerm database.
Example: The term "opacity" exists in crossTerm. A request to SearchTerms with the Terms parameter set to 'opacity' returns the term "opacity".
For a technical description, see crossTerm API documentation under Terms/SearchTerms.
To search for a string with a wildcard and receive the matching terms (if any are present) from the crossTerm database.
Example: The terms "opacity" and "opaque" exist in crossTerm. A request to WildcardSearch with the Query parameter set to 'opa*' returns the terms "opacity" and "opaque".
For a technical description, see crossTerm API documentation under Terms/WildcardSearch.
To search terms in a provided text fragment and receive the matching terms (if any are present) from the crossTerm database.
Example: The terms "opacity" and "opaque" exist in crossTerm. A request to SearchTermsInText with the TextFragment parameter set to 'The noun related to opaque is opacity.' returns the terms "opaque" and "opacity" along with their ranges in the submitted string.
For a technical description, see crossTerm API documentation under Terms/SearchTermsInText.
Usage of $expand parameter
Here as well, the $expand parameter may be used to prevent multiple requests. For example, to retrieve source terms with translations via SearchTerms:
And also with WildcardSearch: