This is a collection for Postman to access the Apache Flink SQL Gateway. It’s based on the yaml published for version 1.18.1.
I’ve added Tests to set Session and Operation handles, and amended the collection to use these variables.
You need to set a Global Variable for baseURL to your Flink SQL Gateway.
If you launch the gateway locally with:
./bin/start-cluster.sh
./bin/sql-gateway.sh start -Dsql-gateway.endpoint.rest.address=localhostThen set the baseURL to http://localhost:8083.
| { | |
| "info": { | |
| "_postman_id": "0135b49e-6b06-4fee-952f-fa68e626062d", | |
| "name": "Flink SQL Gateway REST API", | |
| "description": "Contact Support:\n Email: user@flink.apache.org", | |
| "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", | |
| "_exporter_id": "24249542" | |
| }, | |
| "item": [ | |
| { | |
| "name": "api_versions", | |
| "item": [ | |
| { | |
| "name": "get Api Version", | |
| "request": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": "{{baseUrl}}/api_versions", | |
| "description": "Get the current available versions for the Rest Endpoint. The client can choose one of the return version as the protocol for later communicate." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": "{{baseUrl}}/api_versions" | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"versions\": [\n \"<string>\",\n \"<string>\"\n ]\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "info", | |
| "item": [ | |
| { | |
| "name": "get Info", | |
| "request": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": "{{baseUrl}}/info", | |
| "description": "Get meta data for this cluster." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": "{{baseUrl}}/info" | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"productName\": \"<string>\",\n \"version\": \"<string>\"\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "sessions", | |
| "item": [ | |
| { | |
| "name": "{session_handle}", | |
| "item": [ | |
| { | |
| "name": "complete-statement", | |
| "item": [ | |
| { | |
| "name": "complete Statement", | |
| "protocolProfileBehavior": { | |
| "disableBodyPruning": true | |
| }, | |
| "request": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| }, | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "body": { | |
| "mode": "raw", | |
| "raw": "{\n \"position\": \"<integer>\",\n \"statement\": \"<string>\"\n}", | |
| "options": { | |
| "raw": { | |
| "headerFamily": "json", | |
| "language": "json" | |
| } | |
| } | |
| }, | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/complete-statement", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "complete-statement" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| } | |
| ] | |
| }, | |
| "description": "Get the completion hints for the given statement at the given position." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| }, | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/complete-statement", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "complete-statement" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"candidates\": [\n \"<string>\",\n \"<string>\"\n ]\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "configure-session", | |
| "item": [ | |
| { | |
| "name": "configure Session", | |
| "request": { | |
| "method": "POST", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "body": { | |
| "mode": "raw", | |
| "raw": "{\n \"executionTimeout\": \"<long>\",\n \"statement\": \"<string>\"\n}", | |
| "options": { | |
| "raw": { | |
| "headerFamily": "json", | |
| "language": "json" | |
| } | |
| } | |
| }, | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/configure-session", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "configure-session" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| } | |
| ] | |
| }, | |
| "description": "Configures the session with the statement which could be:\nCREATE 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." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "POST", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "body": { | |
| "mode": "raw", | |
| "raw": "{\n \"executionTimeout\": \"<long>\",\n \"statement\": \"<string>\"\n}", | |
| "options": { | |
| "raw": { | |
| "headerFamily": "json", | |
| "language": "json" | |
| } | |
| } | |
| }, | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/configure-session", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "configure-session" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "text", | |
| "header": [], | |
| "cookie": [], | |
| "body": "" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "heartbeat", | |
| "item": [ | |
| { | |
| "name": "trigger Session", | |
| "request": { | |
| "method": "POST", | |
| "header": [], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/heartbeat", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "heartbeat" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| } | |
| ] | |
| }, | |
| "description": "Trigger heartbeat to tell the server that the client is active, and to keep the session alive as long as configured timeout value." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "POST", | |
| "header": [], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/heartbeat", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "heartbeat" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "text", | |
| "header": [], | |
| "cookie": [], | |
| "body": "" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "operations", | |
| "item": [ | |
| { | |
| "name": "{operation_handle}", | |
| "item": [ | |
| { | |
| "name": "cancel", | |
| "item": [ | |
| { | |
| "name": "cancel Operation", | |
| "request": { | |
| "method": "POST", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/operations/{{operationHandle}}/cancel", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "operations", | |
| "{{operationHandle}}", | |
| "cancel" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| }, | |
| { | |
| "key": "operation_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The OperationHandle that identifies a operation." | |
| } | |
| ] | |
| }, | |
| "description": "Cancel the operation." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "POST", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/operations/{{operationHandle}}/cancel", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "operations", | |
| "{{operationHandle}}", | |
| "cancel" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| }, | |
| { | |
| "key": "operation_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"status\": \"<string>\"\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "close", | |
| "item": [ | |
| { | |
| "name": "close Operation", | |
| "request": { | |
| "method": "DELETE", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/operations/{{operationHandle}}/close", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "operations", | |
| "{{operationHandle}}", | |
| "close" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| }, | |
| { | |
| "key": "operation_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The OperationHandle that identifies a operation." | |
| } | |
| ] | |
| }, | |
| "description": "Close the operation." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "DELETE", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/operations/{{operationHandle}}/close", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "operations", | |
| "{{operationHandle}}", | |
| "close" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| }, | |
| { | |
| "key": "operation_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"status\": \"<string>\"\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "result", | |
| "item": [ | |
| { | |
| "name": "{token}", | |
| "item": [ | |
| { | |
| "name": "fetch Results", | |
| "request": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/operations/{{operationHandle}}/result/0?rowFormat=JSON", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "operations", | |
| "{{operationHandle}}", | |
| "result", | |
| "0" | |
| ], | |
| "query": [ | |
| { | |
| "key": "rowFormat", | |
| "value": "JSON", | |
| "description": "(Required) The row format to serialize the RowData." | |
| } | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| }, | |
| { | |
| "key": "operation_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The OperationHandle that identifies a operation." | |
| }, | |
| { | |
| "key": "token", | |
| "value": "<long>", | |
| "description": "(Required) The OperationHandle that identifies a operation." | |
| } | |
| ] | |
| }, | |
| "description": "Fetch results of Operation." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/operations/{{operationHandle}}/result/:token?rowFormat=JSON", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "operations", | |
| "{{operationHandle}}", | |
| "result", | |
| ":token" | |
| ], | |
| "query": [ | |
| { | |
| "key": "rowFormat", | |
| "value": "JSON", | |
| "description": "(Required) The row format to serialize the RowData." | |
| } | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| }, | |
| { | |
| "key": "operation_handle" | |
| }, | |
| { | |
| "key": "token" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"jobID\": \"8b9f35881e2a126febbd866128df6df5\",\n \"nextResultUri\": \"<string>\",\n \"queryResult\": \"<boolean>\",\n \"resultKind\": \"SUCCESS_WITH_CONTENT\",\n \"resultType\": \"PAYLOAD\",\n \"results\": {\n \"columnInfos\": [\n {\n \"comment\": \"<string>\",\n \"logicalType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n }\n ],\n \"nullable\": \"<boolean>\",\n \"typeRoot\": \"DATE\"\n },\n \"name\": \"<string>\"\n },\n {\n \"comment\": \"<string>\",\n \"logicalType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n }\n ],\n \"nullable\": \"<boolean>\",\n \"typeRoot\": \"MAP\"\n },\n \"name\": \"<string>\"\n }\n ],\n \"data\": [\n {\n \"arity\": \"<integer>\",\n \"rowKind\": \"UPDATE_AFTER\"\n },\n {\n \"arity\": \"<integer>\",\n \"rowKind\": \"INSERT\"\n }\n ],\n \"resultSchema\": {\n \"columnCount\": \"<integer>\",\n \"columnDataTypes\": [\n {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n }\n ],\n \"logicalType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n }\n ],\n \"nullable\": \"<boolean>\",\n \"typeRoot\": \"FLOAT\"\n }\n },\n {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n }\n ],\n \"logicalType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n }\n ],\n \"nullable\": \"<boolean>\",\n \"typeRoot\": \"BIGINT\"\n }\n }\n ],\n \"columnNames\": [\n \"<string>\",\n \"<string>\"\n ],\n \"columns\": [\n {\n \"comment\": \"<string>\",\n \"dataType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n }\n ],\n \"logicalType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n }\n ],\n \"nullable\": \"<boolean>\",\n \"typeRoot\": \"ROW\"\n }\n },\n \"name\": \"<string>\",\n \"persisted\": \"<boolean>\",\n \"physical\": \"<boolean>\"\n },\n {\n \"comment\": \"<string>\",\n \"dataType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n }\n ],\n \"logicalType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n }\n ],\n \"nullable\": \"<boolean>\",\n \"typeRoot\": \"TIME_WITHOUT_TIME_ZONE\"\n }\n },\n \"name\": \"<string>\",\n \"persisted\": \"<boolean>\",\n \"physical\": \"<boolean>\"\n }\n ],\n \"primaryKey\": {\n \"columns\": [\n \"<string>\",\n \"<string>\"\n ],\n \"enforced\": \"<boolean>\",\n \"name\": \"<string>\",\n \"type\": \"PRIMARY_KEY\"\n },\n \"primaryKeyIndexes\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"watermarkSpecs\": [\n {\n \"rowtimeAttribute\": \"<string>\",\n \"watermarkExpression\": {\n \"outputDataType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n }\n ],\n \"logicalType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n }\n ],\n \"nullable\": \"<boolean>\",\n \"typeRoot\": \"CHAR\"\n }\n },\n \"resolvedChildren\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/ResolvedExpression detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/ResolvedExpression detected>\"\n }\n ]\n }\n },\n {\n \"rowtimeAttribute\": \"<string>\",\n \"watermarkExpression\": {\n \"outputDataType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/DataType detected>\"\n }\n ],\n \"logicalType\": {\n \"children\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/LogicalType detected>\"\n }\n ],\n \"nullable\": \"<boolean>\",\n \"typeRoot\": \"MULTISET\"\n }\n },\n \"resolvedChildren\": [\n {\n \"value\": \"<Circular reference to #/components/schemas/ResolvedExpression detected>\"\n },\n {\n \"value\": \"<Circular reference to #/components/schemas/ResolvedExpression detected>\"\n }\n ]\n }\n }\n ]\n },\n \"rowFormat\": \"PLAIN_TEXT\"\n }\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "status", | |
| "item": [ | |
| { | |
| "name": "get Operation Status", | |
| "request": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/operations/{{operationHandle}}/status", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "operations", | |
| "{{operationHandle}}", | |
| "status" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| }, | |
| { | |
| "key": "operation_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The OperationHandle that identifies a operation." | |
| } | |
| ] | |
| }, | |
| "description": "Get the status of operation." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/operations/{{operationHandle}}/status", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "operations", | |
| "{{operationHandle}}", | |
| "status" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| }, | |
| { | |
| "key": "operation_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"status\": \"<string>\"\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "statements", | |
| "item": [ | |
| { | |
| "name": "execute Statement", | |
| "event": [ | |
| { | |
| "listen": "test", | |
| "script": { | |
| "exec": [ | |
| "var jsonData = JSON.parse(responseBody);", | |
| "postman.setEnvironmentVariable(\"operationHandle\", jsonData.operationHandle);" | |
| ], | |
| "type": "text/javascript" | |
| } | |
| } | |
| ], | |
| "request": { | |
| "method": "POST", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| }, | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "body": { | |
| "mode": "raw", | |
| "raw": "{\n \"statement\": \"SELECT * FROM foo;\"\n}", | |
| "options": { | |
| "raw": { | |
| "headerFamily": "json", | |
| "language": "json" | |
| } | |
| } | |
| }, | |
| "url": "{{baseUrl}}/sessions/{{sessionHandle}}/statements", | |
| "description": "Execute a statement." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "POST", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| }, | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "body": { | |
| "mode": "raw", | |
| "raw": "{\n \"executionConfig\": {\n \"nisib\": \"<string>\",\n \"fugiat5b3\": \"<string>\"\n },\n \"executionTimeout\": \"<long>\",\n \"statement\": \"<string>\"\n}", | |
| "options": { | |
| "raw": { | |
| "headerFamily": "json", | |
| "language": "json" | |
| } | |
| } | |
| }, | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}/statements", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}", | |
| "statements" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"operationHandle\": \"<string>\"\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "get Session Config", | |
| "request": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| } | |
| ] | |
| }, | |
| "description": "Get the session configuration." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "GET", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"properties\": {\n \"adipisicing23\": \"<string>\"\n }\n}" | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "close Session", | |
| "request": { | |
| "method": "DELETE", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle", | |
| "value": "identifier,<uuid>", | |
| "description": "(Required) The SessionHandle that identifies a session." | |
| } | |
| ] | |
| }, | |
| "description": "Closes the specific session." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "DELETE", | |
| "header": [ | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "url": { | |
| "raw": "{{baseUrl}}/sessions/{{sessionHandle}}", | |
| "host": [ | |
| "{{baseUrl}}" | |
| ], | |
| "path": [ | |
| "sessions", | |
| "{{sessionHandle}}" | |
| ], | |
| "variable": [ | |
| { | |
| "key": "session_handle" | |
| } | |
| ] | |
| } | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"status\": \"<string>\"\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "name": "open Session", | |
| "event": [ | |
| { | |
| "listen": "test", | |
| "script": { | |
| "exec": [ | |
| "var jsonData = JSON.parse(responseBody);", | |
| "postman.setEnvironmentVariable(\"sessionHandle\", jsonData.sessionHandle);" | |
| ], | |
| "type": "text/javascript" | |
| } | |
| } | |
| ], | |
| "request": { | |
| "method": "POST", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| }, | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "body": { | |
| "mode": "raw", | |
| "raw": "", | |
| "options": { | |
| "raw": { | |
| "headerFamily": "json", | |
| "language": "json" | |
| } | |
| } | |
| }, | |
| "url": "{{baseUrl}}/sessions", | |
| "description": "Opens a new session with specific properties. Specific properties can be given for current session which will override the default properties of gateway." | |
| }, | |
| "response": [ | |
| { | |
| "name": "The request was successful.", | |
| "originalRequest": { | |
| "method": "POST", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| }, | |
| { | |
| "key": "Accept", | |
| "value": "application/json" | |
| } | |
| ], | |
| "body": { | |
| "mode": "raw", | |
| "raw": "{\n \"properties\": {\n \"consectetur_93d\": \"<string>\",\n \"dolor_b3\": \"<string>\",\n \"ipsum2e\": \"<string>\",\n \"dolor_c\": \"<string>\"\n },\n \"sessionName\": \"<string>\"\n}", | |
| "options": { | |
| "raw": { | |
| "headerFamily": "json", | |
| "language": "json" | |
| } | |
| } | |
| }, | |
| "url": "{{baseUrl}}/sessions" | |
| }, | |
| "status": "OK", | |
| "code": 200, | |
| "_postman_previewlanguage": "json", | |
| "header": [ | |
| { | |
| "key": "Content-Type", | |
| "value": "application/json" | |
| } | |
| ], | |
| "cookie": [], | |
| "body": "{\n \"sessionHandle\": \"<string>\"\n}" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "variable": [ | |
| { | |
| "key": "baseUrl", | |
| "value": "/" | |
| } | |
| ] | |
| } |