Get the current available versions for the Rest Endpoint. The client can choose one of the return version as the protocol for later communicate.
/info
Verb: GET
Response code: 200 OK
Get meta data for this cluster.
/sessions
Verb: POST
Response code: 200 OK
Opens a new session with specific properties. Specific properties can be given for current session which will override the default properties of gateway.
/sessions/:session_handle
Verb: DELETE
Response code: 200 OK
Closes the specific session.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle
Verb: GET
Response code: 200 OK
Get the session configuration.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle/complete-statement
Verb: GET
Response code: 200 OK
Get the completion hints for the given statement at the given position.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle/configure-session
Verb: POST
Response code: 200 OK
Configures the session with the statement which could be: CREATE TABLE, DROP TABLE, ALTER TABLE, CREATE DATABASE, DROP DATABASE, ALTER DATABASE, CREATE FUNCTION, DROP FUNCTION, ALTER FUNCTION, CREATE CATALOG, DROP CATALOG, USE CATALOG, USE [CATALOG.]DATABASE, CREATE VIEW, DROP VIEW, LOAD MODULE, UNLOAD MODULE, USE MODULE, ADD JAR.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle/heartbeat
Verb: POST
Response code: 200 OK
Trigger heartbeat to tell the server that the client is active, and to keep the session alive as long as configured timeout value.
Path parameters
session_handle - The SessionHandle that identifies a session.
session_handle - The SessionHandle that identifies a session.
operation_handle - The OperationHandle that identifies a operation.
/sessions/:session_handle/statements
Verb: POST
Response code: 200 OK
Execute a statement.
Path parameters
session_handle - The SessionHandle that identifies a session.
v2
/api_versions
Verb: GET
Response code: 200 OK
Get the current available versions for the Rest Endpoint. The client can choose one of the return version as the protocol for later communicate.
/info
Verb: GET
Response code: 200 OK
Get meta data for this cluster.
/sessions
Verb: POST
Response code: 200 OK
Opens a new session with specific properties. Specific properties can be given for current session which will override the default properties of gateway.
/sessions/:session_handle
Verb: DELETE
Response code: 200 OK
Closes the specific session.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle
Verb: GET
Response code: 200 OK
Get the session configuration.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle/complete-statement
Verb: GET
Response code: 200 OK
Get the completion hints for the given statement at the given position.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle/configure-session
Verb: POST
Response code: 200 OK
Configures the session with the statement which could be: CREATE TABLE, DROP TABLE, ALTER TABLE, CREATE DATABASE, DROP DATABASE, ALTER DATABASE, CREATE FUNCTION, DROP FUNCTION, ALTER FUNCTION, CREATE CATALOG, DROP CATALOG, USE CATALOG, USE [CATALOG.]DATABASE, CREATE VIEW, DROP VIEW, LOAD MODULE, UNLOAD MODULE, USE MODULE, ADD JAR.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle/heartbeat
Verb: POST
Response code: 200 OK
Trigger heartbeat to tell the server that the client is active, and to keep the session alive as long as configured timeout value.
Path parameters
session_handle - The SessionHandle that identifies a session.
session_handle - The SessionHandle that identifies a session.
operation_handle - The OperationHandle that identifies a operation.
/sessions/:session_handle/statements
Verb: POST
Response code: 200 OK
Execute a statement.
Path parameters
session_handle - The SessionHandle that identifies a session.
v1
/api_versions
Verb: GET
Response code: 200 OK
Get the current available versions for the Rest Endpoint. The client can choose one of the return version as the protocol for later communicate.
/info
Verb: GET
Response code: 200 OK
Get meta data for this cluster.
/sessions
Verb: POST
Response code: 200 OK
Opens a new session with specific properties. Specific properties can be given for current session which will override the default properties of gateway.
/sessions/:session_handle
Verb: DELETE
Response code: 200 OK
Closes the specific session.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle
Verb: GET
Response code: 200 OK
Get the session configuration.
Path parameters
session_handle - The SessionHandle that identifies a session.
/sessions/:session_handle/heartbeat
Verb: POST
Response code: 200 OK
Trigger heartbeat to tell the server that the client is active, and to keep the session alive as long as configured timeout value.
Path parameters
session_handle - The SessionHandle that identifies a session.