GetTables

Description

This service returns a list of available tables that a user can access, optionally filtered by solution and table type.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
solution (optional)	SolutionIdentifier	Specify a solution to only return the tables in that solution.
tableType (optional)	Table-Type	The type of table to return. If a table type is specified, only available tables of that type are listed.
options	Options	Holds name value pairing for future arguments.

Response

TableData is returned. The list of available tables and their fields are returned, optionally filtered by either solution or table type. For more information, see TableData.

Usage

If no solution ID is supplied, available tables are listed for all solutions. Use GetSolutions to return available solution IDs.

Faults

Invalid database pointer.
Reading the tables fails.
GetTables not implemented for table type.

XML

The following XML is a snippet of the payload that is sent with GetTables.

<urn:GetTables>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname>localhost</urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
        <urn:extendedData>
            <urn:data>
                <urn:name></urn:name>
                <urn:value></urn:value>
            </urn:data>
        </urn:extendedData>
    </urn:auth>
    <urn:solution>
        <urn:displayName>Issue Defect Management</urn:displayName>
        <urn:id>1</urn:id>
        <urn:uuid></urn:uuid>
        <urn:uniqueName></urn:uniqueName>
        <urn:tabName></urn:tabName>
    </urn:solution>
    <urn:tableType>PRIMARY-TABLE</urn:tableType>
    <urn:options>
        <urn:extraOption>
            <urn:name></urn:name>
            <urn:value></urn:value>
        </urn:extraOption>
    </urn:options>
</urn:GetTables>