Skip to main content

Version: 24.04

Service Definition REST API

The Service Definition REST API provides a REST service for querying and modifying service definitions defined in Journey Manager in a secure and efficient manner.

Security​

To access the Service Definition 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 the service the user account also needs the Management Console permission REST Service Definitions API.

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

Endpoint URL​

The Service Definition REST API endpoint URL is:

https://<JM_SERVER>/manager/secure/rest/service-definitions/v1/

Accessible service types​

The Service Definition REST API allows you to access the following service types:

  • All services in ServiceDefinition.GROOVY_SERVICE_TYPES
  • Job Controller

Service operations​

This Service Definition REST API provides the following operations.