| FRAMES | NO FRAMES | Description | Parameters | Examples | Response |
| URL | http://<job-url>/update |
|---|---|
| Parent Resource | Job |
Note: When a feature service data workspace is used for the job, the parent version can only be set to sde.Default.
| Parameter | Details |
|---|---|
| f | Description: The response format. The default response format is html. Values: html | json |
| user | Required Description: The username of the client. |
| properties | Description: A JSON object containing the
job property values to update. When specified, this parameter overrides all other job property parameters. This parameter should be used instead of the individual job property parameters above since it more reliably supports setting a job property to a null/empty value. This parameter is supported from 10.1 onwards. Syntax:
{
"name": "<jobName>",
"startDate": <timeInstant>,
"dueDate": <timeInstant>,
"priority": <priorityValue>,
"status": <statusId>,
"parentJobId": <parentJobId>,
"dataWorkspaceId": "<dataWorkspaceId>",
"parentVersion": "<parentVersionName>",
"versionName": "<jobVersionName>",
"description": "<description>",
"ownedBy": "<ownedByUsername>",
"assignedType": <assignedType>, // Valid values: 0 (unassigned), 1 (user), 2 (group)
"assignedTo": "<assignedTo>",
"percent": <percentage>,
"aoi": <polygon>,
"poi": <multipoint> // added at 10.4
}
|
| name | Description: A new name for the job. |
| startDate | Description: The date on which the job is scheduled to begin.
Syntax: startDate=<timeInstant>Example: startDate=1230768000000 (1 Jan 2009 00:00:00 GMT)
|
| dueDate | Description: The date on which the job is scheduled to be complete.
Syntax: dueDate=<timeInstant>Example: dueDate=1230768000000 (1 Jan 2009 00:00:00 GMT)
|
| priority | Description: The numeric priority value. |
| status | Description: The numeric ID of the job's new status. |
| parentJobId | Description: The numeric ID of a parent job. |
| dataWorkspaceId | Description: The ID of the data workspace for the job. |
| parentVersion | Description: The name of the geodatabase version that will be the parent version for this job's geodatabase version. |
| versionName | Description: The name of the geodatabase version to be used for this job. |
| description | Description: A description of the job. |
| ownedBy | Description: The name of the user who will have ownership of the job. |
| assignedType | Description: Determines whether to assign to a user (1) or group (2), or to leave the job unassigned (0).
The parameters assignedType and assignedTo must be specified together. You cannot specify one and not the other. |
| assignedTo | Description: The name of the user or group to assign the job to.
The parameters assignedType and assignedTo must be specified together. You cannot specify one and not the other. |
| percent | Description: The percentage of work completed on the job's current step. |
| aoi | Description: The polygon geometry of the job's area of interest (AOI).
The spatial reference of the polygon should match the spatial reference configured for the JTX_JOBS_AOI feature class.
The structure of the polygon is the same as the structure of the JSON polygon objects returned by the ArcGIS REST API.
Example:
{
"rings" : [
[[-117,34],[-116,34],[-117,33],[-117,34]],
[[-115,44],[-114,43],[-115,43],[-115,44]]
],
"spatialReference" : { "wkid" : 4326 }
}
|
Example 1: URL (10.0 style) for updating the priority and percent complete of job ID 5 in the "Workflow" service on sampleserver.
http://sampleserver/arcgis/rest/services/Workflow/WMServer/jobs/5/update?f=json&user=cjones&priority=3&percent=85Example 2: URL (10.1 style) for updating several properties of job ID 5 in the "Workflow" service on sampleserver.
http://sampleserver/arcgis/rest/services/Workflow/WMServer/jobs/5/update?f=json&user=cjones&properties={"priority":3,"dueDate":null,"ownedBy":"amiller","description":""}
{ "success": true }
{ "success": true }