Execute Procedure

The execute operation allows you to execute stored procedures for any of the data sources configured in your Connect AI account.

POST /exec

Execute Procedure

cURL

curl --request POST \
  --url https://cloud.cdata.com/api/exec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "procedure": "<string>",
  "defaultCatalog": "<string>",
  "defaultSchema": "<string>",
  "parameters": {},
  "timeout": 150
}
'

200

{
  "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

JWT token authentication. Include the token in the Authorization header as Bearer {token}. See Authentication for more information on creating a token.

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

Show child attributes

timeout · integer<int32>

Required range: 1 <= x <= 300

Response

200 - application/json

OK

results · object[] | null

Show child attributes

error · object

Show child attributes