Find Terms Starting With

openthesaurus.starts_with_terms
ActionBusiness appsconnection required

Calls the OpenThesaurus API with the connection's credentials.

Find German words that begin with a term, for autocomplete.

Connection

Required
Yes — the node will not save without one
Auth type
No auth
Providers
OpenThesaurus
Secret shape
no credential — OpenThesaurus' API is public; the connection is a contact and a host
Config it needs
contact, base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
term
The German word to look up, as a single term rather than a sentence.
stringYes——Test
offset
Skip this many matches before the page starts, for reading past the first page.
numberNo0≥ 0—
max_results
How many matches to return in one page. OpenThesaurus caps this at 250.
numberNo101–250—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "max_results": 10,
  "offset": 0,
  "term": "Test"
}

Output

One shape.

result

FieldTypeExample
term
The term that was looked up.
string—
found
False when OpenThesaurus knows no word starting with the term; branch on this.
boolean—
matches
The word starting with the term, as a flat list of German words.
array—
count
How many matches this page holds.
number—
offset
The offset this page started at.
number—
max_results
The page size that was asked for.
number—
meta.api_version
The API version OpenThesaurus reported.
string—
meta.source
The service the entries came from.
string—
meta.license
The licence the returned entries are published under.
string—
meta.date
When OpenThesaurus generated the response.
string—
{
  "count": 0,
  "found": false,
  "matches": [],
  "max_results": 0,
  "meta": {
    "api_version": "",
    "date": "",
    "license": "",
    "source": ""
  },
  "offset": 0,
  "term": ""
}

Notes

  • OpenThesaurus is a German thesaurus; the term and every result are German.
  • OpenThesaurus' API is public: the connection carries no credential and nothing is sent as authentication. It carries the contact address OpenThesaurus requires in the User-Agent header of every request.
  • OpenThesaurus allows 60 requests per minute from one IP address and answers with an error beyond that; nothing here retries, so pace a loop that looks up many words.

See Find Terms Starting With run in a workflow.

In a technical demo we add the OpenThesaurus connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.