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 resource for an individual job returns the asynchronous execution of an operation by a geoprocessing service. From this resource, you can cancel the job if its current status is SUBMITTED or EXECUTING (keeping the job information in the system), or delete the job regardless of its current status, which will remove all trace of it from the service and cancel the job if applicable.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| The unique ID of the job, which is used for its URL. |
| The time the job was submitted in milliseconds from epoch. |
| The time the job was completed, either as a failure or a success. |
| The current status of the job. Values: |
| The ArcGIS Server user who submitted the job. If the service is anonymous, this value is |
| The machine running the job. |
| The URL of the job's page in the ArcGIS Server Services Directory. This page displays all messages logged during the job execution. |
Example usage
The following is a sample request URL used to access an individual job resource:
https://organization.example.com/<context>/admin/services/Maps/Test.MapServer/jobs/j290c2d4e60364xx2a0c735fb9b68428a?f=pjsonJSON Response example
{
"jobId": "j290c2d4e60364xx2a0c735fb9b68428a",
"submittedTime": 1523033824000,
"endTime": 1523033841000,
"status": "esriJobSucceeded",
"username": null,
"machinename": "server.example.com",
"url": "https://organization.example.com/<context>/admin/services/Maps/Test.MapServer/jobs/j290c2d4e60364xx2a0c735fb9b68428a"
}