API Actions

Version 23.4.8839


API Actions


Use actions to extend the set of operations on resources and to execute unrelated actions on the server. Actions must be executed as an HTTP POST request. The following is an example action invocation:

POST http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/WashCar/
{
  Wax: "Wax_1"
}

Here is the corresponding response:

{"Complete": "Complete_1"} 

Use URL Parameters as Input

In cases where the client does not support the HTTP POST method, you can invoke the Action using the URL parameters @x-http-method. The inputs for the Action can then be specified as additional URL parameters. For example:

http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/WashCar?@x-http-method=POST&URLparam1=my\_url\_parameter1&urlparam2=my\_url\_param2