GET Service Definition List

Return the list of service definitions ordered by service name and version number.

Request

HTTP request

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

Parameters

The table below shows the set of request parameters that can be used as additional search criteria. If multiple parameters are specified, all of them are applied to the result set.

Parameter	Description
activeFlag	Whether to filter on the active flag. Values: true, false
clientName	If set, only services for the given organization (by name) are returned.
id	A numeric parameter containing the service definition's database ID.
jobTemplateFlag	Whether to filter on the job template flag. Values: true, false
serviceName	A service name to match Note: The combination of service name and version number uniquely identifies a service.
serviceType	A service type to match. See Accessible Service Types for the set of accessible types.
unitTestEnabledFlag	Whether to filter on the unit test enabled flag. Values: true, false
versionNumber	A numeric value containing the version number to match Note: The combination of service name and version number uniquely identifies a service.

Request body

Do not supply a request body for this operation.

Example

GET https://transact.maguire.com/manager/secure/rest/service-definitions/v1/?serviceType=Form%20Version%20Selector&activeFlag=true

Response

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

Example

An example succcessful response is shown below.

[
  {
    "id": 1226,
    "serviceName": "A/B Testing Form Version Selector",
    "versionNumber": 1,
    "serviceType": "Form Version Selector",
    "description": "A service that selects the form version to render at random from the list of form versions",
    "serviceTypeDefaultFlag": false,
    "activeFlag": true,
    "jobTemplateFlag": false,
    "unitTestEnabledFlag": false,
    "classnameBeanname": "com.avoka.fc.core.service.form.RandomFormVersionSelectorService",
    "createdAt": "Jun 13, 2014 10:20:15 AM",
    "createdBy": "system",
    "lastModifiedAt": "Mar 4, 2015 3:58:17 AM",
    "lastModifiedBy": "medgar",
    "serviceParameters": [
      {
        "id": 1931,
        "name": "includedFormVersions",
        "description": "A comma separated list of form version numbers to include in selection. Leave blank to use all versions.",
        "type": "String",
        "bindParameterFlag": true,
        "unitTestFlag": false,
        "value": "3.0, 2.0",
        "createdAt": "Jun 13, 2014 10:20:15 AM",
        "createdBy": "system",
        "lastModifiedAt": "Mar 4, 2015 3:58:17 AM",
        "lastModifiedBy": "medgar"
      },
      {
        "id": 1932,
        "name": "ignoreFormVersionRequestParameter",
        "description": "Enable this parameter ignore the value of the 'tmFormVersion' request parameter.",
        "type": "boolean",
        "bindParameterFlag": true,
        "unitTestFlag": false,
        "value": "false",
        "createdAt": "Jun 13, 2014 10:20:15 AM",
        "createdBy": "system"
      }
    ]
  },
  {
    "id": 1206,
    "serviceName": "Current Version Selector",
    "versionNumber": 1,
    "serviceType": "Form Version Selector",
    "description": "This service returns the current form version, or (if specified) uses the request parameter 'tmFormVersion' to look up a specific version.",
    "serviceTypeDefaultFlag": true,
    "activeFlag": true,
    "jobTemplateFlag": false,
    "unitTestEnabledFlag": false,
    "classnameBeanname": "com.avoka.fc.core.service.form.CurrentVersionSelectorService",
    "createdAt": "Jun 11, 2014 3:13:31 PM",
    "createdBy": "system",
    "lastModifiedAt": "Feb 11, 2015 3:12:49 PM",
    "lastModifiedBy": "someadmin",
    "serviceParameters": [
      {
        "id": 1911,
        "name": "ignoreFormVersionRequestParameter",
        "description": "Enable this parameter to always use the current form version, regardless of the value of the 'tmFormVersion' request parameter.",
        "type": "boolean",
        "bindParameterFlag": true,
        "unitTestFlag": false,
        "value": "false",
        "createdAt": "Jun 11, 2014 3:13:31 PM",
        "createdBy": "system"
      }
    ]
  }
]