The Search API

The Search API returns a list of entity tables and searches in the system. If id is specified in the request, the response is a list that contains a single search object.

Endpoint ⇒ GET /api/generate-query/search

Query Parameters

Parameter Type Required Description

id

String

false

fetches the search that has the specified ID

Fields in a search object

Field Type Description

type

String

id

String

search id

index

Array

list that contains real index names

title

String

search title

description

String

search description

columns

Array

list of columns that are associated with the search

queries

Array

list that contains queries, which is used to build the final query

filters

Array

list that contains filter objects

query

Object

final query

Sample response

[{
        "type": "search",
        "id": "search:id",
        "index": [
            "company"
        ],
        "title": "Search title",
        "description": "",
        "columns": [
            "_source"
        ],
        "queries": [
            {
                "query_string": {
                    "analyze_wildcard": true,
                    "query": "_exists_:date"
                }
            }
        ],
        "filters": [],
        "query": {
            "bool": {
                "must": [
                    {
                        "query_string": {
                            "analyze_wildcard": true,
                            "query": "_exists_:date"
                        }
                    }
                ],
                "must_not": []
            }
        }
    }]