Metadata Procedure Parameters
Metadata Procedure Parameters
This operation returns information about a stored procedure’s parameters.
Request
GET https://cloud.cdata.com/api/procedureParameters
Query String Parameters
| Parameter | Description | Notes |
| catalogName | Restricts results to the specified catalog. | Optional |
| schemaName | Restricts results to the specified schema. | Optional |
| procedureName | Restricts results to the specified procedure. | Optional |
| paramName | Restricts results to the specified procedure parameter. | Optional |
Response
HTTP 200 OK
{
"results": [
{
"affectedRows": -1,
"rowsTruncated": false,
"schema": [
{
"catalogName": "CData",
"columnLabel": "PROCEDURE_CATALOG",
"columnName": "PROCEDURE_CATALOG",
"dataType": 5,
"dataTypeName": "VARCHAR",
"length": 255,
"nullable": true,
"ordinal": 0,
"precision": 255,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "PROCEDURE_SCHEMA",
"columnName": "PROCEDURE_SCHEMA",
"dataType": 5,
"dataTypeName": "VARCHAR",
"length": 255,
"nullable": true,
"ordinal": 1,
"precision": 255,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "PROCEDURE_NAME",
"columnName": "PROCEDURE_NAME",
"dataType": 5,
"dataTypeName": "VARCHAR",
"length": 512,
"nullable": true,
"ordinal": 2,
"precision": 512,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "PARAM_NAME",
"columnName": "PARAM_NAME",
"dataType": 5,
"dataTypeName": "VARCHAR",
"length": 512,
"nullable": true,
"ordinal": 3,
"precision": 512,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "PARAM_TYPE",
"columnName": "PARAM_TYPE",
"dataType": 8,
"dataTypeName": "INT",
"length": 11,
"nullable": true,
"ordinal": 4,
"precision": 10,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "DATA_TYPE",
"columnName": "DATA_TYPE",
"dataType": 8,
"dataTypeName": "INT",
"length": 11,
"nullable": true,
"ordinal": 5,
"precision": 10,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "TYPE_NAME",
"columnName": "TYPE_NAME",
"dataType": 5,
"dataTypeName": "VARCHAR",
"length": 32,
"nullable": true,
"ordinal": 6,
"precision": 32,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "LENGTH",
"columnName": "LENGTH",
"dataType": 8,
"dataTypeName": "INT",
"length": 11,
"nullable": true,
"ordinal": 7,
"precision": 10,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "PRECISION",
"columnName": "PRECISION",
"dataType": 8,
"dataTypeName": "INT",
"length": 11,
"nullable": true,
"ordinal": 8,
"precision": 10,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "SCALE",
"columnName": "SCALE",
"dataType": 8,
"dataTypeName": "INT",
"length": 11,
"nullable": true,
"ordinal": 9,
"precision": 10,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "REMARKS",
"columnName": "REMARKS",
"dataType": 5,
"dataTypeName": "VARCHAR",
"length": 512,
"nullable": true,
"ordinal": 10,
"precision": 512,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "IS_NULLABLE",
"columnName": "IS_NULLABLE",
"dataType": 14,
"dataTypeName": "BIT",
"length": 5,
"nullable": true,
"ordinal": 11,
"precision": 1,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "IS_REQUIRED",
"columnName": "IS_REQUIRED",
"dataType": 14,
"dataTypeName": "BIT",
"length": 5,
"nullable": true,
"ordinal": 12,
"precision": 1,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
},
{
"catalogName": "CData",
"columnLabel": "ORDINAL_POSITION",
"columnName": "ORDINAL_POSITION",
"dataType": 8,
"dataTypeName": "INT",
"length": 11,
"nullable": true,
"ordinal": 13,
"precision": 10,
"scale": 0,
"schemaName": "QueryFederation",
"tableName": "sys_procedureparameters"
}
],
"rows": []
}
]
}
Fields
| Column | Data Type | Description |
| PROCEDURE_CATALOG | String | The catalog name. |
| PROCEDURE_SCHEMA | String | The schema name. |
| PROCEDURE_NAME | String | The procedure name. |
| PARAM_NAME | String | The procedure parameter name. |
| PARAM_TYPE | Integer | The parameter’s type. (See notes, below) |
| DATA_TYPE | Integer | The parameter’s data type. |
| TYPE_NAME | String | The name of the parameter’s data type. May be data-source-specific. |
| LENGTH | Integer | The parameter’s length. |
| PRECISION | Integer; Nullable | The parameter’s precision. |
| SCALE | Integer; Nullable | The parameter’s scale. |
| REMARKS | String; Nullable | A description of the parameter. |
| IS_NULLABLE | Boolean; Nullable | Whether the parameter is nullable. |
| IS_REQUIRED | Boolean; Nullable | Whether the parameter is required. |
| ORDINAL_POSITION | Integer | The parameter’s ordinal position. (See notes, below.) |
- Possible values for PARAM_TYPE are:
1: Input parameter2: In/out parameter4: Output parameter5: Return value
- ORDINAL_POSITION is a 1-based value for input, in/out, and output parameters. A value of
0indicates a return value parameter.