REST API:execSQL Resource

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:

• SQL Browser
• SQL Syntax
• SQL Functions

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

Note: When specifying a URL in code, any special characters (characters other than letters and numbers) need to be encoded. For example, a space character can be encoded using either + or %20. (Browsers typically take care of encoding URLs entered into the address bar--so the URL displayed after visiting a page may differ somewhat from the one that was initially entered.) Here are some typical encodings: space + % %20 or + %2B %25 So: Instead of Use & (A&B) space (A B) %26 (A%26B) %20 (A%20B) It can be hard to get be hard to get the encoding right, so it's desirable to use a language library designed for the purpose. Learn more: URL Encoding in HTML Encode a URL in JavaScript URLEncoder class for Java

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