pp108 : OperationGetProcedures

OperationGetProcedures


This Web service operation is used to retrieve metadata information about all procedures of a particular catalog.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetProcedures xmlns="http://schemas.cordys.com/WS-AppServer/1.0">
            <procedureCatalog>Northwind</procedureCatalog>
            <procedureSchema>dbo</procedureSchema>
            <procedureName>CustOrdersOrders</procedureName>
            <procedureFilter>%</procedureFilter>
        </GetProcedures>
    </SOAP:Body>
</SOAP:Envelope>

Request Parameters

Tags

Description

procedureCatalog

Denotes the name of the catalog from which the procedure information should be extracted; if not mentioned, the information is retrieved from all the catalogs.

procedureSchema

Denotes the schema defined in the database; in SQL, this denotes the name of the owner of the database, that is, dbo.

procedureFilter

Denotes the filter criteria for filtering the metadata; by default this is %, which displays all stored procedures.


SOAP Response

<data>
    <GetProceduresResponse
        xmlns="http://schemas.cordys.com/WS-AppServer/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <tuple>
            <old>
                <Procedures>
                    <ProcedureInfo>
                        <procedureCatalog>Northwind</procedureCatalog>
                        <procedureSchema>dbo</procedureSchema>
                        <procedureName>CustOrdersOrders;1</procedureName>
                        <description/>
                        <procedureType>FUNCTION</procedureType>
                    </ProcedureInfo>
                </Procedures>
            </old>
        </tuple>
    </GetProceduresResponse>
</data>

Response Parameters

Parameter

Description

procedureType

Type of the procedure. It would either be a PROCEDURE or a FUNCTION. It does not return any value.

procedureInfo

Details about each procedure.