Difference between revisions of "REST API:execSQL Resource"
From AgileApps Support Wiki
imported>Aeric m (moved REST API:sql Resource to REST API:execSQL Resource) |
imported>Aeric |
||
| Line 1: | Line 1: | ||
Use the SQL query language to access Object tables, using the [[REST API]]. | Use the SQL query language to access Object tables, using the [[REST API]]. | ||
:''Learn more:'' | :''Learn more:'' REST API [[REST API#Conventions and Considerations|Conventions and Considerations]]. | ||
{{TBD|<br/> | {{TBD|<br/> | ||
| Line 16: | Line 14: | ||
===Execute a SQL Query=== | ===Execute a SQL Query=== | ||
;Method:GET | ;Method:GET | ||
| Line 23: | Line 20: | ||
{{Query Parameters| | {{Query Parameters| | ||
:*<tt>sql</tt> - The SQL language query to execute.}} | :*<tt>sql</tt> - The [[SQL Syntax|SQL language query]] to execute.}} | ||
;Response: | ;Response: | ||
Revision as of 01:41, 16 November 2011
Use the SQL query language to access Object tables, using the REST API.
- Learn more: REST API Conventions and Considerations.
__TBD:
- Add an entry to the REST API CheatSheet
- Add an entry to the REST API (categorized) page
- 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
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<execSQL>
<id>...</id>
<field>data</field>
...
</execSQL>
<message>
0
<description>Success</description>
</message>
<recordCount>N</recordCount>
</platform> </syntaxhighlight> where:
- The column names are the columns from the queried rows, or their aliases.
- See also: REST API:Error Codes