Endpoints for working with a Db2 Warehouse

The Db2® Warehouse API provides endpoints for working with a Db2 Warehouse.

/db2whrest/v1/search: POST
Searches a database for data.
/db2whrest/v1/report: POST
Creates a curation report definition and runs it immediately.
/db2whrest/v1/report: GET
Gets information on all the curation reports that are available in the system.
/db2whrest/v1/report/<report_id>: GET
Gets information about a single curation report.
/db2whrest/v1/report/<report_id>/download: GET
Downloads the output file of the specified curation report.
/db2whrest/v1/bucket: GET
Gets information on all buckets that are supported.
/db2whrest/v1/buckets/<bucket>: GET
Gets information on a specific bucket that is supported.
/db2whrest/v1/report/<report_id>: PUT
Runs the specified curation report. The old output file is replaced by the new one.
/db2whrest/v1/buckets/<bucket>: PUT
Modifies the bucket details.
/db2whrest/v1/report/<report_id>: DELETE
Deletes the specified curation report definition and its output file.
/db2whrest/v1/sql_query?<sql>: GET
Retrieves data from a database with an SQL query in a GET command. You can use any standard SQL query. You must include the SQL query as a parameter of the URL.
/db2whrest/v1/sql_query: POST
Gets data from a database with an SQL query in a POST command. You can use any standard SQL query. You must include the SQL query in the message body of the POST command.
/db2whrest/v1/sql_query_async?<sql>: GET
Gets data from a database asynchronously with an SQL query in a GET command.
/db2whrest/v1/sql_query_async: POST
Gets data from a database asynchronously with an SQL query in a POST command. You can use any standard SQL query. You must include the SQL query in the message body of the POST command.
/db2whrest/v1/task_status/<task_id>: GET and <task_id>/peek
Gets the status of the specified asynchronous task.
/db2whrest/v1/summary_tables -X GET
Gets information on all the summary tables that are available in the system.
/db2whrest/v1/summary_tables/<table> -X GET
Gets information for a particular summary table available in the system.
/db2whrest/v1/summary_tables/<table> -X PUT
Change the summary table configuration for a particular summary table available in the system.
/db2whrest/v1/summary_tables/<table>/<action> -X PUT
Triggers a start or scheduled start action for a particular summary table.
/db2whrest/v1/bulk_add_tags/docs: POST
Searches a database for data.

Parent topic: REST API for Data Cataloging