REST API:execSQL Resource
From AgileApps Support Wiki
Revision as of 20:34, 29 March 2013 by imported>Aeric (→Execute a SQL Query)
Use the SQL query language to access Object tables, using the REST API.
- Learn more: REST API Conventions and Considerations.
Permissions
Users that have the Customize Objects permission can use this resource..
Execute a SQL Query
Use the SQL query language to execute a query against Object tables.
Learn more:
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/execSQL?sql={query}
- Query Parameters
- sql - The SQL language query to execute, with special characters encoded
- 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.
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<record> <field1>...data...</field1> <field2>...data...</field2> ... </execSQL>
<message>
0
<description>Success</description>
</message>
<recordCount>N</recordCount>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes