right logo image
right logo image
Log on
⯆

API Explorer

Log off

v2.2.0 (220 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Search Warehouse Data Via Elasticsearch

Search warehouse data via Elastic Search.

Login is required.

CanSearchWarehouse entitlement is required to search warehouse data!

Send your email, name, project name and user_id to the admins to get access.

Elastic (search) is used in the background. See links below for syntax.

parameters:

esType - elasticsearch type

simple query:

q - plain_text_query

df - default field to search

sort - field to sort on

size - number of hits returned, default 10

from - show hits starting from

json query:

source - JSON_query_(URL-escaped)

Example usage:

GET /search/warehouse/q=findThis

or:

GET /search/warehouse/source={"query":{"query_string":{"query":"findThis"}}}

Note!!

The whole JSON query string MUST be URL-encoded:

  • For { use %7B
  • For } use %7D
  • For : use %3A
  • For " use %22

etc..

Only q, source and esType are passed to Elastic

Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html

Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html

You can specify the esType thus: /search/warehouse/esType=type&q=a

Authentication is Mandatory

JSON response body fields:

Typical Successful Response: 

								
									
{
  "jsonString":"{}"
}
Required Roles:
  • CanSearchWarehouse - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by elasticSearchWarehouse, operation_id: OBPv2.0.0-elasticSearchWarehouse Tags: Data-Warehouse,