Package com.aquima.web.api.controller.v1

Class WebFunctionController

java.lang.Object

com.aquima.web.api.controller.v1.AbstractBaseController

com.aquima.web.api.controller.v1.WebFunctionController

@ServerContext
@RestController("apiWebFunctionController")
@RequestMapping(produces="application/json")
public class WebFunctionController
extends AbstractBaseController

This controller is used for executing function flows that are exposed as a web function.

Since:

10.3

Author:

T. van der Griend.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FUNCTION_PATH
static final String	FUNCTION_START_PATH

Constructor Summary

Constructors

Constructor	Description
WebFunctionController(FunctionService functionService, com.blueriq.component.api.shortcut.function.IFunctionShortcutManager shortcutManager, com.blueriq.component.api.IAquimaEngineConfiguration config, ProductionProperties productionProperties, SessionHeadersProperties sessionHeadersProperties)

Method Summary

Modifier and Type	Method	Description
String	openApiFeed(String project, String version)
String	startFunctionFromPath(String project, String version, String module, String function, String jsonBody, org.springframework.http.HttpHeaders headers)
String	startFunctionFromRequestParams(String project, String version, String module, String function, String jsonBody, org.springframework.http.HttpHeaders headers)
String	startFunctionFromShortcut(String shortcutName, String jsonBody, String testPath, org.springframework.http.HttpHeaders headers)

Methods inherited from class com.aquima.web.api.controller.v1.AbstractBaseController

handleConversionException, handleDecisionTreeNotExposedException, handleEmptySymptomException, handleFlowEndedException, handleForbiddenException, handleFunctionParameterException, handleFunctionValidationException, handleFunctionValidationException, handleMethodArgumentTypeMismatchException, handleRequestWardException, handleStartApplicationForbiddenException, handleStartFlowForbiddenException, handleStartShortcutForbiddenException, handleUnauthorizedException, handleUnknownApplicationException, handleUnknownDecisionTreeException, handleUnknownFlowException, handleUnknownFunctionFlowException, handleUnknownLanguageException, handleUnknownModuleException, handleUnknownSessionException, handleUnknownShortcutException, handleUnknownSubscriptionException, handleUnsupportedOpenApiSpecException, isAuthenticated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FUNCTION_PATH

public static final String FUNCTION_PATH

See Also:

• Constant Field Values

FUNCTION_START_PATH

public static final String FUNCTION_START_PATH

See Also:

• Constant Field Values

Constructor Details

WebFunctionController

@Autowired
public WebFunctionController(FunctionService functionService,
 com.blueriq.component.api.shortcut.function.IFunctionShortcutManager shortcutManager,
 com.blueriq.component.api.IAquimaEngineConfiguration config,
 ProductionProperties productionProperties,
 SessionHeadersProperties sessionHeadersProperties)

Method Details

startFunctionFromRequestParams

@PostMapping(path="/api/v1/function",
             consumes="application/json")
public String startFunctionFromRequestParams(@RequestParam
 String project,
 @RequestParam
 String version,
 @RequestParam
 String module,
 @RequestParam
 String function,
 @RequestBody
 String jsonBody,
 @RequestHeader
 org.springframework.http.HttpHeaders headers)
                                      throws Exception

Throws:

Exception

startFunctionFromPath

@PostMapping(path="/api/v1/function/start/{project}/{version}/{module}/{function}",
             consumes="application/json")
public String startFunctionFromPath(@PathVariable
 String project,
 @PathVariable
 String version,
 @PathVariable
 String module,
 @PathVariable
 String function,
 @RequestBody
 String jsonBody,
 @RequestHeader
 org.springframework.http.HttpHeaders headers)
                             throws Exception

Throws:

Exception

startFunctionFromShortcut

@PostMapping(path="/api/v1/function/shortcut/{shortcutName}",
             consumes="application/json")
public String startFunctionFromShortcut(@PathVariable
 String shortcutName,
 @RequestBody
 String jsonBody,
 @RequestHeader(name="X-Blueriq-Test-Path",defaultValue="")
 String testPath,
 @RequestHeader
 org.springframework.http.HttpHeaders headers)
                                 throws Exception

Throws:

Exception

openApiFeed

@GetMapping("/api/v1/function/docs")
public String openApiFeed(@RequestParam("project")
 String project,
 @RequestParam("version")
 String version)