getJobDetails
The API getJobDetails returns the results of the specified job. Deprecated. See jobs.
Parameters
- jobId
- Required. The identifier of the job to retrieve. If the user does not supply a valid jobId, the server returns an appropriate error message as part of the return value.
Return value
Returns the SPXML string containing the results of the requested job. See Output SPXML string for more information.
Remarks
When you send an expression or function to the server for asynchronous or scheduled evaluation, the server immediately returns the results containing the jobId and status. Use the jobId to retrieve the job.
Note that the Administration Service API, the Expression Service API, and the Function Service API all contain getJobDetails functions that are identical. This design allows you to retrieve a job using only the API for that service.
An existing job can have a status of one of the following:
| Status | Code |
|---|---|
| interrupted | -2 |
| failed | -1 |
| waiting to start | 0 |
| running | 1 |
| done | 2 |
| done with error | 3 |
Deleted jobs are not considered existing jobs.
Example
The following link retrieves job 111 from the server.
http://servername:8080/SplusServer/api/v8/administration/getJobDetails?jobId=111