Custom Sql Database Controller

post

Authorizations

accessTokenCookie & spaceHeader

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

datasourceIdstringRequired

Body

text/plain

stringOptional

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/custom-sql-database/{datasourceId}/sql

HTTPcURLJavaScriptPython

POST /api/custom-sql-database/{datasourceId}/sql HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: text/plain
Accept: */*
Content-Length: 6

"text"

{
  "results": [
    {
      "type": "text"
    }
  ],
  "size": 1
}

get

Authorizations

accessTokenCookie & spaceHeader

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

datasourceIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/custom-sql-database/{datasourceId}/schema

HTTPcURLJavaScriptPython

GET /api/custom-sql-database/{datasourceId}/schema HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "procedures": [
      {
        "type": "text",
        "columns": [
          {
            "precision": 1,
            "length": 1,
            "isNullable": true,
            "scale": 1,
            "remarks": "text",
            "name": "text",
            "type": "text",
            "kind": 1,
            "radix": 1
          }
        ],
        "name": "text",
        "remarks": "text"
      }
    ],
    "name": "text",
    "tables": [
      {
        "name": "text",
        "columns": [
          {
            "isNullable": true,
            "isKey": true,
            "size": 1,
            "scale": 1,
            "type": "text",
            "name": "text"
          }
        ],
        "indices": [
          {
            "isNonUnique": true,
            "cardinality": 1,
            "filterCondition": "text",
            "name": "text",
            "qualifier": "text",
            "ordinalPosition": 1,
            "pages": 1,
            "column": "text",
            "sortOrder": "text",
            "type": "text"
          }
        ],
        "type": "text",
        "remarks": "text"
      }
    ],
    "functions": [
      {
        "name": "text",
        "columns": [
          {
            "precision": 1,
            "length": 1,
            "isNullable": true,
            "scale": 1,
            "remarks": "text",
            "name": "text",
            "type": "text",
            "kind": 1,
            "radix": 1
          }
        ],
        "remarks": "text",
        "type": "text"
      }
    ]
  }
]

get

Authorizations

accessTokenCookie & spaceHeader

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

datasourceIdstringRequired

schemaNamestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/custom-sql-database/{datasourceId}/schema/{schemaName}/table

HTTPcURLJavaScriptPython

GET /api/custom-sql-database/{datasourceId}/schema/{schemaName}/table HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "name": "text",
    "columns": [
      {
        "isNullable": true,
        "isKey": true,
        "size": 1,
        "scale": 1,
        "type": "text",
        "name": "text"
      }
    ],
    "indices": [
      {
        "isNonUnique": true,
        "cardinality": 1,
        "filterCondition": "text",
        "name": "text",
        "qualifier": "text",
        "ordinalPosition": 1,
        "pages": 1,
        "column": "text",
        "sortOrder": "text",
        "type": "text"
      }
    ],
    "type": "text",
    "remarks": "text"
  }
]

get

Authorizations

accessTokenCookie & spaceHeader

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

datasourceIdstringRequired

schemaNamestringRequired

tableNamestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/custom-sql-database/{datasourceId}/schema/{schemaName}/table/{tableName}

HTTPcURLJavaScriptPython

GET /api/custom-sql-database/{datasourceId}/schema/{schemaName}/table/{tableName} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "name": "text",
  "columns": [
    {
      "isNullable": true,
      "isKey": true,
      "size": 1,
      "scale": 1,
      "type": "text",
      "name": "text"
    }
  ],
  "indices": [
    {
      "isNonUnique": true,
      "cardinality": 1,
      "filterCondition": "text",
      "name": "text",
      "qualifier": "text",
      "ordinalPosition": 1,
      "pages": 1,
      "column": "text",
      "sortOrder": "text",
      "type": "text"
    }
  ],
  "type": "text",
  "remarks": "text"
}

get

Authorizations

accessTokenCookie & spaceHeader

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

datasourceIdstringRequired

schemaNamestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/custom-sql-database/{datasourceId}/schema/{schemaName}/procedure

HTTPcURLJavaScriptPython

GET /api/custom-sql-database/{datasourceId}/schema/{schemaName}/procedure HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "type": "text",
    "columns": [
      {
        "precision": 1,
        "length": 1,
        "isNullable": true,
        "scale": 1,
        "remarks": "text",
        "name": "text",
        "type": "text",
        "kind": 1,
        "radix": 1
      }
    ],
    "name": "text",
    "remarks": "text"
  }
]

get

Authorizations

accessTokenCookie & spaceHeader

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

datasourceIdstringRequired

schemaNamestringRequired

procedureNamestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/custom-sql-database/{datasourceId}/schema/{schemaName}/procedure/{procedureName}

HTTPcURLJavaScriptPython

GET /api/custom-sql-database/{datasourceId}/schema/{schemaName}/procedure/{procedureName} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "type": "text",
  "columns": [
    {
      "precision": 1,
      "length": 1,
      "isNullable": true,
      "scale": 1,
      "remarks": "text",
      "name": "text",
      "type": "text",
      "kind": 1,
      "radix": 1
    }
  ],
  "name": "text",
  "remarks": "text"
}

get

Authorizations

accessTokenCookie & spaceHeader

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

datasourceIdstringRequired

schemaNamestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/custom-sql-database/{datasourceId}/schema/{schemaName}/function

HTTPcURLJavaScriptPython

GET /api/custom-sql-database/{datasourceId}/schema/{schemaName}/function HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "name": "text",
    "columns": [
      {
        "precision": 1,
        "length": 1,
        "isNullable": true,
        "scale": 1,
        "remarks": "text",
        "name": "text",
        "type": "text",
        "kind": 1,
        "radix": 1
      }
    ],
    "remarks": "text",
    "type": "text"
  }
]

get

Authorizations

accessTokenCookie & spaceHeader

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

datasourceIdstringRequired

schemaNamestringRequired

functionNamestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/custom-sql-database/{datasourceId}/schema/{schemaName}/function/{functionName}

HTTPcURLJavaScriptPython

GET /api/custom-sql-database/{datasourceId}/schema/{schemaName}/function/{functionName} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "name": "text",
  "columns": [
    {
      "precision": 1,
      "length": 1,
      "isNullable": true,
      "scale": 1,
      "remarks": "text",
      "name": "text",
      "type": "text",
      "kind": 1,
      "radix": 1
    }
  ],
  "remarks": "text",
  "type": "text"
}