Skip to content
URL:
https://<root>/<serviceName>/TopographicProductionServer/workflows/tasks/updateTask
Methods:
GETPOST
Required Capability:
Requires a Professional or Professional Plus user type account and a Topographic Mapping server extension license.
Version Introduced:
12.0

Description

The updateTask operation updates the properties of an existing single SOE task operation.

Request parameters

ParameterDetails

taskGroupJobId

(Required)

The ID of the existing task group job that the task operation is associated with.

taskOperationId

(Required)

The ID of the task operation to update.

status

(Optional)

The numerical value associated with the status of the task operation after the updateTask operation is run.

Unknown = 0 Ready = 1 InProgress = 2 Completed = 3 Failed = 4 Canceled = 5

onFailureCancelTasks

(Optional)

A true or false value that determines whether remaining tasks in the SOE task group job are canceled if the task associated with the taskOperationId parameter value is disrupted or fails.

f

The response format. The default format is html.

Values: html | json | pjson

JSON Response syntax

The following is the syntax of a response:

Use dark colors for code blocksCopy
1
2
3
4
{
  "taskOperationId": "<The ID associated with the task operation to update.>",
  "success": <true | false>
}

Example usage

Update a task operation using the updateTask REST operation.

Request URL and parameters:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/rest/services/SampleService/TopographicProductionServer/workflows/tasks/updateTask
Use dark colors for code blocksCopy
1
2
3
4
taskGroupJobId=150BFC70-EA45-4327-908D-D6E622CD8B93
taskOperationId=5F109F09-DF73-4A82-A5B9-0FAACF8200F5
status=1
onFailureCancelTasks=true

JSON Response example

The following is an example of a successful response:

Use dark colors for code blocksCopy
1
2
3
4
{
  "taskOperationId": "5F109F09-DF73-4A82-A5B9-0FAACF8200F5",
  "success": true
}

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