$singleton

Definition

You can directly call exposed functions of your shared singletons through REST.

Singleton functions are called in POST or GET requests with the $singleton command and without (). For example, if you have defined a buildVehicle() function in the VehicleFactory shared singleton class, you could call it using the following request:

/rest/$singleton/VehicleFactory/buildVehicle

with data in the body of the POST request: ["truck"]

In QodlyScript language, this call is equivalent to:

singleton = cs.VehicleFactory.me.buildVehicle("truck")

note

Keep in mind that only functions with the exposed keyword can be directly called from REST requests.

Function calls

Singleton functions can be called using REST POST or GET requests.

The formal syntax is:

POST request

/rest/$singleton/SingletonClass/SingletonClassFunction

with data in the body of the POST request: ["myparam"]

GET request

/rest/$singleton/SingletonClass/SingletonClassFunction?$params='["myparam"]'

note

The SingletonClassFunction() function must have been declared with the onHttpGet keyword to be callable with GET (see function prerequisites).

info

You can restrict calls to specific singleton functions by configuring appropriate permissions.

Parameters

You can send parameters to singleton functions. On the server side, they will be received in the declared parameters of the singleton class functions.

Sending parameters to singleton functions is exactly the same as sending parameter to ORDA class functions. Please refer to the Function Parameters page for a detailed description.

Example

You have created a simple shared singleton with an exposed function:

//class mySingleton

shared singleton constructor()

exposed function sayHello (value : string)
	return "Hello "+value

note

The mySingleton class and sayHello function are listed when you call the $catalog command.

You can then run this request:

POST /rest/$singleton/mySingleton/sayHello

Body of the request: ["John"]

Response

{
	"result": "Hello John"
}