Skip to main content

Version: 23.10

POST Invoke Groovy Service

Invoke the specified service and return the results of the Groovy Service invocation. All Groovy Service invocations are recorded in the Groovy Service Log.

All groovy service invocations must be performed using a HTTP POST or a multipart POST operation. This follows the REST architectural pattern of not performing state changes when making HTTP GET requests.

info

The Groovy Service Invoke REST API Overview provides an introduction to this REST API, including information about:

  • Security (authentication and authorization)

Request​

HTTP request​

The service name is normalized to avoid any URL encoding issues. Use the service URL values provided in a GET Groovy Service List operation's response.

POST https://<JM_SERVER>/manager/secure/rest/groovy-service-invoke/v2/<NORMALIZED_CLIENT_CODE>/<NORMALIZED_SERVICE_NAME>/<VERSION_NUMBER>/

Parameters​

This request takes no parameters.

Request body​

Any request parameters should be URL form encoded in the request body.

caution

Don't add request parameters to the POST URL as they will not be resolved.

Binary files can be uploaded to the services using multipart POST. This is particularly useful for loading reference data, such as Excel or CSV data. Any uploaded files will be made available as Apache Commons FileUpload FileItem objects.

Example​

POST https://transact.maguire.com/manager/secure/rest/groovy-service-invoke/v2/maguire/product-catalog-loader/v1/

Response​

If successful, this operation returns a response with a HTTP 200 OK status code.

The response content is the content returned by the invoked Groovy Service. For example: 

Product Catalog Loaded