pp108 : OperationGetTables

OperationGetTables


This method is used to retrieve details of all the tables in a database. This method can be tested through the Service Test Tool of Process Platform.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetTables xmlns="http://schemas.cordys.com/WS-AppServer/1.0">
            <tableCatalog>Northwind</tableCatalog>
            <tableSchema>dbo</tableSchema>
            <tableType>TABLE</tableType>
            <tableFilter>%</tableFilter>
        </GetTables>
    </SOAP:Body>
</SOAP:Envelope>

Request Parameters

Parameter

Description

Data Type

Accepted Input Values

tableCatalog

The table name from which the table information should be extracted. If not specified, information is retrieved from all the catalogs.

String

-

tableSchema

The schema defined in the database. In SQL, this denotes the name of the owner of the database.

String

dbo

tableType

The type of the table retrieved.

String

TABLE

tableFilter

The filter criteria for filtering the metadata.

String

By default this is %, which displays all tables


SOAP Response

<data>
    <GetTablesResponse
        xmlns="http://schemas.cordys.com/WS-AppServer/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <tuple>
            <old>
                <Tables>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Categories</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>CustomerCustomerDemo</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>CustomerDemographics</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Customers</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Employees</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>EmployeeTerritories</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Order Details</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Orders</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Products</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Region</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Shippers</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Suppliers</tableName>
                        <description/>
                    </TableInfo>
                    <TableInfo>
                        <tableCatalog>Northwind</tableCatalog>
                        <tableSchema>dbo</tableSchema>
                        <tableName>Territories</tableName>
                        <description/>
                    </TableInfo>
                </Tables>
            </old>
        </tuple>
    </GetTablesResponse>
</data>

Response Parameters

Parameter

Description

Tables

The tables present in the catalog.

tableInfo

Details of each table.