REST API: SQL ProcedureColumns

Obtain a description of procedure parameters and result columns. The SQL ProcedureColumns service implements the CA IDMS Server JDBC API method with getProcedureColumns in the class IdmsDatabaseMetaData.
HTTP Method and URI Path
The URI path has the following format:
GET
<base url>
/sql/procedureColumns/
<datasource>
?
<query parameters>
Where:
  • <base URL>
    Specifies the base URL address for the CA IDMS REST API service
  • <datasource>
    (required) Identifies the CA IDMS system where the API request is to be sent and is defined in the datasources.yml file
  • <query parameters>
    (optional) The following parameters can be used to filter results. See the "About Parameters and Parameter Values" for usage information.
    • columnPattern -- Filter pattern for the column name
    • procedurePattern -- Filter pattern for the procedure name
    • schemaPattern -- Filter pattern for the schema name
About Parameters and Parameter Values:
  • The parameter "catalog" is not used within CA IDMS.
  • The filtering parameters allow the wildcards
    %
    and
    _
    . Within a pattern string,
    %
    means match any substring of 0 or more characters, and
    _
    means match any one character. Only metadata entries matching the search pattern are returned. In the URL, the
    %
    must be encoded as
    %25
    .
    To see how wildcards can be used in your request, see Examples for Specifying Patterns.
  • Parameter values are case sensitive.
Example:
Returns all procedure columns (no filter option used)
https://zoshost.domain.com:10010/api/v1/sql/procedureColumns/SYSDEMO
Response:
{ "procedureColumns": [ { "procedureCatalog": null, "procedureSchema": "DEMOEMPL", "procedureName": "IDMSCONP", "columnName": "EMP_ID", "columnType": 2, "dataType": 1, "typeName": "CHARACTER", "precision": 0, "length": 4, "scale": 0, "radix": 0, "nullable": 1, "remarks": null, "columnDefault": "' '", "sqlDataType": null, "sqlDatetimeSubcode": null, "characterOctetLength": 4, "ordinalPosition": 1, "isNullable": "YES", "specificName": "IDMSCONP" }, { "procedureCatalog": null, "procedureSchema": "DEMOEMPL", "procedureName": "IDMSCONP", "columnName": "EMP_FIRST_NAME", "columnType": 2, "dataType": 1, "typeName": "CHARACTER", "precision": 0, "length": 10, "scale": 0, "radix": 0, "nullable": 1, "remarks": null, "columnDefault": "' '", "sqlDataType": null, "sqlDatetimeSubcode": null, "characterOctetLength": 10, "ordinalPosition": 2, "isNullable": "YES", "specificName": "IDMSCONP" }, { "procedureCatalog": null, "procedureSchema": "DEMOEMPL", "procedureName": "IDMSCONP", "columnName": "EMP_LAST_NAME", "columnType": 2, "dataType": 1, "typeName": "CHARACTER", "precision": 0, "length": 15, "scale": 0, "radix": 0, "nullable": 1, "remarks": null, "columnDefault": "' '", "sqlDataType": null, "sqlDatetimeSubcode": null, "characterOctetLength": 15, "ordinalPosition": 3, "isNullable": "YES", "specificName": "IDMSCONP" }, { "procedureCatalog": null, "procedureSchema": "DEMOEMPL", "procedureName": "IDMSCONP", "columnName": "EMP_STREET", "columnType": 2, "dataType": 1, "typeName": "CHARACTER", "precision": 0, "length": 20, "scale": 0, "radix": 0, "nullable": 1, "remarks": null, "columnDefault": "' '", "sqlDataType": null, "sqlDatetimeSubcode": null, "characterOctetLength": 20, "ordinalPosition": 4, "isNullable": "YES", "specificName": "IDMSCONP" }, { "procedureCatalog": null, "procedureSchema": "DEMOEMPL", "procedureName": "IDMSCONP", "columnName": "EMP_CITY", "columnType": 2, "dataType": 1, "typeName": "CHARACTER", "precision": 0, "length": 15, "scale": 0, "radix": 0, "nullable": 1, "remarks": null, "columnDefault": "' '", "sqlDataType": null, "sqlDatetimeSubcode": null, "characterOctetLength": 15, "ordinalPosition": 5, "isNullable": "YES", "specificName": "IDMSCONP" }, { "procedureCatalog": null, "procedureSchema": "DEMOEMPL", "procedureName": "IDMSCONP", "columnName": "EMP_STATE", "columnType": 2, "dataType": 1, "typeName": "CHARACTER", "precision": 0, "length": 2, "scale": 0, "radix": 0, "nullable": 1, "remarks": null, "columnDefault": "' '", "sqlDataType": null, "sqlDatetimeSubcode": null, "characterOctetLength": 2, "ordinalPosition": 6, "isNullable": "YES", "specificName": "IDMSCONP" }, { "procedureCatalog": null, "procedureSchema": "DEMOEMPL", "procedureName": "IDMSCONP", "columnName": "EMP_ZIP", "columnType": 2, "dataType": 1, "typeName": "CHARACTER", "precision": 0, "length": 5, "scale": 0, "radix": 0, "nullable": 1, "remarks": null, "columnDefault": "' '", "sqlDataType": null, "sqlDatetimeSubcode": null, "characterOctetLength": 5, "ordinalPosition": 7, "isNullable": "YES", "specificName": "IDMSCONP" } ], "errors": [] }
Example: Returns all procedure columns, using a filter pattern
https://localhost:10080/api/v1/sql/procedureColumns/sysod108?schemaPattern=DEMO%&columnPattern=EMP_I%
Response:
{ "procedureColumns": [ { "procedureCatalog": null, "procedureSchema": "DEMOEMPL", "procedureName": "IDMSCONP", "columnName": "EMP_ID", "columnType": 2, "dataType": 1, "typeName": "CHARACTER", "precision": 0, "length": 4, "scale": 0, "radix": 0, "nullable": 1, "remarks": null, "columnDefault": "' '", "sqlDataType": null, "sqlDatetimeSubcode": null, "characterOctetLength": 4, "ordinalPosition": 1, "isNullable": "YES", "specificName": "IDMSCONP" } ], "errors": [] }