Metadata Procedures

Version 22.0.8486


Metadata Procedures

Version 22.0.8486


This operation returns information about available stored procedures.

Request Format

GET /rest.rsc/procedures

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

Response Format

This operation returns the following columns in the standard JSON result object.

Column Data Type Description
PROCEDURE_CATALOG String The catalog name.
PROCEDURE_SCHEMA String The schema name.
PROCEDURE_NAME String The procedure name.
REMARKS String; Nullable A description of the procedure.
PROCEDURE_TYPE String The procedure type.

Example

Request

GET https://myconnectserver/rest.rsc/procedures?procedureName=CloseJob

Response

{
    "results": [
        {
            "schema": [
                {
                    "ordinal": 0,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_procedures",
                    "columnName": "PROCEDURE_CATALOG",
                    "columnLabel": "PROCEDURE_CATALOG",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 255,
                    "precision": 255,
                    "scale": 0,
                    "nullable": true
                },
                {
                    "ordinal": 1,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_procedures",
                    "columnName": "PROCEDURE_SCHEMA",
                    "columnLabel": "PROCEDURE_SCHEMA",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 255,
                    "precision": 255,
                    "scale": 0,
                    "nullable": true
                },
                {
                    "ordinal": 2,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_procedures",
                    "columnName": "PROCEDURE_NAME",
                    "columnLabel": "PROCEDURE_NAME",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 255,
                    "precision": 255,
                    "scale": 0,
                    "nullable": true
                },
                
                (...)
                
            ],
            "rows": [
                [
                    "Salesforce1",
                    "Salesforce",
                    "CloseJob",
                    "Closes a Salesforce job.",
                    "PROCEDURE"
                ]
            ],
            "affectedRows": -1
        }
    ]
}