Skip to main content

Version: 23.10

DELETE Service Parameter

Irrevocably delete a service parameter.

danger

Use this operation with caution. It is not reversible.

Request​

HTTP request​

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

Parameters​

This request takes no parameters.

Request body​

Do not supply a request body for this operation.

Example​

DELETE https://transact.maguire.com/manager/secure/rest/service-definitions/v1/215/serviceParameters/953

Response​

If successful, this operation returns a response with a HTTP 200 OK status code. The response contains the updated service definition and the remaining parameters.

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 11:43:21 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"
    }
  ]
}