{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v5.0.0"},"host":"api3.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v5.0.0/search/warehouse/{INDEX}":{"post":{"tags":["Data-Warehouse"],"summary":"Data Warehouse Search","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Search the data warehouse and get row level results.
Authentication is Mandatory
CanSearchWarehouse entitlement is required. You can request the Role below.
Elastic (search) is used in the background. See links below for syntax.
Examples of usage:
POST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE
POST /search/warehouse/INDEX1,INDEX2
POST /search/warehouse/ALL
{ Any valid elasticsearch query DSL in the body }
","operationId":"dataWarehouseSearch","parameters":[{"in":"body","name":"body","description":"ElasticSearchJsonV300 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ElasticSearchJsonV300"}},{"in":"path","name":"INDEX","description":"the elastic search index","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/search/warehouse/statistics/{INDEX}/{FIELD}":{"post":{"tags":["Data-Warehouse"],"summary":"Data Warehouse Statistics","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Search the data warehouse and get statistical aggregations over a warehouse field
Does a stats aggregation over some numeric field:
Authentication is Mandatory
CanSearchWarehouseStats Role is required. You can request this below.
Elastic (search) is used in the background. See links below for syntax.
Examples of usage:
POST /search/warehouse/statistics/INDEX/FIELD
POST /search/warehouse/statistics/ALL/FIELD
{ Any valid elasticsearch query DSL in the body }
","operationId":"dataWarehouseStatistics","parameters":[{"in":"body","name":"body","description":"ElasticSearchJsonV300 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ElasticSearchJsonV300"}},{"in":"path","name":"FIELD","description":"the elastic search field","required":true,"type":"string"},{"in":"path","name":"INDEX","description":"the elastic search index","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ElasticSearchJsonV300":{"required":["query"],"properties":{"query":{"$ref":"#/definitions/ElasticSearchQuery"}}},"EmptyElasticSearch":{"properties":{"none":{"type":"string"}}},"ElasticSearchQuery":{"required":["match_all"],"properties":{"match_all":{"$ref":"#/definitions/EmptyElasticSearch"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}}}}