Hide Table of Contents
esri Workflow Manager (Classic)
Tasks
Return Types
Class: JobUpdateParameters
Description
The JobUpdateParameters class is a collection of values that can be used to update job properties.
Class hierarchy
esri.WorkflowManager.SupportClasses.JobCreationParameters()
Properties
| Name | Type | Summary |
|---|---|---|
| aoi | esri.geometry.Polygon | The polygon geometry of the job's area of interest (AOI). |
| assignedTo | string | The name of the user or group to assign the job to. |
| assignedType | JobAssignmentType | Indicates to assign the job to a user (1) or group (2) or to leave the job unassigned (0). |
| clearAOI | boolean | Indicates to clear the current job's AOI. |
| clearDueDate | boolean | Indicates to clear current job's due date. |
| clearStartDate | boolean | Indicates to clear current job's start date. |
| dataWorkspaceId | string | The Id of the data workspace of the job. |
| description | string | A descrition of the job. |
| dueDate | date | The date on which the job is expected to be complete. |
| jobId | int | A unique numeric ID to identify the new job. |
| loi | esri.geometry.Geometry | The geometry of the job's location of interest (LOI). Supported geometry types include point, multipoint and polygon. |
| name | string | The name of the new job. |
| ownedBy | string | The name of the user that will own the job. Job ownership allows modification of job properties and not workflow execution. |
| parentJobId | int | The numeric ID of a parent job. |
| parentVersion | string | The name of the geodatabase version that will be the parent version of the job's geodatabase. This will default to the parent version of the data workspace. |
| percent | int | The percentage of work completed on the job's current step. |
| priority | int | The numeric priority value. |
| startDate | date | The date on which the job is scheduled to begin. |
| status | int | The numeric ID of the job's new status. |
| versionName | string | The name of the geodatabase version to be used for the job. |
Property Details
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.
<JobAssignmentType> assignedType
Indicates to assign the job to a user (1) or group (2) or to leave the job unassigned (0).
The geometry of the job's location of interest (LOI). Supported geometry types include point, multipoint and polygon. The spatial reference of the polygon should match the spatial reference configured for the JTX_JOBS_AOI feature class.
The name of the user that will own the job. Job ownership allows modification of job properties and not workflow execution.
The name of the geodatabase version that will be the parent version of the job's geodatabase. This will default to the parent version of the data workspace.