CTS2-LE REST API: Concept Suggestion

Aus CTS2-LE
Version vom 3. Mai 2017, 15:04 Uhr von Krebs (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „CTS2-LE offers functionality for retrieving concept suggestions. === Operation === * '''Path:''' /WebCts2LE/rest/lucene/suggest * '''Method:''' POST * '''Path…“)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

CTS2-LE offers functionality for retrieving concept suggestions.

Operation

  • Path: /WebCts2LE/rest/lucene/suggest
  • Method: POST
  • Path Parameters: -
  • Query Parameters:
  • returns: suggested concepts in JSON format

POST Body

{
	"term": [string],
	"positiveRestriction": [boolean],
	"csvs": [ [string] ]	
}

Meaning of the comprised attributes:

  • term: a term or some letters that serve as input for the suggestion
  • positiveRestriction: whether results shall be restricted to the codesystem versions referenced in terminologyRestriction (true) or whether only results that do not belong to the referenced codesystems shall be retrieved (false) (optional, default: false)
  • csvs: resourceIDs of restricted codesystem version (optional)