- URL:
- https://<root>/services/<serviceName>.<serviceType>/jobs/statistics
- Methods:
POST- Version Introduced:
- 10.6.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The statistics operation provides counts for the current number of asynchronous jobs for the geoprocessing service, as well as counts of those currently carrying the status of FAILED, SUCCEEDED, and CANCELLED. Jobs that have failed or succeeded will remain in the system until the server's jobs directory clears them out according to its user-defined cleanup interval.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| Gives the current count of all jobs being run by the geoprocessing service and jobs that have |
Example usage
The following is a sample POST request for the statistics operation:
POST /<context>/admin/services/System/PublishingTools.GPServer/jobs/statistics HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonJSON Response example
{
"total": 19,
"cancelled": 0,
"failed": 2,
"succeeded": 17
}