Skip to main content

Version: 19.05 (EOL)

Groovy Service Invoke REST API

The Groovy Service Invoke REST API provides support for calling arbitary Groovy Services from external systems. This service endpoint can be used to perform operations such as uploading reference data for use in dynamic data or form prefill services.

Security

To enable Groovy Services to be invoked via this REST API, the service parameter REST Invoke Enabled service parameter must be enabled. By default, the service parameter is false, and it must be explicitly enabled.

To access the Groovy Service Invoke REST endpoint, the caller needs to be authenticated using HTTP Basic Authentication. The authenticated user needs a user account on the Journey Manager server, and this account needs to be active and have access to the Management Console module.

To be authorized to call this service, the user account also needs the Management Console permission REST Groovy Service Invoke.

If the user is not a global administrator, only services belonging to the organizations assigned to the user will be accessible.

The endpoint supports HTTP GET and POST operations, including file upload multipart POST requests.

Endpoint URL

The Groovy Service Invoke REST API endpoint URL is:

https://<JM_SERVER>/manager/secure/rest/groovy-service-invoke/v2/

Service operations

The Groovy Service Invoke REST API provides the following operations.