delete

The API delete removes the specified job from the server.

Parameters

jobId: Required. The identifier of the job to delete. If the user does not supply a valid jobId, the server returns an appropriate response code as part of the return value.

Return value

Returns an SPXML string containing a response code and the jobId.

Remarks

The jobId is a property of the SPXML results string and appears as follows:

<SplusDataResult version ='1.0' hasReturnValue ='true' hasTextOutput ='true' hasError ='false' hasWarnings ='false' 
createdBy ='nobody' created ='Weds Mar 6 14:33:12 PDT 2019' scheduled ='Weds Mar 6 14:33:12 PDT 2019' createdMillis ='1348522392341' 
scheduledMillis ='1348522392341' jobId ='25' status ='2' engineTime ='27' serverTime ='37' queuedTime ='4' 
serverInstance ='myserver'>

Example

The following link removes from the server the job 25.

http://servername:8080/SplusServer/api/v8/administration/delete?jobId=25

The SPXML appears as follows:

<?xml version="1.0" encoding="UTF-8" ?> 
- <JobAdminResult responseCode="0"> 
   - <JobIdsAffected> 
       <JobId>25</JobId>  
     </JobIdsAffected> 
</JobAdminResult>

The next time you send a request for jobs, the deleted job should not appear on the list. If it still appears, refresh your browser to clear the cache.