• Show convenient version of this site
  • Deutsch
  • English
Contact
Newsletter
  • Products
    • ALS
      • Across Language Server
        • Translation Management
        • Terminology Management
        • Translation Memory
      • Editions
      • Interfaces
    • ATE
      • Across Translator Edition
      • Editions
      • Download
      • Across Account
    • Elanion
      • Overview
      • Login
  • Solutions
    • Customers
      • Enterprises
      • Language Service Providers
      • Translators
    • Industries
      • E-Commerce & Trade
      • Pharmaceuticals & medicine
      • IT & Software
    • Departments
      • Marketing & E-Commerce
      • Technical Documentation
      • Software User Interfaces
  • Services
    • Hosting
    • Training
    • Consulting
  • Partners
    • Language Service Providers
    • Universities
  • Company
    • Across Systems
    • News
    • Events
    • Career
    • Contact
  • Knowledge
    • Blog
    • Video Library
    • Case Studies
    • White Papers
    • Fact Sheets
    • File Formats
    • Expert Features
  • Support
    • New Functions
    • Online Help
    • FAQ
    • Support Request
    • Updates
Schedule Consultation
  • Online-Help
  • SDK
  • APIs
  • crossTerm API v1
  • Scenarios of use
  • Example - finding terms
  • General Information
    • Connectors
    • LCIDs
    • GUIDs
    • Paragraph states and flags
    • crossTerm Web
    • crossTransform
      • crossTransform - examples
  • Connecting Third-party Systems
    • crossConnect for content systems
      • Requirements
      • Configuration
        • Configuring the connector
        • Job configuration
        • Testing crossConnect
      • Troubleshooting
    • crossConnect for External Editing
      • Purpose and usage
        • Use case - Machine translation
        • Use Case - Review and QA
        • Use case - Machine review
      • Requirements
      • Implementation
        • 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
          • Adding workflows to crossAutomate Host Manager
          • Adjusting preset watchfolders
          • The filter rules
          • External editing workflows
        • Sample code - Integrated solution
    • Generic File Connector
      • Process Overview
      • Exchange Folder Structure
      • Package Format
        • Control File
  • Display Texts
    • Solution approaches
    • The Across solution in detail
    • Requirements
    • Integration
    • The display text format
      • Line height vs. line spacing
      • DT-XML format structure
        • DT-XML - Main elements
        • Children of paragraphStyles and characterStyles
        • Children of the sizeInfos element
        • Children of the paragraph element
        • DT-XML v5 example
        • DT-XML v4 example
    • The display text package
      • Creating a display text package
  • APIs
    • APIs - Technology
    • crossTank API v1
      • Requirements
      • Testing the crossTank API installation
      • OData-URLs in Chrome
      • Example
    • crossTank API v2
      • Requirements
      • QuickStart
        • Searching for Translations
        • Creating Translations
      • crossTank API v2 Overview
        • Finding Translations
        • Creating Translations
        • Translation Properties
        • Formatting and Auto-Adjustment of Formatting and Numbers
      • C# Example
    • crossTerm API v1
      • Scenarios of use
        • Example - usage information
        • Example - finding terms
      • Requirements
      • Special Controllers
      • OData-URLs in Chrome
      • crossTerm API with C#
      • crossTerm API with Java
      • crossTerm API with JavaScript
    • crossTerm API v2
      • Requirements
      • QuickStart
        • Authentication Basics
        • First Request Examples
      • crossTerm API v2 Example in C#
        • Used Functions
      • crossTank API, crossTerm API v2 - Authentication
      • crossTerm API v2 - Examples of Use
        • Finding Terms of Entry
        • Searching Terminology via API
    • crossAPI SI
      • Requirements
      • Function Return Types
      • crossAPI SI and Java
        • Example: hot integration
        • Executing the hot integration example
      • List of Objects in crossAPI SI
        • AssignManager
        • Authorization
        • CheckInManager
        • CheckOutManager
        • CrossTankManager
        • CrossTermManager
        • DocumentManager
        • FileManager
        • LanguageJobManager
        • LanguageManager
        • LicenseManager
        • Message
        • ObjectManager - Overview
          • Part 1
          • Part 2
          • Part 3
        • ReportManager
          • ID values for analysis and analysis-result
        • ProjectManager - Overview
          • Part 1
          • Part 2
          • Attribute Information
        • SqlQuery
        • SystemManager
        • TaskManager
        • WanGridManager - Overview
          • Part 1
          • Part 2
      • Sample - transferring checkout files via FileManager
      • Sample - VBS
    • Text Preprocessing API
      • Introduction
      • How to browse the API
      • Sentence splitting
      • Abbreviations

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:

api/v1/Terms(key)/Entry

To retrieve all terms of the same entry, use:

api/v1/Entries(key)/Terms

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:

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

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

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

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

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

Search functions

In general, the crossTerm API is geared towards search scenarios, as opposed to browsing its contents. It offers the following convenient search functions (POST operations).

Attention

The search is executed in local instances only.

SearchTerms

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.

WildcardSearch

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.

SearchTermsInText

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:

POST api/v1/SearchTerms?$expand=Results/Entry/Terms

And also with WildcardSearch:

POST api/v1/Terms/WildcardSearch?$expand=Entry/Terms
Register for our Newsletter now

Our newsletter provides you with exclusive news about the Across Language Server, often even before the official announcement. The newsletter also provides you with early information on events, webinars, and training sessions.

  • Legal Notice
  • GTC
  • Privacy Statement
  • Cookies
  • info@across.net