Skip to main content
POST
/
exec
Execute Procedure
curl --request POST \
  --url https://cloud.cdata.com/api/exec \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "procedure": "<string>",
  "defaultCatalog": "<string>",
  "defaultSchema": "<string>",
  "parameters": {},
  "timeout": 150
}
'
{
  "results": [
    {
      "affectedRows": 123,
      "schema": [
        {
          "catalogName": "<string>",
          "columnLabel": "<string>",
          "columnName": "<string>",
          "dataType": 1,
          "dataTypeName": "<string>",
          "length": 123,
          "nullable": true,
          "ordinal": 123,
          "precision": 123,
          "scale": 123,
          "schemaName": "<string>",
          "tableName": "<string>"
        }
      ],
      "rows": [
        [
          "<unknown>"
        ]
      ]
    }
  ],
  "error": {
    "code": 0,
    "message": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Basic Authentication with username and password. Use your PAT as the password. You can get your PAT from Connect AI by selecting Settings > Access Tokens.

Query Parameters

workspace
string

If your query contains a workspace, the workspace name must be specified here.

Body

application/json
procedure
string
required

The name of the stored procedure to execute. Must be a valid stored procedure name.

Minimum string length: 1
defaultCatalog
string | null
defaultSchema
string | null
parameters
object
timeout
integer<int32>
Required range: 1 <= x <= 300

Response

200 - application/json

OK

results
object[] | null
error
object