Service Definition and Service Parameter JSON

The POST and PUT operations work with service definition and parameter JSON value objects. Examples are included in the documentation for the relevant Service Definition REST API operations.

Service Definition

Attribute	Description
activeFlag	Boolean Whether the service is active and usable.
classnameBeanname	String The name of the Java class/bean implementing the service.
clientName	String The name of the organization with which the service is associated. Note: This value cannot be changed once a service has been created.
clientCode	String An organization's unique client code.
createdAt	Date The service creation date. This parameter is ignored during updates as Journey Manager maintains these attributes.
createdBy	String The user who created the service. This parameter is ignored during updates as Journey Manager maintains these attributes.
description	String A description of the service, visible to administrators.
id	Long The database ID identifying the service. You should not need to set this in your POST and PUT calls. However, it is important to use the IDs returned by a GET call, as the service ID is used in URLs. Note: Do not use the ID across sessions as database IDs may change beacuse, for example, services may get recreated or database backups restored.
jobTemplateFlag	Boolean Whether the service contains a job template.
lastModifiedAt	Date The date that the service was last modified. This parameter is ignored during updates as Journey Manager maintains these attributes.
lastModifiedBy	String The user who last modified the service. This parameter is ignored during updates as Journey Manager maintains these attributes.
serviceName	String The name identifying the service (required for new services). Note: Name and version number together uniquely identify a service.
serviceParameters	List of Service Parameter The list of service parameter value objects.
serviceType	String The service type; for example, "Dynamic Data". Note: This value is required for new services but cannot be changed later.
serviceTypeDefaultFlag	Boolean Whether the service is the default service for its type.
tmMinVersion	String The minimum Journey Manager version required to support the service.
unitTestEnabledFlag	Boolean Whether the service is set up for unit testing.
versionNumber	Integer The version number; for example, 1 (required for new services). Note: Name and version number together uniquely identify a service.

Service Parameter

Attribute	Description
bindParameterFlag	Boolean Whether the service parameter name corresponds to a property on the service class and should be set automatically by Journey Manager. Note: If you use this flag incorrectly, your service will not work. Turn this flag on only if the service class has a setter method corresponding to the parameter name.
clearOnExportFlag	Boolean Whether the parameter value should be cleared when exported from a system to protect security credentials.
createdAt	Date The date the service parameter was created. This parameter is ignored during updates as Journey Manager maintains these attributes.
createdBy	String The user who created the service parameter. This parameter is ignored during updates as Journey Manager maintains these attributes.
description	String A description of the service parameter, visible to administrators.
id	Long The database ID identifying a service parameter. You should not need to set this in your POST and PUT calls. However, it is important to use the IDs returned by a GET call, as the service parameter ID is used in URLs. Note: Do not use the ID across sessions as database IDs may change; for example, because services may get recreated, or database backups restored.
lastModifiedAt	Date The date that the service parameter was last modified. This parameter is ignored during updates as Journey Manager maintains these attributes.
lastModifiedBy	String The user who last modified the service parameter. This parameter is ignored during updates as Journey Manager maintains these attributes.
listValues	String For a service parameter of type "List", this parameter contains the possible values that can be assigned to the parameter. The values are formatted as a pipe-separated list, with each value followed optionally by a colon and a display name. For example, listValues for a parameter controlling expiry might be: "0:Never|1:1 day|3:3 days|7:1 week|365:1 year"
name	String Required. The name identifying the service parameter. Parameter names are unique within a service.
readonlyFlag	Boolean Whether the service parameter is read-only and, hence, cannot be modified in Journey Manager.
requiredFlag	Boolean Whether the service parameter must have a value before a service object can be created.
unitTestFlag	Boolean Whether the service parameter is used for unit testing.
type	String The type of values that can be assigned to the service parameter. This must be one of the following. "Boolean": "true" or "false" "Date": A date/time value. "Email": A valid-format email address. "Groovy Script": Basically a string, but Journey Manager provides a specialized Groovy editor. "HTML" "JSON" "List": The value is a string. The set of possible values is defined in the listValues parameter. "Number" "Password": A password. Journey Manager will not display the value. "String"
value	String The value assigned to the service parameter. The value must conform to the service parameter type.