RESTfulWebService

The RESTfulWebService interface represents an RESTful Web Service. A RESTful Web Service is a special type of form that can only be executed via a REST call. It does not have any displayable elements such as pages, controls, lists etc.

Further documentation.

RESTfulWebService Functions

getRest RESTfulWebService.getRest( ) Returns the RESTful functions available to the RESTful Web Service

BaseForm Functions

abort RESTfulWebService.abort( message ) Aborts execution of the current form, integration service or workflow node and rolls back the current transaction.
getAbortMessage RESTfulWebService.getAbortMessage( ) Returns the abort message after a failure has occurred.
getFields RESTfulWebService.getFields( ) Returns the Fields object that gives access to all fields available to the form.
getLanguage RESTfulWebService.getLanguage( ) Returns the language code for the user session.
setLanguage RESTfulWebService.setLanguage( language ) Sets the language code for the user session.
getResources RESTfulWebService.getResources( ) Returns the Resources object that gives access to all resources available to the form.
getTables RESTfulWebService.getTables( ) Returns the Tables object that gives access to all tables available to the form.
getTexts RESTfulWebService.getTexts( ) Returns the Texts object that gives access to all texts available to the form.
getTimezone RESTfulWebService.getTimezone( ) Returns the time zone used for the form.
setTimezone RESTfulWebService.setTimezone( timezone ) Sets the time zone for the current form, service or workflow process.

Element Functions

getElementName RESTfulWebService.getElementName( ) Returns the element name
getElementType RESTfulWebService.getElementType( ) Returns the element type