Difference between revisions of "REST API:execSQL Resource"

Latest revision as of 20:34, 29 March 2013

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

Users that have the Customize Objects permission can use this resource..

Use the SQL query language to execute a query against Object tables.

Learn more:

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

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

   <message>
       0
       <description>Success</description>
   </message>
   <recordCount>N</recordCount>

</platform> </syntaxhighlight>

@@ Line 1: / Line 1: @@
 Use the SQL query language to access Object tables, using the [[REST API]].
 :''Learn more:'' REST API [[REST API#Conventions and Considerations|Conventions and Considerations]].
-{{TBD|<br/>
-# Add an entry to the [[REST API:REST API CheatSheet|REST API CheatSheet]]
-# Add an entry to the [[REST API]] (categorized) page
-# Add an entry to the [[REST API:REST Resources (alphabetical)|REST Resources]] page
-}}
 ===Permissions===
-{{TBD|Are the permission(s) right?}}
+{{permissionRef|Customize Objects|use this resource.}}
-:* [[Develop Tools]] permission must be enabled for the tenant.
-{{permissions|Manage Develop Features|use this resource.}}
 ===Execute a SQL Query===
+Use the SQL query language to execute a query against Object tables.
+''Learn more:''
+:* [[SQL Browser]]
+:* [[SQL Syntax]]
+:* [[SQL Functions]]
 ;Method:GET
-;URI:<tt><nowiki>https://{domain}/networking/rest/execSQL?sql={query}</nowiki></tt>
+;URI:<tt>{{platformURL}}/rest/execSQL?sql={query}</tt>
 {{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: