Difference between revisions of "REST API:execSQL Resource"

From LongJump Support Wiki
imported>Aeric
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:'' REST API [[REST API#Conventions and Considerations|Conventions and Considerations]].
:''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===
===Permissions===

Revision as of 01:57, 17 November 2011

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

Learn more: REST API Conventions and Considerations.

Permissions

__TBD: Are the permission(s) right?__

Lock-tiny.gif

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
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.

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

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>N</recordCount>      <!-- Number of records returned by the query -->
</platform>
See also: REST API:Error Codes