Skip to main content

Version: 24.04

PUT Update Service Definition

Put a JSON object describing an existing service definition to update its values.

Request​

HTTP request​

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

Parameters​

This request takes no parameters.

Request body​

You must pass in a service definition value object containing the new values.

Example​

Request
PUT https://transact.maguire.com/manager/secure/rest/service-definitions/v1/215
Request body
{
    "serviceName": "My Random Tracking Number",
    "versionNumber": 3,
    "serviceType": "Tracking Number",
    "description": "An updated version of the random tracking number service",
    "serviceTypeDefaultFlag": false,
    "activeFlag": true,
    "serviceParameters": [
      {
        "name": "numberLength",
        "description": "The length of the tracking number.",
        "type": "List",
        "bindParameterFlag": true,
        "unitTestFlag": false,
        "listValues": "4:4|5:5|6:6|7:7|8:8",
        "value": "8"
      },
      {
        "name": "characterValues",
        "description": "The list of character values to generate the random tracking number from.",
        "type": "String",
        "bindParameterFlag": true,
        "unitTestFlag": false,
        "value": "AEIOU"
      }
    ]

Response​

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

Example​

An example succcessful response is shown below.

{
  "id": 215,
  "serviceName": "My Random Tracking Number",
  "versionNumber": 3,
  "serviceType": "Tracking Number",
  "description": "An updated version of the random tracking number service",
  "serviceTypeDefaultFlag": false,
  "activeFlag": true,
  "jobTemplateFlag": false,
  "unitTestEnabledFlag": false,
  "clientName": "Maguire",
  "classnameBeanname": "com.avoka.fc.core.service.form.RandomTrackingNumberService",
  "createdAt": "Sep 30, 2015 4:08:51 PM",
  "createdBy": "someadmin",
  "lastModifiedAt": "Oct 1, 2015 10:27:19 AM",
  "lastModifiedBy": "someadmin",
  "serviceParameters": [
    {
      "id": 949,
      "name": "characterValues",
      "description": "The list of character values to generate the random tracking number from.",
      "type": "String",
      "bindParameterFlag": true,
      "unitTestFlag": false,
      "value": "AEIOU",
      "createdAt": "Sep 30, 2015 4:08:51 PM",
      "createdBy": "someadmin",
      "lastModifiedAt": "Oct 1, 2015 10:27:19 AM",
      "lastModifiedBy": "someadmin"
    },
    {
      "id": 950,
      "name": "numberLength",
      "description": "The length of the tracking number.",
      "type": "List",
      "bindParameterFlag": true,
      "unitTestFlag": false,
      "listValues": "4:4|5:5|6:6|7:7|8:8",
      "value": "8",
      "createdAt": "Sep 30, 2015 4:08:51 PM",
      "createdBy": "someadmin",
      "lastModifiedAt": "Oct 1, 2015 10:27:19 AM",
      "lastModifiedBy": "someadmin"
    }
  ]
}