Searching Terminology via API

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

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 application exists in crossTerm. A request to Across.Services.CrossTerm.Api.V2.SearchTerms with the TermNames parameter set to application returns the term application.

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 Across.Services.CrossTerm.Api.V2.WildcardSearch with the Query parameter set to opa* returns the terms opacity and opaque.

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 Across.Services.CrossTerm.Api.V2.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.

Usage of $expand Parameter

The $expand parameter may be used to prevent multiple requests. For example, to retrieve source terms with translations via Across.Services.CrossTerm.Api.V2.SearchTerms:

POST api/v2/Across.Services.CrossTerm.Api.V2.SearchTerms?$expand=FoundTerms($expand=Entry)