Difference between revisions of "REST API:execSQL Resource"
From AgileApps Support Wiki
imported>Aeric m (Text replace - '<tt><nowiki>https://{domain}/networking' to '<tt>{{platformURL}}') |
imported>Aeric |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
===Permissions=== | ===Permissions=== | ||
{{ | {{permissionRef|Customize Objects|use this resource.}} | ||
===Execute a SQL Query=== | ===Execute a SQL Query=== | ||
| Line 15: | Line 15: | ||
;Method:GET | ;Method:GET | ||
;URI:<tt>{{platformURL}}/rest/execSQL?sql={query} | ;URI:<tt>{{platformURL}}/rest/execSQL?sql={query}</tt> | ||
{{Query Parameters| | {{Query Parameters| | ||
:*<tt>sql</tt> - The [[SQL Syntax|SQL language query]] to execute | :*<tt>sql</tt> - The [[SQL Syntax|SQL language query]] to execute, with special characters encoded}} | ||
;Response: | ;Response: | ||
Latest revision as of 20:34, 29 March 2013
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