Job | ArcGIS REST APIs | Esri Developer

URL:: https://<root>/jobs/job/<jobId>
Methods:: GET
Version Introduced:: 12.0

Description

The resource endpoint for a specific job that is either completed or currently running. This endpoint contains information about each step that was performed. If a failure occurs, administrators can note on which step the job failed.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The output format for this operation. The default value is `html`. Values: `html` \| `json` \| `pjson`
`token` (Required)	Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

f

(Required)

The output format for this operation. The default value is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com:21443/arcgis/rest/jobs/job/jbd104d76-9e2b-48cd-a9f9-487126902b6e?f=pjson&token=<token>

JSON Response syntax

Use dark colors for code blocksCopy
{
  "jobId": "<jobId>",
  "inputs": {
    "serviceItemId": "<itemId>",
    "requestedResolutions": "sd | hd | fhd | uhd",
    "fileIds": "<fileId>",
    "serviceUrl": "https://organization.example.com/video/rest/services/serviceName/VideoServer"
  },
  "messages": [
    "<Steps that have run up to this point>"
  ],
  "type": "Job Type",
  "results": {
    "layerId": 0,
    "layerName": "layerName",
    "serviceName": "serviceName"
  },
  "status": "In Progress | Completed",
  "username": "<username of the user who ran the job>",
  "customAttributes": {
    "messageCodes": "[any relevant message codes]",
    "savingToStorage": true | false,
    "newLayerId": "<new layerId as an integer>"
  }
}

JSON Response example

Use dark colors for code blocksCopy
{
  "jobId": "j1b81346f-1460-482a-94f0-72b78ee843e5",
  "inputs": {
    "serviceItemId": "f17630387bee47b88fe001f7875eb18a",
    "requestedResolutions": "fhd",
    "fileIds": "ib8abf0cb-8739-48b0-9db5-a8547d1139aa",
    "serviceUrl": "https://organization.example.com/video/rest/services/Cheyenne_TS/VideoServer"
  },
  "messages": [
    "Starting Ingest",
    "Probing Video Codec",
    "Probing Audio",
    "Probing Video Klv",
    "Generating Video Stream Info",
    "Generating Video Info",
    "Transcoding with GPU",
    "Extracting KLV Metadata",
    "Generating HLS Service Files",
    "Generating Poster Image",
    "Generating Preview Images",
    "Generating ABR Info Files",
    "Removing Temporary Files",
    "Video Files Created",
    "Saving To Storage",
    "Ingest Complete"
  ],
  "type": "Publish Streaming Service",
  "results": {
    "layerId": 0,
    "layerName": "Cheyenne_TS",
    "serviceName": "Cheyenne_TS"
  },
  "status": "COMPLETED",
  "username": "portaladmin",
  "customAttributes": {
    "messageCodes": [117, 154, 155, 156, 157, 158, 159, 160, 161, 174, 182, 162, 163, 205, 206, 118],
    "savingToStorage": true,
    "newLayerId": 0
  }
}