{
  "opencollection": "1.0.0",
  "info": {
    "name": "Azure Synapse Analytics - Spark Job API",
    "version": "2019-11-01-preview"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "implicit",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "credentials": {
        "clientId": "{{clientId}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "SparkBatch",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Azure Synapse Analytics List Spark batch jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/batches",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Optional param specifying which index the list should begin from."
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Optional param specifying the size of the returned list."
              },
              {
                "name": "detailed",
                "value": "",
                "type": "query",
                "description": "Optional query param specifying whether detailed response is returned beyond plain livy."
              }
            ]
          },
          "docs": "List all Spark batch jobs running against the Spark pool."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics Create a Spark batch job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/batches",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "detailed",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create new Spark batch job."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics Get a Spark batch job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/batches/:batchId",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "batchId",
                "value": "",
                "type": "path",
                "description": "Identifier for the batch job."
              },
              {
                "name": "detailed",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Gets a single Spark batch job."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics Cancel a Spark batch job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/batches/:batchId",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "batchId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Cancels a running Spark batch job."
        }
      ]
    },
    {
      "info": {
        "name": "SparkSession",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Azure Synapse Analytics List Spark sessions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/sessions",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "from",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              },
              {
                "name": "detailed",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List all Spark sessions running against the Spark pool."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics Create a Spark session",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/sessions",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "detailed",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create new Spark session."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics Get a Spark session",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/sessions/:sessionId",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "sessionId",
                "value": "",
                "type": "path"
              },
              {
                "name": "detailed",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Gets a single Spark session."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics Cancel a Spark session",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/sessions/:sessionId",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "sessionId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Cancels a running Spark session."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics List Spark session statements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/sessions/:sessionId/statements",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "sessionId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Gets a list of statements within a Spark session."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics Create a Spark statement",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/sessions/:sessionId/statements",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "sessionId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a statement within a Spark session."
        },
        {
          "info": {
            "name": "Azure Synapse Analytics Cancel a Spark statement",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{workspaceName}.dev.azuresynapse.net/livyApi/versions/:sparkPoolName/sessions/:sessionId/statements/:statementId/cancel",
            "params": [
              {
                "name": "sparkPoolName",
                "value": "",
                "type": "path",
                "description": "Name of the Spark pool."
              },
              {
                "name": "sessionId",
                "value": "",
                "type": "path"
              },
              {
                "name": "statementId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Kill a statement within a session."
        }
      ]
    }
  ],
  "bundled": true
}