REST API for Oracle Query Service

Pre-General Availability: 2022-08-18. This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

All REST Endpoints

Manage Object Selections

Manage object selections APIs for Oracle Query Service

Get Object Schema: Method: post
Path: /20210831/projects/{projectId}/n/{namespace}/b/{bucketName}/o/{objectName}/actions/getObjectSchema
Get schema for a set of schema-equivalent objects.: Method: post
Path: /20210831/projects/{projectId}/n/{namespace}/b/{bucketName}/actions/getBucketSchema
Preview object data: Method: post
Path: /20210831/projects/{projectId}/n/{namespace}/b/{bucketName}/o/{objectName}/actions/previewObject

Manage Projects

Manage projects APIs for Oracle Query Service

Creates a new Project resource: Method: post
Path: /20211130/projects
Creates and downloads a new database wallet: Method: post
Path: /20211130/projects/{projectId}/actions/downloadAutonomousDatabaseWallet
Delete a Project resource: Method: delete
Path: /20211130/projects/{projectId}
Get Project: Method: get
Path: /20211130/projects/{projectId}
Gets a list of all Query Projects in a compartment: Method: get
Path: /20211130/projects
Moves a Project resource into a different compartment.: Method: post
Path: /20211130/projects/{projectId}/actions/changeCompartment
Set password for user schema.: Method: post
Path: /20211130/projects/{projectId}/actions/setProjectDatabaseUserPassword
Update the Project resource identified by the id: Method: put
Path: /20211130/projects/{projectId}

Manage Queries

Manage queries APIs for Oracle Query Service.

Cancel query execution: Method: post
Path: /20210831/projects/{projectId}/queryExecutions/{queryExecutionId}/actions/cancel
Clear query execution results: Method: post
Path: /20210831/projects/{projectId}/queryExecutions/{queryExecutionId}/actions/clearResults
Get query execution: Method: get
Path: /20210831/projects/{projectId}/queryExecutions/{queryExecutionId}
Get query execution report: Method: get
Path: /20210831/projects/{projectId}/queryExecutions/{queryExecutionId}/executionReport
Get query execution result: Method: get
Path: /20210831/projects/{projectId}/queryExecutions/{queryExecutionId}/result
List of Query Execution summary objects: Method: get
Path: /20210831/projects/{projectId}/queryExecutions
Lists query execution errors: Method: get
Path: /20210831/projects/{projectId}/queryExecutions/{queryExecutionId}/errors
Lists query execution logs: Method: get
Path: /20210831/projects/{projectId}/queryExecutions/{queryExecutionId}/logs
Submit asynchronous query: Method: post
Path: /20210831/projects/{projectId}/queryExecutions
Update query execution: Method: put
Path: /20210831/projects/{projectId}/queryExecutions/{queryExecutionId}

Manage Tables and Schemas

Manage tables and schemas APIs for Oracle Query Service.

Creates a new Table resource: Method: post
Path: /20211130/projects/{projectId}/schemas/{schemaId}/tables
Delete a Table resource: Method: delete
Path: /20211130/projects/{projectId}/schemas/{schemaId}/tables/{tableId}
Get Schema: Method: get
Path: /20211130/projects/{projectId}/schemas/{schemaId}
Get Table: Method: get
Path: /20211130/projects/{projectId}/schemas/{schemaId}/tables/{tableId}
Gets a list of all SchemaSummary objects for a given Schema in a Project resource: Method: get
Path: /20211130/projects/{projectId}/schemas
Gets a list of all TableSummary objects for a given Schema in a Project resource: Method: get
Path: /20211130/projects/{projectId}/schemas/{schemaId}/tables
Update the Table resource identified by the id: Method: put
Path: /20211130/projects/{projectId}/schemas/{schemaId}/tables/{tableId}

Manage Work Requests

Manage work requests APIs for Oracle Query Service.

Cancel the work request: Method: delete
Path: /20211130/workRequests/{workRequestId}
GET Work Request Status: Method: get
Path: /20211130/workRequests/{workRequestId}
List Work Requests: Method: get
Path: /20211130/workRequests
Lists work request errors: Method: get
Path: /20211130/workRequests/{workRequestId}/errors
Lists work request logs: Method: get
Path: /20211130/workRequests/{workRequestId}/logs

Manage Worksheets

Manage worksheets APIs for Oracle Query Service.

Creates a new Worksheet resource: Method: post
Path: /20211130/projects/{projectId}/worksheets
Delete a Worksheet resource: Method: delete
Path: /20211130/projects/{projectId}/worksheets/{worksheetId}
Get Worksheet by identifier: Method: get
Path: /20211130/projects/{projectId}/worksheets/{worksheetId}
Gets a list of all WorksheetSummary objects in a Project resource: Method: get
Path: /20211130/projects/{projectId}/worksheets
Update the Worksheet resource identified by the id: Method: put
Path: /20211130/projects/{projectId}/worksheets/{worksheetId}