CTS2-LE REST API: Concept Search - Versionsgeschichte

Billig: /* POST Body (simple and restricted search) */

2019-12-10T17:10:08Z

‎POST Body (simple and restricted search)

Krebs: /* POST Body (similarity search) */

2017-05-03T11:36:31Z

‎POST Body (similarity search)

Krebs: /* POST Body (simple and restricted search) */

2017-05-03T11:24:39Z

‎POST Body (simple and restricted search)

Krebs: /* Response Structure */

2017-05-02T13:42:08Z

‎Response Structure

Krebs: /* POST Body (similarity search) */

2017-05-02T13:41:30Z

‎POST Body (similarity search)

Krebs am 28. April 2017 um 13:18 Uhr

2017-04-28T13:18:36Z

Krebs: Die Seite wurde neu angelegt: „CTS2-LE offers different search functionalities for retrieving concepts. === Operation === * '''Path:''' /WebCts2LE/service/crud/cts2/search * '''Method:'''…“

2017-04-28T13:03:42Z

Die Seite wurde neu angelegt: „CTS2-LE offers different search functionalities for retrieving concepts. === Operation === * '''Path:''' /WebCts2LE/service/crud/cts2/search * '''Method:'''…“

Neue Seite

CTS2-LE offers different search functionalities for retrieving concepts.

=== Operation ===
* '''Path:''' /WebCts2LE/service/crud/cts2/search
* '''Method:''' POST
* '''Path Parameters:''' -
* '''Query Parameters:'''
** ''withCSUriAndVersionId'': boolean value to indicate whether results shall include versionOf- and versionId-attributes
* '''returns: ''' search results in JSON format

=== POST Body ===
<pre>
{
"searchExpression":[string],
"grouped":[boolean],
"positiveRestriction":[boolean],
"groups":[
{"groupName":[string]}
],
"csvs":[
{"resourceID":[string]}
]
}
</pre>
Meaning of the comprised attributes:
* '''searchExpression''': search term
:is the only mandatory attribute. When the JSON object contained in the POST body only has this attribute, a basic search (non-grouped) across all terminologies is performed.
* '''grouped''': whether results shall be grouped by codesystem or not (optional, default: false)
* '''positiveRestriction''': whether results shall be restricted to the codesystem versions referenced in groups and csvs (true) or whether only results that do not belong to the referenced codesystems shall be retrieved (optional, default: false)
* '''groups''': group name of the restricted codesystem versions further referenced in "csvs" (optional)
* '''csvs''': resourceIDs of restricted codesystem versions (optional)

===== Response Structure =====

<pre>
{
"complete": [boolean],
"numberOfHits": [number],
"circaHits": [number],
"elapsedTime": [number],
"results": [
{
"preferredTerm":[string],
"name":[string],
"displayedCode:[string],
"resourceID":[string],
"hasParent":[boolean],
"hasChildren":[boolean],
"versionOf":[string],
"versionId":[string]
}
]
}
</pre>
Meaning of the comprised attributes:
* '''complete''': true if all results are contained in response, false if not
* '''numberOfHits''': number of results contained in response
* '''circaHits''': number of all results
* '''elapsedTime''': the time it took to perform the search operation
* '''results.preferredTerm''': the preferred term of the concept
* '''results.name''': the name/code of the concept
* '''results.displayedCode''': the name/code that shall be presented
* '''results.resourceID''': the resourceID of the codesystem version the concept belongs to
* '''results.hasParent''': indicates whether the concept has parents
* '''results.hasChildren''': indicates whether the concept has children
* '''results.versionOf''': the versionOf of the codesystem version the concept belongs to - only present if query parameter 'withCSUriAndVersionId' is true (optional)
* '''results.versionId''': the versionId of the codesystem version the concept belongs to - only present if query parameter 'withCSUriAndVersionId' is true (optional)

@@ Zeile 37: / Zeile 37: @@
          "resourceID":[string],
          "groupSize":[number],
-	"groups":[
+	"groups":[ [string] ],
-			{"groupName":[string]}
+	"csvs":[ [string] ]
+}
 </pre>
@@ Zeile 50: / Zeile 46: @@
 * '''resourceID''': is the resourceID of the codesystem version the concept (referenced in searchExpression) belongs to
 * '''groupSize''': determines the maximum number of concepts that will be retrieved from a code system; please note that results from similar search are inherently grouped (optional, default: 3)
