Skip to content
URL:
https://<root>/<serviceName>/TopographicProductionServer/workflows/taskgroups/updateTaskGroup
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 updateTaskGroup operation can be used to update existing SOE task groups.

ParameterDetails

taskGroupJobId

(Required)

The ID of the existing task group with the properties you want to modify.

name

(Optional)

The new name to use for the existing task group.

description

(Optional)

The new description to use for the existing task group.

workdays

(Optional)

The new work days and hours available for the existing task group.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
{
  "days": "<Day>",
  "hours": <number of hours>
}

Example:

Use dark colors for code blocksCopy
1
2
3
4
{
  "days": "UMTWRFS",
  "hours": 8
}

productName

(Optional)

The name of the new product definition that the existing task group should use.

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
5
6
7
8
9
10
11
12
13
14
{
  "taskGroup": {<task group details in JSON for the task group that was updated>
    "objectId": <a sequential unique ID for the task group>,
    "taskGroupId": "<the ID of the task group that was updated>",
    "name": "<the new name of the existing task group>",
    "description": "<the new description of the existing task group>",
    "productName": "<the new productName of the existing task group>",
    "workdays": {
      "days": "<the task group's new available work days>",
      "hours": <the task group's new available work hours>
      }
    },
 "success": true
}

Example usage

Update the properties of an existing task group using the updateTaskGroup REST operation.

Request URL and parameters:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/rest/services/SampleService/TopographicProductionServer/workflows/taskgroups/updateTaskGroup
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
taskGroupId=A1DA3B65-AB32-40FD-82C1-882F4878F160
name=task group 9
description=updated name
workdays=
{
	days: "MTWRF",
	hours: 8
}
productName=MGCP Editing Task Group
f=html

JSON Response example

The following is an example of a response:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
 "taskGroup": {
  "objectId": 8,
  "taskGroupId": "A1DA3B65-AB32-40FD-82C1-882F4878F160",
  "name": "task group 9 replaced",
  "description": "updated name",
  "productName": "MGCP Editing Task Group",
  "workdays": {
   "days": "MTWRF",
   "hours": 8
  }
 },
 "success": true
}

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