Administration tasks

The URL API is most useful for checking server health and performing simple administrative tasks, such as checking for server information, getting the server time and name, interrupting jobs, and deleting jobs if the job list gets too long. For example:

http://servername:port/service_name/api/v8/administration/getServerTime

This call returns the time on the server, in milliseconds, since epoch.

 <value>1265419799119</value>

If you need to interrupt a job that is on the server, use the following example construction.

http://servername:port/service_name/api/v8/administration/interrupt?jobId=1520

If the request was successful, the returned XML appears as follows.

 <JobAdminResult responseCode="0">
<JobIdsAffected>
<JobId>1520</JobId>
</JobIdsAffected>
</JobAdminResult>

Likewise, if you need to delete a job that is on the server, use the following example construction.

http://servername:port/service_name/api/v8/administration/delete?jobId=1520

If the request was successful, the returned XML appears as follows.

 <JobAdminResult responseCode="0">
<JobIdsAffected>
<JobId>1520</JobId>
</JobIdsAffected>
</JobAdminResult>