Inputs

Description

The inputs resource provides all the input parameters of an asynchronous job. Instead of querying each input parameter like the input parameter resource, the inputs resource provides all the input parameters, in the format of a list. See the Jobs resource for more information about an asynchronous geoprocessing job.

With the inputs resource, the value of each input is the same value as provided when submitting a job. See data types for the syntax of an input parameter.

To query an individual input parameter, see the input parameters resource.

Request parameter

For a job that does not have a succeeded status, such as a cancelled or failed job, there is no link or relative URL from the jobs resource; however you can construct the request manually in the format of https://machine.domain.com/webadaptor/rest/services/<ServiceName>/GPServer/<TaskName>/jobs/<jobID>/inputs. The request parameter above still applies.

Request example

For a MailingList task job, you can access the input parameters with the following URL:

Obtain all the inputs for the job with a job ID of jdb4cce48c464424e913c15c4f419b32a.

1
https://machine.domain.com/webadaptor/rest/services/Portland/ESRI_CadastralData_Portland/GPServer/MailingList/jobs/jdb4cce48c464424e913c15c4f419b32a/inputs

JSON Response syntax

The JSON response is a list of inputs. The syntax of each input is in the inputs parameter resource.

The response is a list.

1
2
3
4
5
6
7
8
9
10
[{
    "paramName" : "<parameter name 1>",
    "dataType" : "<data type 1>",
    "value" : <literal or object 1>
},
{
    "paramName" : "<parameter name 2>",
    "dataType" : "<data type 2>",
    "value" : <literal or object 2>
}]

JSON Response example

A sample response containing the two input parameters of a service.

1
2
3
4
5
6
7
8
9
10
11
12
13
[{
  "paramName": "Input_Linear_Unit",
  "dataType": "GPLinearUnit",
  "value": {
   "distance": 78,
   "units": "esriKilometers"
  }
 },
{
  "paramName": "Input_File",
  "dataType": "GPDataFile",
  "value": {"url": "https://machine.domain.com/input/file/trees.txt"}
 }]