Skip to content
URL:
https://<root>/<serviceName>/TopographicProductionServer/workflows/taskgroups/createTaskGroupJob
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 createTaskGroupJob operation uses a task group to create a task group job that results in an ArcGIS Workflow Manager parent job and its child jobs.

Request parameters

ParameterDetails

phaseId

(Required)

The ID of the work phase to associate with the SOE task group job.

taskGroupId

(Required)

The SOE task group ID to associate with the SOE task group job. This task group must already be linked to the phase associated with the ID specied in the phaseId parameter.

productVersion

(Required)

The version to create of the product.

aoiLayer

(Required)

The URL for the area of interest (AOI) layer.

aoiFeatures

(Required)

The polygon features that define each AOI. This can be an object ID, an array of object IDs, or a feature dataset.

startDate

(Optional)

The workflow project's start date and time. The date and time should be UTC and in ISO 8601 format. It is added to the URL using the following format: YYYY-MM-DDThh:mm:ssZ.

priority

(Optional)

A numeric value assigned to AOIs specified in the aoiFeatures parameter. Values range from 1 through 5, 1 being the highest priority and 5 being the lowest priority.

oneJobPerAoi

(Optional)

This indicates whether one job per AOI is created or one job for multiple AOIs.

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
1
2
3
4
5
6
7
8
9
10
11
12
{
  "count": <the number of jobs created>,
  "name": <the name of the response>,
  "items": [
    {
      "id": "<the ID of the SOE job created>",
      "success": <true | false>,
      "message": "<the URL of the SOE job created>"
    }
  ],
  "success": <true | false>
}

Example usage

Create an SOE job using the createTaskGroupJob REST operation.

Request URL and parameters:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/rest/services/SampleService/TopographicProductionServer/workflows/taskgroups/createTaskGroupJob
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
phaseId=F13D2C62-AB32-82FD-40C1-061F8784F288
taskGroupId=A1DA2B65-AB32-40FD-82C1-882F4878F160
productVersion=MTM50_Extracted
aoiLayer=https://servermachine.domain.com/server/rest/services/AOI_MIL1/MapServer/1
aoiFeatures=[606574]
startDate=2025-08-14T16:45:12Z
priority=3
oneJobPerAoi=true
f=html

JSON Response example

The following is an example response when the parent job is created successfully:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
 "count": 1,
 "name": "jobsCreated",
 "items": [
  {
   "id": "75A5D0A8-3E82-476C-B7FA-C30B9BE8B9A6",
   "success": true,
   "message": "https://<machine>.<domain>.com/server/rest/services/MPS/MGCP_Data/TopographicProductionServer/jobs/job/75A5D0A9-3A82-476C-B7FA-C20B9BE8B9A6"
  }
 ],
 "success": true
}

The following is an example error response:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
 "error": {
  "code": -2147024809,
  "message": "Invalid format for parameter startDate.",
  "details": [

  ]
 }
}

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