Terms API

Dovetail Seeker Terms API searches the index for terms which start with the match text given.

Usages

This API can be used to provide autocomplete for search UI textboxes. Please take a look at the web client example which demonstrates search term auto completion.

Input

URL:

/seeker/terms/find?match={text}&limit={number}

Format:

JSON

HTTP Method(s):

Parameters

Parameter Required Default Description
match Yes N/A The text to search for in the contents field of the index
limit No 10 The number of results to return

Response:

[
  "test",
  "testing",
  "tests",
  "tested",
  "testers",
  "testcase",
  "testbase",
  "testable",
  "tester",
  "testharness"
]
Examples

Request:

GET /seeker/terms/find?match=case&limit=10

Response:

[
  "case",
  "cases",
  "case.actentry",
  "case.case",
  "case.fields",
  "case.noteslog",
  "case.update",
  "case2address",
  "case2status_chg",
  "case_act2act_entry"
]