Introduction

This plugin offers new Endpoints to support formatting the REST search responses.

Getting Started

This plugin provide the request format as belows:

1. Array format endpoints:

GET /_search_array

POST /_search_array

GET /{index}/_search_array

POST /{index}/_search_array

GET /{index}/{type}/_search_array

POST /{index}/{type}/_search_array

2. Fhir Bundle format endpoints:

GET /_search_fhir_bundle

POST /_search_fhir_bundle

GET /{index}/_search_fhir_bundle

POST /{index}/_search_fhir_bundle

GET /{index}/{type}/_search_fhir_bundle

POST /{index}/{type}/_search_fhir_bundle

Build and Test

1. Software dependencies

   1. JAVA (jdk-17.0.1)

   2. Maven

   3. Elasticsearch (8.8.1)

      Download: https://www.elastic.co/downloads/past-releases/elasticsearch-8-8-1

2. Installation process

   1. Build the compiled version of the Elasticsearch-plugin code, and to create a compiled version of it, run the following command:

      $ mvn clean install

   2. Install the Elasticsearch-plugin

      Make the Elasticsearch (1.iii) directory your current working directory and run the following command:

      $ ./cd bin

      $ ./elasticsearch-plugin install file:/{path_to_project}/target/releases/rs-result-formatting-plugin-2.0-SNAPSHOT.zip

   3. To check that the plugin is installed correctly in the elasticsearch, run the following command:

      $ ./elasticsearch-plugin list

3. Run ElasticSearch

   $ elasticsearch

   Note: ES 8.1.0 set enable security as default, if you want to test on your local, you may want to disable security follow steps as below:

   • Open ./config/elasticsearch.yml file
   • Update setting:
     • xpack.security.enabled: false
     • xpack.security.enrollment.enabled: false

4. Test the plugin

   To check that the plugin is working the way you want, run the Elasticsearch in your machine and run the following URL in the browser or Postman:

   1. Array format

      GET http://localhost:9200/_search_array

      The response should be:

      [ {
      "study": "test study A",
      "StudyUID": "1.2.4.5.5252",
      "age": "12"
      }, {
      "study": "test study B",
      "StudyUID": "1.2.4.5.212",
      "age": "12"
      }, {
      "study": "test study C",
      "StudyUID": "1.2.4.5.23512.23.125.125",
      "age": "35"
      } ]

   2. Fhir bundle format

      GET http://localhost:9200/_search_fhir_bundle

      The response should be:

      {
      "resourceType": "Bundle",
      "type": "searchset",
      "total": 5,
      "entry": [{...}, {...}]
      }

Reference

The original version of this plugin can be reached at: https://github.com/jprante/elasticsearch-arrayformat