Service Builders
- Service Builder Client
- Javascript Builder Client
- Extension Builder Client
- Plugin Builder
- Progressive Web App Builder
/OpenForum/AddOn/ServiceBuilder Sevice API Version 1.0.18
Get Actions
Action generateServiceConfig
Creates a service configuration from an existing service
Parameters
| Name | Description |
| pageName (required=true) | The page to create a config for |
| method (required=true) | The method to create a config for such as get or post |
| save (required=true) | Whether to save the generated config or just return it for viewing |
Example Get Request
/OpenForum/AddOn/ServiceBuilder?action=generateServiceConfigExample Response
Example Error Response
Action buildService
Creates a service from a configuration
Parameters
| Name | Description |
| pageName (required=true) | The config files page |
| fileName (required=true) | The config file |
| save (required=true) | Whether to save the generated service or just return it for viewing |
Example Get Request
/OpenForum/AddOn/ServiceBuilder?action=buildServiceExample Response
Example Error Response
Action buildJavascript
Build javascript library from parts defined in script file
Parameters
| Name | Description |
| pageName (required=true) | |
| fileName (required=true) |
Example Get Request
/OpenForum/AddOn/ServiceBuilder?action=buildJavascriptExample Response
Example Error Response
Action buildPlugin
Build an editor plugin
Parameters
| Name | Description |
| pageName (required=true) | |
| pluginInstanceName (required=false) | |
| pluginTitle (required=false) | |
| contentPage (required=false) | |
| scriptPage (required=false) | |
| pluginPage (required=false) | |
| contentFile (required=false) | |
| scriptFile (required=false) | |
| onLoad (required=false) | |
| pluginFile (required=false) |
Example Get Request
/OpenForum/AddOn/ServiceBuilder?action=buildPluginExample Response
Example Error Response
Post Actions
Action buildService
Build a service from a given config in json
Parameters
| Name | Description |
| config (required=true) | |
| save (required=true) |
Example Post Request
/OpenForum/AddOn/ServiceBuilder?action=buildServiceExample Response
Example Error Response
Action buildExtension
Build an OpenForum extension from a given config
Parameters
| Name | Description |
| config (required=true) | |
| save (required=true) |