REST API:exec Resource
From AgileApps Support Wiki
Revision as of 23:06, 13 March 2014 by imported>Aeric
Provides the ability to execute a class method using the REST API.
- Considerations
-
- A Class must be defined. (The exec resource invokes a method in the class.)
- An instance of the class is created automatically, so the method need not be static.
- Whether passed in XML or JSON, parameters passed to the method in the <execClass> segment must consist of a flat structure, as in the example that follows. (The structure is converted to a HashMap, so it cannot contain any complex elements or attributes.)
- Signatures:
- The method must be public
- The method can either take no arguments: public methodName()
- Or it take arguments passed in a Map: public methodName(Map params)
(Parameters passed in the Request are wrapped in a Map, and passed to the method.)
- Signatures:
- Return Types:
- A method may return void.
- If the return type is a Map, it can be used to return key-value pairs.
- It can also return a Result object, in which case the value is automatically converted to a string using result.toString().
- Return Types:
- Method
- POST
- URI
- https://{yourDomain}/networking/rest/class/operation/exec
- Request
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<execClass> <clazz>fully.qualified.JavaClassName</clazz> <method>methodName</method> ...optional list of additional parameter tags like these... <firstName>Peter</firstName> <lastName>Smith</lastname> </execClass>
</platform> </syntaxhighlight>
- (Note that the items in the <execClass> tag form a flat structure.)
- Response
- When the return value is a Map, it contains the key/value pairs are those returned by the method.
- When the return value is converted to a string, the response looks like this:
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<execClass>
<result>...result-string here...</result>
</execClass>
<message>
0
<description>Success</description>
</message>
</platform> </syntaxhighlight>
- Known issue
- Null return values are not handled at this time.