Insert Tasks | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TopographicProductionServer/workflows/taskgroups/insertTasks
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 insertTasks operation inserts operation tasks into an existing SOE task group job's product definition.

Request parameters

Parameter	Details
`taskGroupJobId` (Required)	The ID of the existing SOE task group job that the tasks will be inserted to. Note If the job associated with this ID has completed or failed, an error is returned when this operation runs. The job must be paused to insert tasks. If it is not, an error is returned when this operation runs.
`productName` (Required)	The name of the product definition that contains the task operations to be inserted. Note Keep the following requirements in mind about the product definition specified in this parameter so that the `insertTasks` operation doesn't return an error: The `definitionType` must be `WorkflowTask`. The `productVersions` and `resources` array must be empty. There must not be any pre- or post-processing operations. The operations must have a `type` value of `25`. This is the value for Workflow Create Task operations.
`insertAt` (Required)	The string indicating where the new tasks should be inserted in the task group. Values: `Start` \| `End` \| `Next` \| `<operation ID>` \| `<operation name>` Start—The operations are inserted at the start of the operations in the specified SOE task group job. End—The operations are inserted at the end of the operations in the specified SOE task group job. Next—The operations are inserted before the next operation that will be run in the specified SOE task group job. Operation ID or name—The operations are inserted before the operation associated with the ID or name specified. Warning An error will occur if the following requirements are not met: Operation names must be unique. If an operation ID or name is provided, the associated operation must not have started.
`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
{
 "insertTasks": <the count of tasks inserted>,
 "success": <true | false>
}

Example usage

Use the insertTasks operation to insert tasks into an SOE task group job.

Request URL and parameter:

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

Use dark colors for code blocksCopy
taskGroupJobId=B1123255-CCE0-4580-B793-77C34E5121E3
productName=MGCPRework
insertAt=Next
f=json

JSON Response example

The following example of a successful response used a product definition that contained two task operations.

Use dark colors for code blocksCopy
{
 "insertTasks": 2,
 "success": true
}

JSON Response example

The following is an example error response:

Use dark colors for code blocksCopy
{
 "error": {
  "code": -2147211775,
  "message": "No task group found with the specified parameters.",
  "details": [

  ]
 }
}