REST API:execSQL Resource

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

Learn more: REST API Conventions and Considerations.

Note: Use this structure the same way you use the structure for man pages: Follow the presentation pattern, but if a section isn't needed, don't include the header. Also: 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

Requirements

• Requirement #1
• Requirement #2

Permissions

__TBD: Are the permission(s) right?__ -- check Administrative Permissions for a list of possibilities

• Develop Tools permission must be enabled for the tenant.

Users that have the Access Control/User Management permission can use this resource.

Users that have the Manage Develop Features permission can use this resource.

Execute an 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>

See also: REST API:Error Codes