AgileApps Support Wiki

Difference between revisions of "REST API:execSQL Resource"

From AgileApps 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:''
:* [[SQL Syntax ]]
:* REST API [[REST API#Conventions and Considerations|Conventions and Considerations]].


:''Learn more:'' REST API [[REST API#Conventions and Considerations|Conventions and Considerations]].
{{TBD|<br/>
 
{{Note|Use this structure the same way you use the structure for man pages:<br/>Follow the presentation pattern, but if a section isn't needed, don't include the header.<br/>Also:
# Add an entry to the [[REST API:REST API CheatSheet|REST API CheatSheet]]
# 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]] (categorized) page
# Add an entry to the [[REST API:REST Resources (alphabetical)|REST Resources]] page
# Add an entry to the [[REST API:REST Resources (alphabetical)|REST Resources]] page
}}
}}
===Requirements===
:* Requirement #1
:* Requirement #2


===Permissions===
===Permissions===
Line 19: Line 16:


===Execute an SQL Query===
===Execute an SQL Query===


;Method:GET
;Method:GET
Line 43: Line 41:
</platform>
</platform>
</syntaxhighlight>
</syntaxhighlight>
where:
:* The column names are the columns from the queried rows, or their aliases.


:See also: [[REST API:Error Codes]]
:See also: [[REST API:Error Codes]]

Revision as of 01:38, 16 November 2011

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

Learn more:

__TBD:

  1. Add an entry to the REST API CheatSheet
  2. Add an entry to the REST API (categorized) page
  3. Add an entry to the REST Resources page

__

Permissions

__TBD: Are the permission(s) right?__

Lock-tiny.gif

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
<platform>
    <execSQL>
        <id>...</id>
        <field>data</field>
         ...
    </execSQL>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>N</recordCount>      <!-- Number of __ records returned -->
</platform>

where:

  • The column names are the columns from the queried rows, or their aliases.
See also: REST API:Error Codes
Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=REST_API:execSQL_Resource&oldid=15793"