Get Task Groups | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TopographicProductionServer/workflows/taskgroups/getTaskGroups
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 getTaskGroups operation returns details about an SOE task group.

Request parameters

Parameter	Details
`taskGroupId` (Optional)	The ID of an existing task group to return details for.
`name` (Optional)	The name of an existing task group to return details for.
`productName` (Optional)	The name of a product definition. A value specified for this parameter will return all of the task groups that reference this product name.
`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
{
 "count": <the number of task groups returned>,
 "taskGroups": [
  {
   "objectId": <the sequential unique ID that was assigned when the task group was created>,
   "taskGroupId": "<the ID of the task group>",
   "name": "<the name of the task group>",
   "description": "<the description of the task group>",
   "productName": "<the product name of the task group>",
   "workdays": {
    "days": "<the available work days configured for the task group>",
    "hours": <the available work hours configured for the task group>
   }
  },
  ...
 ],
 "success": <true | false>
}

Example usage

Use the getTaskGroups operation to return task groups with the parameter values specified.

Request URL and parameters:

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

Use dark colors for code blocksCopy
taskGroupId=
name=
productName=
f=html

JSON Response example

The following JSON object is an example of a successful response and has a taskGroups array that contains the three task group objects returned.

Use dark colors for code blocksCopy
{
 "count": 3,
 "taskGroups": [
  {
   "objectId": 3,
   "taskGroupId": "5F109F09-DF73-4A82-A5B9-0FAACF8206F5",
   "name": "test editing",
   "description": "test",
   "productName": "MGCP Editing Task Group",
   "workdays": {
    "days": "MWF",
    "hours": 8
   }
  },
  {
   "objectId": 4,
   "taskGroupId": "150BFC70-EA45-4327-908D-D6E622CD8B93",
   "name": "carto",
   "description": "test carto",
   "productName": "MTMCartoServerProduct",
   "workdays": {
    "days": "MWF",
    "hours": 8
   }
  },
  {
   "objectId": 8,
   "taskGroupId": "4ED47159-9B55-4749-93CE-3233D4319C29",
   "name": "TaskGroup9 replaced",
   "description": "updating the name of the task group",
   "productName": "MGCP Editing Task Group",
   "workdays": {
    "days": "MTW:4RF",
    "hours": 8
   }
  }
 ],
 "success": true
}