Jobs
Click here for a complete list of operations.
CancelJob
Schedules a non-quick job for cancellation. Has no effect on quick jobs.
Users may only cancel jobs they own, otherwise an exception is thrown.
This method does nothing and returns nothing if jobid is not an actual job.
Otherwise, this method returns once the status of the specified job has changed to 'Canceling' (int = 2).
Note that a job is not completely cancelled until the status of that job is 'Cancelled' (or 'Failed'); until then it still consumes a queue slot.
Transition from 'Canceling' to 'Cancelled' is an internal operation and is not controlled though web services.
This method returns nothing on success.
Parameters:
long wsid : WebServicesID of the account the cancellation will be run under.
string pw : Password of said account
long jobId : Identifier of the job to cancel
Output:
Void
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /gcasjobs/services/jobs.asmx HTTP/1.1
Host: mastweb.stsci.edu
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://Services.Cas.jhu.edu/CancelJob"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CancelJob xmlns="http://Services.Cas.jhu.edu">
<wsId>long</wsId>
<pw>string</pw>
<jobId>long</jobId>
</CancelJob>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CancelJobResponse xmlns="http://Services.Cas.jhu.edu" />
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /gcasjobs/services/jobs.asmx HTTP/1.1
Host: mastweb.stsci.edu
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelJob xmlns="http://Services.Cas.jhu.edu">
<wsId>long</wsId>
<pw>string</pw>
<jobId>long</jobId>
</CancelJob>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CancelJobResponse xmlns="http://Services.Cas.jhu.edu" />
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /gcasjobs/services/jobs.asmx/CancelJob?wsId=string&pw=string&jobId=string HTTP/1.1 Host: mastweb.stsci.edu
HTTP/1.1 200 OK
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /gcasjobs/services/jobs.asmx/CancelJob HTTP/1.1 Host: mastweb.stsci.edu Content-Type: application/x-www-form-urlencoded Content-Length: length wsId=string&pw=string&jobId=string
HTTP/1.1 200 OK