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:
| Parameter | Description | Data Type | Privilege |
|---|---|---|---|
| jobName | Optional. Rename an existing job | String | jobUpdateName |
| startDate | Optional. Update start date on an existing job | String representation of date | jobUpdateDate |
| dueDate | Optional. Update due date on an existing job | String representation of date | jobUpdateDate |
| priority | Optional. Update the priority on an existing job including "High", "Medium", and "Low". An invalid value defaults the priority to "Low". | String | jobUpdatePriority |
| description | Optional. Update the description on an existing job | String | jobUpdateDescription |
| ownedBy | Optional. Update the owner of an existing job | String | jobUpdateOwner |
| percentComplete * | Optional. Update the percent of completion for an existing job | Double | jobUpdatePercentComplete |
| jobStatus | Optional. Update the status of an existing job | String | jobUpdateStatus |
| notes | Optional. Update notes on an existing job | String | jobUpdateNotes |
| parentJob | Optional. Update the parent job information on an existing job | String | jobUpdateParentJob |
| extendedProperties | Optional. Define additional properties on a job template specific to your business needs. | Array[ExtendedProperties] | jobUpdateExtendedProperties |
| relatedProperties | Optional. Define 1-M properties on a job template specific to your business needs | Array[RelatedProperties] | jobUpdateExtendedProperties |
| versions | Optional. Set job versions Note: This functionality is not supported in ArcGIS Online. | Array[Version] | jobUpdateVersions |
ExtendedProperties Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| identifier | Required. Combination of the extended property table name and the extended property field name created in the job template, e.g. "tableName.fieldName" | String |
| value | Optional. 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:
| Parameter | Description | Data Type |
|---|---|---|
| adds | Optional. Defines the entries to be added for the properties in the 1-M table for a job | Array[RelatedPropertyAdd] |
| deletes | Optional. Defines the entries to be deleted for the properties in the 1-M table for a job | Array[RelatedPropertyDelete] |
| updates | Optional. Defines the entries to be updated for the properties in the 1-M table for a job | Array[RelatedPropertyUpdate] |
RelatedPropertyAdd Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| tableName | Required. The name of the table to be updated. | String |
| entries | Required. Add multiple entries for a property in a 1-M table to associate with a single JobId. | Array[AddEntries] |
AddEntries Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| properties | Required. Property parameters for the property that will be associated with the job. | Array[Properties] |
Properties Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| propertyName | Required. Name of the property to be added to the Job as an entry. | String |
| values | Required. Value for the related property to be associated with the job. | String |
RelatedPropertyDelete Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| tableName | Required. The name of the table to be updated. | String |
| id | Required. Id for an existing entry that is being deleted. | String |
RelatedPropertyUpdate Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| tableName | Required. The name of the table to be updated. | String |
| entries | Required. Add multiple entries for a property in a 1-M table to associate with a single JobId. | Array[UpdateEntries] |
UpdateEntries Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| properties | Required. Property parameters for the property that will be associated with the job. | Array[Properties] |
| ids | Required. Id for an existing entry that is being updated. | String |
Version Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| dataSourceName | Required. The name of the data source for the job version to be set. | String |
| versionGuid | Optional. The guid of the version to be set. If the value is null or not defined, the version must be defined. versionGuid is preferred to be defined for better performance. | String |
| versionName | Optional. The name of the version to be set. If the value is null or not defined, the version must be defined. | String |
| workflowAdministered | Optional. If true, the version can be claimed. If not defined, the default value is false. | Boolean |
Body parameter
{
"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
| Name | Type | Required |
|---|---|---|
| |
Path parameters
| Name | Type | Required |
|---|---|---|
| | |
| | |
| |
Examples
Request
# 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
{
"success": true,
"message": "string",
"name": "UnableToDetermineHostingServer"
}| Status | Meaning | Description | Schema |
|---|---|---|---|
| success | ||
| error |