API index for REST Interface Integration
Test API
Call this to ensure REST api are properly responding
-->
/RDWebApi/api/service/test
Run API
Call this to run a process directly with ModernUI interface and login workflow
-->
/RDWebApi/api/service/run/[folder]/[processname]
PARAMETERS SYNTAX:
Process name without extension must be written in the uri path and must be available in Process folder
The response is a redirect to the configured RDWR render with all source parameters internally encoded
This call is not subject to Authorizaton, it will be performed by RDWR on the configured provider
StartProcess API
Call this GET or POST to execute a process using RAS on the server machine
-->
/RDWebApi/api/service/startprocess?ProcessName=
PARAMETERS SYNTAX:
ProcessName=[Folder\]process_name <----- Process file as exposed in Process RAS folder
AsyncMode=true <----- Optional, Run for web mode, return the url for loading the Web interface)
PostParam=name <----- Optional, Send POST body as a single string parameter with specific name
RasDebug=true <----- Run process using designer to allow debugging (Start RAS in User Mode)
RasBreak=true <----- Run process with a breakpoint to debug player (Visual Studio Debugger)
All other parameters are passed straight trough to the process as QueryParams (Par1=Val1&...&ParN=ValN)
If Authorization is required, only call having authorization bearer in header are accepted
REST Proxy Process API
Call this to execute a generic 'REST' method implemented as a proxy process without RAS (Rest license needed)
-->
/RDWebApi/api/service/process/[folder]/[processname]
PARAMETERS SYNTAX:
Process name without extension must be written in the uri path and must be available in Process folder
Process will always receive these parameters: Uri, Verb, Headers (as String[]), Request, Response (OUT)
If Request/Response parameters are strings will contain the JSON, if structured will serialize/deserialize
REST Processes should respond as quickly as possible, CAD libs are disabled by default (?CadLibs=false)
REST VERBS SYNTAX:
GET --> Process will receive QueryParams (no body request), will return generic a JSON Response
POST --> Process will receive QueryParams and a JSON body, will return a generic JSON Response
PUT --> Process will receive QueryParams and a JSON body, will return a generic JSON Response
CREATE --> Process will receive QueryParams and a JSON body, will return a generic JSON Response
DELETE --> Process will receive QueryParams, (no body request), will return a generic JSON Response