The API
interrupt interrupts the specified job before it completes its run.
Return value
- jobId
- Required. The identifier of the job to interrupt. If the user does not supply a valid
jobId, the server returns an appropriate error message as part of the return value.
Returns an SPXML string containing true or false, in a
<value> tag, depending on the results of the request.
Remarks
The
jobId is a property of the SPXML results string and appears as follows:
<SplusDataResult hasReturnValue="true" hasTextOutput="true" hasError="false"
hasWarnings="false" created="Weds 14:56:47 PST 2019" jobId="27" status="2">
When you interrupt a job, it is assigned the status
-2.
Example
The following link cancels job 27 before it finishes.
http://servername:8080/SplusServer/api/v8/administration/interrupt?jobId=27
The return value appears as follows:
<JobAdminResult responseCode="0">
<JobIdsAffected>
<JobId>27</JobId>
</JobIdsAffected>
</JobAdminResult>
Copyright © TIBCO Software Inc. All rights reserved.