-* '''groups.groupName''': group name of the restricted codesystem versions further referenced in "csvs" (optional)
+* '''groups''': group names of the restricted codesystem versions further referenced in "csvs" (optional)
-* '''csvs.resourceID''': resourceID of restricted codesystem version (optional)
+* '''csvs''': resourceIDs of restricted codesystem version (optional)
 === Response Structure ===

@@ Zeile 15: / Zeile 15: @@
 	"grouped":[boolean],
 	"positiveRestriction":[boolean],
-	"groups":[
+	"groups":[ [string] ],
-			{"groupName":[string]}
+	"csvs":[ [string] ]
+}
 </pre>
@@ Zeile 28: / Zeile 24: @@
 * '''grouped''': whether results shall be grouped by codesystem or not (optional, default: false)
 * '''positiveRestriction''': whether results shall be restricted to the codesystem versions referenced in groups and csvs (true) or whether only results that do not belong to the referenced codesystems shall be retrieved (false) (optional, default: false)
-* '''groups.groupName''': group name of the restricted codesystem versions further referenced in "csvs" (optional)
+* '''groups''': group names of the restricted codesystem versions further referenced in "csvs" (optional)
-* '''csvs.resourceID''': resourceIDs of restricted codesystem version (optional)
+* '''csvs''': resourceIDs of restricted codesystem version (optional)
 The same call can be used to retrieve similar search results. The request body is slightly different.
 === POST Body (similarity search) ===
 <pre>

@@ Zeile 52: / Zeile 52: @@
 * '''similarConcepts''': set to true for similarity search
 * '''resourceID''': is the resourceID of the codesystem version the concept (referenced in searchExpression) belongs to
-* '''groupSize''': (optional, default: 3)
+* '''groupSize''': determines the maximum number of concepts that will be retrieved from a code system; please note that results from similar search are inherently grouped (optional, default: 3)
 * '''groups.groupName''': group name of the restricted codesystem versions further referenced in "csvs" (optional)
 * '''csvs.resourceID''': resourceID of restricted codesystem version (optional)
 === Response Structure ===

@@ Zeile 20: / Zeile 20: @@
 </pre>
 Meaning of the comprised attributes:
-* '''searchExpression''': search term
+* '''searchExpression''': search expression (lucene subset)
 * '''grouped''': whether results shall be grouped by codesystem or not (optional, default: false)
 * '''positiveRestriction''': whether results shall be restricted to the codesystem versions referenced in groups and csvs (true) or whether only results that do not belong to the referenced codesystems shall be retrieved (false) (optional, default: false)

@@ Zeile 80: / Zeile 80: @@
 * '''complete''': true if all results are contained in response, false if not
 * '''numberOfHits''': number of results contained in response
-* '''circaHits''': number of all results
+* '''circaHits''': estimated number of all results
 * '''elapsedTime''': the time it took to perform the search operation
 * '''results.preferredTerm''': the preferred term of the concept

@@ Zeile 9: / Zeile 9: @@
 * '''returns: ''' search results in JSON format
-=== POST Body ===
+=== POST Body (simple and restricted search) ===
 <pre>
+{
@@ Zeile 27: / Zeile 27: @@
 :is the only mandatory attribute. When the JSON object contained in the POST body only has this attribute, a basic search (non-grouped) across all terminologies is performed.
 * '''grouped''': whether results shall be grouped by codesystem or not (optional, default: false)
-* '''positiveRestriction''': whether results shall be restricted to the codesystem versions referenced in groups and csvs (true) or whether only results that do not belong to the referenced codesystems shall be retrieved (optional, default: false)
+* '''positiveRestriction''': whether results shall be restricted to the codesystem versions referenced in groups and csvs (true) or whether only results that do not belong to the referenced codesystems shall be retrieved (false) (optional, default: false)
-* '''groups''': group name of the restricted codesystem versions further referenced in "csvs" (optional)
+* '''groups.groupName''': group name of the restricted codesystem versions further referenced in "csvs" (optional)
-* '''csvs''': resourceIDs of restricted codesystem versions (optional)
+* '''csvs.resourceID''': resourceIDs of restricted codesystem version (optional)
 <pre>
+{
@@ Zeile 66: / Zeile 92: @@
 * '''results.versionOf''': the versionOf of the codesystem version the concept belongs to - only present if query parameter 'withCSUriAndVersionId' is true (optional)
 * '''results.versionId''': the versionId of the codesystem version the concept belongs to - only present if query parameter 'withCSUriAndVersionId' is true (optional)