REST API:execSQL Resource

Use the SQL query language to access Object tables, using the REST API.

Learn more: REST API Conventions and Considerations.

__TBD:

1. Add an entry to the REST API CheatSheet
2. Add an entry to the REST API (categorized) page
3. Add an entry to the REST Resources page

__

Permissions

__TBD: Are the permission(s) right?__

• Develop Tools permission must be enabled for the tenant.

Users that have the Manage Develop Features permission can use this resource.

Execute a SQL Query

Method

GET

URI

https://{domain}/networking/rest/execSQL?sql={query}

Query Parameters

• sql - The SQL language query to execute.

For more information, see: Specifying Query Parameters in REST APIs

Response

The tag names (shown here as field1, field2, etc.) are the column names specified in the query, or their aliases.

<platform>
    <record>
        <field1>...data...</field1>
        <field2>...data...</field2>
         ...
    </execSQL>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>N</recordCount>      <!-- Number of records returned by the query -->
</platform>

See also: REST API:Error Codes