{"resource_docs":[{"operation_id":"OBPv3.0.0-dataWarehouseSearch","implemented_by":{"version":"OBPv3.0.0","function":"dataWarehouseSearch"},"request_verb":"POST","request_url":"/obp/v3.0.0/search/warehouse/INDEX","summary":"Data Warehouse Search","description":"
Search the data warehouse and get row level results.
\nAuthentication is Mandatory
\nCanSearchWarehouse entitlement is required. You can request the Role below.
\nElastic (search) is used in the background. See links below for syntax.
\nExamples of usage:
\nPOST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE
\nPOST /search/warehouse/INDEX1,INDEX2
\nPOST /search/warehouse/ALL
\n{ Any valid elasticsearch query DSL in the body }
\n\n\n\nURL Parameters:
\n\nJSON request body fields:
\n\n\nnone:
\nJSON response body fields:
\n","description_markdown":"Search the data warehouse and get row level results.\n\nAuthentication is Mandatory\n\nCanSearchWarehouse entitlement is required. You can request the Role below.\n\nElastic (search) is used in the background. See links below for syntax.\n\nExamples of usage:\n\n\nPOST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE\n\nPOST /search/warehouse/INDEX1,INDEX2\n\nPOST /search/warehouse/ALL\n\n{ Any valid elasticsearch query DSL in the body }\n\n\n[Elasticsearch query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\n\n[Elastic simple query](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-body.html)\n\n[Elastic aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations.html)\n\n\n**URL Parameters:**\n\n[INDEX](/glossary#index): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**match_all**](/glossary#match_all): \n\n\n\n[**query**](/glossary#query): \n\n\n\n[none](/glossary#none): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"query":{"match_all":{}}},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Data-Warehouse"],"typed_request_body":{"type":"object","properties":{"query":{"type":"object","properties":{"match_all":{"type":"object","properties":{}}}}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanSearchWarehouse","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/search/warehouse/INDEX","connector_methods":[]},{"operation_id":"OBPv3.0.0-dataWarehouseStatistics","implemented_by":{"version":"OBPv3.0.0","function":"dataWarehouseStatistics"},"request_verb":"POST","request_url":"/obp/v3.0.0/search/warehouse/statistics/INDEX/FIELD","summary":"Data Warehouse Statistics","description":"Search the data warehouse and get statistical aggregations over a warehouse field
\nDoes a stats aggregation over some numeric field:
\n\nAuthentication is Mandatory
\nCanSearchWarehouseStats Role is required. You can request this below.
\nElastic (search) is used in the background. See links below for syntax.
\nExamples of usage:
\nPOST /search/warehouse/statistics/INDEX/FIELD
\nPOST /search/warehouse/statistics/ALL/FIELD
\n{ Any valid elasticsearch query DSL in the body }
\n\n\n\nURL Parameters:
\n\n\nJSON request body fields:
\n\n\nnone:
\nJSON response body fields:
\n","description_markdown":"Search the data warehouse and get statistical aggregations over a warehouse field\n\nDoes a stats aggregation over some numeric field:\n\nhttps://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html\n\nAuthentication is Mandatory\n\nCanSearchWarehouseStats Role is required. You can request this below.\n\nElastic (search) is used in the background. See links below for syntax.\n\nExamples of usage:\n\nPOST /search/warehouse/statistics/INDEX/FIELD\n\nPOST /search/warehouse/statistics/ALL/FIELD\n\n{ Any valid elasticsearch query DSL in the body }\n\n\n[Elasticsearch query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\n\n[Elastic simple query](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-body.html)\n\n[Elastic aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations.html)\n\n\n**URL Parameters:**\n\n[FIELD](/glossary#field): \n\n\n\n[INDEX](/glossary#index): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**match_all**](/glossary#match_all): \n\n\n\n[**query**](/glossary#query): \n\n\n\n[none](/glossary#none): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"query":{"match_all":{}}},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Data-Warehouse"],"typed_request_body":{"type":"object","properties":{"query":{"type":"object","properties":{"match_all":{"type":"object","properties":{}}}}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanSearchWarehouseStatistics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/search/warehouse/statistics/INDEX/FIELD","connector_methods":[]}]}