"Receive REST Request" Activator

Activates the plan upon receiving a REST API request.

Enabled

Enables/disables the activator.

Server

Allows to select the HTTP server used to process the requests.

OpenAPI Description

Allows to select the API interface to expose.

Operation

Allows to select the operation to implement.

Service Path

Allows to select the URL fragment (and therefore the request handler) associated with the service to expose.

Service Path / Add

Allows to add a request handler and its associated URL fragment.

Request Handler

Allows to view/modify (deletion can be done from the HTTP server resource) the selected request handler.

(Plan Input)

Provides the operation input data. The data type depends on the signature of the selected operation.

(Output Plan)

Allows you to specify the operation output data. The data type depends on the signature of the selected operation.

NOTE: To provide in the HTTP response, an error that is defined in the API description, you must throw an exception (see Fail) of the type specified in the OpenAPI description resource (click on: General/Structure/Operation/Response(s)...).