Delete Job Set Entity
Submits a request for a specific Job Set entity to be marked for deletion from the Server.
Request takes no content, and on success returns a response containing the result of the request for deletion (“true” or “false”).
Request
Method Type: |
POST |
---|---|
URI: | |
Content: | – |
Content Type: |
– |
Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Path
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
jobSetId |
– |
– |
– |
The ID of the Job Set entity in Server |
Response
Success
The following lists status codes indicative of a successful response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
200 OK |
Result of request for Job Set removal | text/plain | – | Deletion of Job Set successfully requested from Server (response of “true” for success or “false” for failure) |
Error
The following lists status codes indicative of a failed or error response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
401 Unauthorized |
– |
– |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication is required. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. |
401 Unauthorized |
Error message |
– |
– |
Server authentication has failed. Response when the authorization token specified in the request headers has now expired. |
403 Forbidden |
Error message |
– |
– |
Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid. |