Add Task Group | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TopographicProductionServer/workflows/taskgroups/addTaskGroup
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 addTaskGroup operation combines a workflow definition with specifics required by an organization into an SOE task group that can be used by the createTaskGroupJob operation to create SOE jobs that result in ArcGIS Workflow Manager parent and child jobs.

Request parameters

Parameter Details

Parameter	Details
`name` (Required)	The name of the SOE task group.
`description` (Required)	The description of the SOE task group.
`workdays` (Required)	The days and hours that organization members are available to complete the work. Syntax: Use dark colors for code blocksCopy `1 2 3 4 { "days": <day's initial>, "hours": <number of hours> }` Example: Use dark colors for code blocksCopy `1 2 3 4 { "days": UMTWRFS, "hours": 8 }` Note U is Sunday R is Thursday
`productName` (Required)	The exact name of the existing workflow product definition.
`f` (Required)	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

name

(Required)

The name of the SOE task group.

description

(Required)

The description of the SOE task group.

workdays

(Required)

The days and hours that organization members are available to complete the work.

Syntax:

Use dark colors for code blocksCopy
  {
   "days": <day's initial>,
   "hours": <number of hours>
  }

Example:

Use dark colors for code blocksCopy
  {
   "days": UMTWRFS,
   "hours": 8
  }

productName

(Required)

The exact name of the existing workflow product definition.

f

(Required)

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
{
 "taskGroup": {
  "objectId": "<object ID>",
  "taskGroupId": "<task group ID>",
  "name": "<task group name>",
  "description": "<task group description>",
  "productName": "<name of the product>",
  "workdays": {
   "days": "<Day's initial>",
   "hours": <number of hours>
  }
 },
 "success": <true | false>
}

Example usage

Add a task group definition to the topographic production server using the addTaskGroup REST operation.

Request URL and parameters:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/<SampleService>/TopographicProductionServer/workflows/taskgroups/addTaskGroup

Use dark colors for code blocksCopy
name=Task group 1
description=The first SOE task group
workdays={\"days\": \"MTWRF\", \"hours\": 8}
productName=MTMCartoServerProduct
f=json

JSON Response example

The following is an example response when the task group is added successfully:

Use dark colors for code blocksCopy
{
 "taskGroup": {
  "objectId": 7,
  "taskGroupId": "A1DA2B65-AB32-40FD-82C1-882F4878F160",
  "name": "Task group 1",
  "description": "The first SOE task group",
  "productName": "MTMCartoServerProduct",
  "workdays": {
   "days": "MTWRF",
   "hours": 8
  }
 },
 "success": true
}

The following is an example error response:

Use dark colors for code blocksCopy
{
 "error": {
  "code": 0,
  "message": "Duplicate name found. Duplicate names are not allowed.",
  "details": [

  ]
 }
}