svc-delete
The svc-delete
task deletes the specified service definition on a remote Transact Manager server.
This task may be useful when you need to remove a service which is not working on a Transact Manager server.
Task Attributes
All attributes are optional unless otherwise indicated.
Attribute | Description |
---|---|
src | String The service definition file or root source folder. Note: Either |
name | String The name of the service to remove. Note: Either |
version | String The service version number. |
url | String Required. The TM server URL. |
username | String Required. The TM server login username. |
password | String Required. The TM server login password. |
proxyFile | String Required. HTTP proxy configuration properties file location. |
TM Security
To use this task, the user specified by username
needs an active user account on the TM server with 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 application packages belonging to the organizations assigned to the user will be accessible.
Example
The example Ant task below deletes a service definition on a remote TM server.
<svc-delete name="TrackMe DD"
version="2.0"
clientCode="mycorp"
url="https://form.mycorp.com/manager/"
username="[email protected]"
password="password" />
Example Ant log output:
test-remote:
[svc-delete] Request: DELETE https://form.mycorp.com/manager/secure/rest/service-definitions/v1/TrackMe DD/2 HTTP/1.1
[svc-delete] Success: {
[svc-delete] "serviceName": "TrackMe DD",
[svc-delete] "versionNumber": 2.0,
[svc-delete] "testStatus": "Success",
[svc-delete] "message": "Test succeeded in 32 ms"
[svc-delete] }
This example is the same as the previous one, except it specifies the service to delete by src
instead of name
.
<svc-delete src="src/trackme-dd/service-def.json"
version="2.0"
clientCode="mycorp"
url="https://form.mycorp.com/manager/"
username="[email protected]"
password="password" />