public interface ClientApi
A ClientApi enhances Component Plugins with the capability to execute code on the server with access to secured values
Client APIs are re-instantiated per request. Therefore, each call to
execute(ClientApiRequest, ExecutionContext) is on a new instance of the class.
Client APIs are immediately available once deployed. They do not require any additional configuration in Appian.
Do not include
TemplateId.majorVersion() when using
TemplateId annotation, otherwise the template will fail to upload. Versioning will be handled by modifying the
TemplateId.majorVersion() on the associated
ClientApiResponse execute(ClientApiRequest request, ExecutionContext executionContext)
request - A non-null
executionContext - Contains all of the contextual information needed to execute the Client API including User information, User locale, and proxy configuration.
Copyright © 2018-present Appian Corporation. All Rights Reserved.