Job | ArcGIS REST APIs | Esri Developer

URL:: https://<root>/jobs/<jobid>
Methods:: GET
Version Introduced:: 10.9.1

Access requirements

Required privileges

The Enterprise 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.

Publisher role Update Delete Security and infrastructure

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise 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 generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

This resource returns the progress and status messages of an asynchronous job. Updated progress information can be acquired by periodically querying this operation.

Job statuses

The status of a job is returned in the status property in the job's JSON representation. The following table lists the possible statuses a job can have:

Status	Description
`SUBMITTED`	The job has been submitted. This is the initial status of every job.
`EXECUTING`	The job is currently executing.
`CANCELLING`	The job is currently cancelling. Jobs that are being rolled back will have this status.
`CANCELLED`	The job has been cancelled.
`FAILED`	The job has failed. More information about the failure is available in the response's `result` property.
`COMPLETED`	The job has completed. More information about the completion is available in the response's `result` property.
`UNAVAILABLE`	The job status is unavailable at this time.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample request URL used to access an individual job resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/jobs/j2bcbcd49-83a4-4cc1-a034-40e4a266e96d?f=pjson

JSON Response examples

The sample response below is an example of an initial query to the job resource after an asynchronous operation was initiated. While a job is still in progress, the job's status will return EXECUTING.

Use dark colors for code blocksCopy
{
  "updatedtime": 1635961542589,
  "jobid": "j2bcbcd49-83a4-4cc1-a034-40e4a266e96d",
  "requestID": "e158254a-45e1-46b3-aea6-7325397be414",
  "endtime": 0,
  "starttime": 1635961542583,
  "operationURI": "/<context>/admin/services/FireWatchWeather.MapServer/edit",
  "status": "EXECUTING",
  "username": "serviceAdmin"
}

The sample response below is an example of a successful asynchronous operation, returning a status of COMPLETED. This final JSON response returns the full GIS service JSON object and associated job information, such as the job's jobid, as well as its starttime and endtime.

Use dark colors for code blocksCopy
{
  "result": {
    "service": {
      "allowedUploadFileTypes": "",
      "private": false,
      "maxUsageTime": 600,
      "description": "Updating description using the edit operation, run asynchronously",
      "maxInstancesPerNode": 2,
      "minInstancesPerNode": 1,
      "datasets": [],
      "type": "MapServer",
      "frameworkProperties": {},
      "instancesPerContainer": 1,
      "recycleStartTime": "00:00",
      "maxUploadFileSize": 0,
      "provider": "ArcObjects11",
      "clusterName": "default",
      "deploymentId": "kx21q2lis4z5beekzep0k",
      "id": "sckomokcru548qo27uhde",
      "maxStartupTime": 300,
      "capabilities": "Map,Query,Data",
      "maxWaitTime": 60,
      "recycleInterval": 24,
      "maxIdleTime": 180,
      "serviceName": "FireWeatherWatch",
      "loadBalancing": "ROUND_ROBIN",
      "keepAliveInterval": -1,
      "configuredState": "STOPPED",
      "isDefault": false,
      "extensions": [
        {
          "allowedUploadFileTypes": "",
          "capabilities": "GetCapabilities,GetFeatureInfo,GetLegendGraphic,GetMap,GetSchemaExtension,GetStyles",
          "maxUploadFileSize": 0,
          "typeName": "WMSServer",
          "enabled": "true",
          "properties": {
            "name": "SampleWorldCities",
            "title": "WMS"
          }
        },
        {
          "allowedUploadFileTypes": "",
          "capabilities": "SingleImage,SeparateImages,Vectors",
          "maxUploadFileSize": 0,
          "typeName": "KmlServer",
          "enabled": "true",
          "properties": {
            "compatibilityMode": "GoogleEarth",
            "useDefaultSnippets": "true",
            "featureLimit": "1000000",
            "minRefreshPeriod": "30",
            "imageSize": "1024",
            "dpi": "96"
          }
        },
        {
          "allowedUploadFileTypes": "",
          "capabilities": "Create,Query,Update,Delete,Uploads",
          "maxUploadFileSize": 0,
          "typeName": "FeatureServer",
          "enabled": "false",
          "properties": {}
        }
      ],
      "isolationLevel": "HIGH",
      "folderName": "",
      "properties": {
        "useLocalCacheDir": "true",
        "outputDir": "/arcgisusr/directories/arcgisoutput",
        "cacheDir": "/arcgisusr/directories/arcgiscache",
        "maxScale": "4000",
        "filePath": "/arcgis/framework/etc/data/WorldCities/WorldCities.msd",
        "maxRecordCount": "1000",
        "supportedImageReturnTypes": "MIME+URL",
        "clientCachingAllowed": "true",
        "isCached": "false",
        "virtualOutputDir": "/rest/directories/arcgisoutput",
        "maxExportTilesCount": "100000",
        "ignoreCache": "false",
        "exportTilesAllowed": "false",
        "outputStore": "{...}",
        "cacheOnDemand": "false",
        "minScale": "295000000",
        "serviceId": "sckomokcru548qo27uhde"
      },
      "portalProperties": {
        "isHosted": false,
        "portalItems": [
          {
            "itemID": "79b641d2e7234b898cb56313d44a41f4",
            "type": "WMSServer"
          }
        ]
      }
    }
  },
  "updatedtime": 1635961402579,
  "jobid": "j47c0c626-7188-4053-be06-ae93de987b01",
  "requestID": "85bb7121-116d-4f49-b0d1-347c02038c9a",
  "endtime": 1635961402584,
  "starttime": 1635961389632,
  "operationURI": "/<context>/admin/services/FireWeatherWatch.MapServer/edit",
  "status": "COMPLETED",
  "username": "serviceAdmin"
}

The sample response below is an example of an asynchronous operation with tracked progress. For certain operations that take a longer time to run like editContainerRegistry, the response will include a progress JSON object to provide more information on the status of each stage of the operation.

Use dark colors for code blocksCopy
{
  "progress": {"stages": [
    {
      "name": "validating",
      "state": "completed"
    },
    {
      "name": "relational_store",
      "state": "completed"
    },
    {
      "name": "object_store",
      "state": "completed"
    },
    {
      "name": "spatio_temporal_index_store",
      "state": "completed"
    },
    {
      "name": "queue_store",
      "state": "completed"
    },
    {
      "name": "in_memory_store",
      "state": "completed"
    },
    {
      "name": "key_framework_components",
      "state": "completed"
    },
    {
      "name": "gis_services_and_other_components",
      "state": "completed"
    }
  ]},
  "messages": [],
  "resource": {"name": "default (id: eb375m8hmnhzqf6q61yjn)"},
  "name": "editContainerRegistry",
  "updatedtime": 17589149904641,
  "jobid": "sc28aabe5-a5a5-4a3f-8fee-ccd4e3e8be4c",
  "requestID": "e158554a-45e1-46b3-aea6-7325197ae404",
  "endtime": 1758914997566,
  "starttime": 1758914989459,
  "operationURI": "/<context>/admin/system/containerregistries/<registryID>/edit",
  "result": {"credentialUpdateOnly": true},
  "status": "COMPLETED",
  "username": "serviceAdmin"
}