updateJob

Click to copy

Update the properties of a job

Updates one or more properties of a job specified in the provided job object. Specify just the properties to be updated in the job object, all other job properties will remain unchanged. Properties can be updated only if you have the required privilege for the property being updated. A job cannot be closed or assignment updated using this endpoint. Close a job using the manageJobs operation. Assignment can be updated using assignStep. Values for extended properties configured on the job template can be updated during a job update. A job cannot be updated if:

  • You have insufficient privileges
  • You are not the owner or if the job is not assigned to you.
  • The job is already running
  • The job is closed

Job Parameters:

ParameterDescriptionData TypePrivilege
allowRunningStepIdOptional. Allows job properties to be udpated when the specified step is running. Introduced at ArcGIS Enterprise 11.3.StringRequires the privilege of the property to be updated
jobNameOptional. Rename an existing job.StringjobUpdateName
startDateOptional. Update start date on an existing job.String representation of datejobUpdateDate
dueDateOptional. Update due date on an existing job.String representation of datejobUpdateDate
priorityOptional. Update the priority on an existing job including "High", "Medium", and "Low". An invalid value defaults the priority to "Low".StringjobUpdatePriority
descriptionOptional. Update the description on an existing job.StringjobUpdateDescription
ownedByOptional. Update the owner of an existing job.StringjobUpdateOwner
percentComplete *Optional. Update the percent of completion for an existing job.DoublejobUpdatePercentComplete
jobStatusOptional. Update the status of an existing job.StringjobUpdateStatus
notesOptional. Update notes on an existing job.StringjobUpdateNotes
parentJobOptional. Update the parent job information on an existing job.StringjobUpdateParentJob
extendedPropertiesOptional. Define additional properties on a job template specific to your business needs.Array[ExtendedProperties]jobUpdateExtendedProperties
relatedPropertiesOptional. Define 1-M properties on a job template specific to your business needs.Array[RelatedProperties]jobUpdateExtendedProperties
versionsOptional. Set job versions. Note: This functionality is not supported in ArcGIS Online.Array[Version]jobUpdateVersions

ExtendedProperties Parameters:

ParameterDescriptionData Type
identifierRequired. Combination of the extended property table name and the extended property field name created in the job template. For example, tableName.fieldName.String
valueOptional. The updated value for the extended property. It must be a string representation of the extended property value. For example, "true" for a boolean, or "2020-11-01T22:00:32Z" for a date. If the value is null or not defined, the extended property value is cleared.String

RelatedProperties Parameters:

ParameterDescriptionData Type
addsOptional. Defines the entries to be added for the properties in the 1-M table for a job.Array[RelatedPropertyAdd]
deletesOptional. Defines the entries to be deleted for the properties in the 1-M table for a job.Array[RelatedPropertyDelete]
updatesOptional. Defines the entries to be updated for the properties in the 1-M table for a job.Array[RelatedPropertyUpdate]

RelatedPropertyAdd Parameters:

ParameterDescriptionData Type
tableNameRequired. The name of the table to be updated.String
entriesRequired. Add multiple entries for a property in a 1-M table to associate with a single JobId.Array[AddEntries]

AddEntries Parameters:

ParameterDescriptionData Type
propertiesRequired. Property parameters for the property that will be associated with the job.Array[Properties]

Properties Parameters:

ParameterDescriptionData Type
propertyNameRequired. Name of the property to be added to the Job as an entry.String
valuesRequired. Value for the related property to be associated with the job.String

RelatedPropertyDelete Parameters:

ParameterDescriptionData Type
tableNameRequired. The name of the table to be updated.String
idRequired. Id for an existing entry that is being deleted.String

RelatedPropertyUpdate Parameters:

ParameterDescriptionData Type
tableNameRequired. The name of the table to be updated.String
entriesRequired. Add multiple entries for a property in a 1-M table to associate with a single JobId.Array[UpdateEntries]

UpdateEntries Parameters:

ParameterDescriptionData Type
propertiesRequired. Property parameters for the property that will be associated with the job.Array[Properties]
idsRequired. Id for an existing entry that is being updated.String

Version Parameters:

ParameterDescriptionData Type
dataSourceNameRequired. The name of the data source for the job version to be set.String
versionGuidOptional. The guid of the version to be set. If the value is null or not defined, the versionName must be defined. versionGuid is preferred to be defined for better performance.String
versionNameOptional. The name of the version to be set. If the value is null or not defined, the versionGuid must be defined.String
workflowAdministeredOptional. If true, the version can be claimed. If not defined, the default value is false.Boolean

Body parameter

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
  "allowRunningStepId": "string",
  "jobName": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "priority": "string",
  "description": "string",
  "ownedBy": "string",
  "percentComplete": 0,
  "jobStatus": "string",
  "notes": "string",
  "parentJob": "string",
  "versions": [
    {
      "dataSourceName": "string",
      "versionName": "string",
      "versionGuid": "string",
      "workflowAdministered": true
    }
  ],
  "extendedProperties": [
    {
      "identifier": "string",
      "value": "string",
      "dataType": "string",
      "uniqueId": "string"
    }
  ],
  "relatedProperties": {
    "adds": [
      {
        "tableName": "string",
        "entries": [
          {
            "properties": [
              {}
            ]
          }
        ]
      }
    ],
    "deletes": [
      {
        "tableName": "string",
        "ids": [
          "string"
        ]
      }
    ],
    "updates": [
      {
        "tableName": "string",
        "entries": [
          {
            "id": "string",
            "properties": [
              {}
            ]
          }
        ]
      }
    ]
  }
}

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

jobId

string

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/{jobId}/update \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "success": true,
  "message": "string",
  "name": "UnableToDetermineHostingServer"
}
StatusMeaningDescriptionSchema

200

OK

success

SuccessResponse

400

Bad Request

error

WorkflowJsonExceptionDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.