Get Task | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TopographicProductionServer/workflows/tasks/getTask
Methods:: GET
Required Capability:: Requires a Professional or Professional Plus user type account and a Topographic Mapping server extension license.
Version Introduced:: 12.0

Description

The getTask operation returns details about an SOE task.

Request parameters

Parameter Details

Parameter	Details
`taskGroupJobId` (Required)	The ID of the existing task group job that contains the task to return details for.
`taskOperationId` (Required)	The ID of the existing SOE operation for the task to return details for.
`f` (Required)	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

taskGroupJobId

(Required)

The ID of the existing task group job that contains the task to return details for.

taskOperationId

(Required)

The ID of the existing SOE operation for the task to return details for.

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
{
 "task": {
  "taskWorkId": "<The ID of the task instance in the server database>",
  "taskOperationId": "<The ID associated with the task operation",
  "workflowJobId": "<The ID of the work performed by the technician in ArcGIS Workflow Manager>",
  "statusCode": <The number associated with the status of the task>,
  "status": "<The status of the task>",
  "startOn": "<The planned start UTC date and time in ISO 8601 format>",
  "endOn": "<The planned UTC date and time in ISO 8601 format>",
  "startedOn": "<The actual start UTC date and time in ISO 8601 format>",
  "endedOn": "<The actual UTC date and time in ISO 8601 format>",
  "duration": <The duration of the task in hours>,
  "levelOfEffort": <The number of hours based on an average level of effort for the type of work associated with the task (child job), the parent task group job sets its level of effort based on the sum of these hours across its child jobs>,
  "assignTo": "<assigned user>",
  "isRework": <true | false>,
  "taskOrder": <the level of priority>
 },
 "success": <true | false>
}

Example usage

Use the getTask operation to return details about an SOE task.

Request URL and parameters:

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

Use dark colors for code blocksCopy
taskGroupJobId=A031377A-E3C5-4C1A-A081-56285228A3A3
taskOperationId=F6208AD7-D10C-4E1C-AB8A-6CA429AD559C
f=html

JSON Response example

The following JSON object is an example of a successful response and contains details about the task specified in the request.

Use dark colors for code blocksCopy
{
 "task": {
  "taskWorkId": "E2A45BF8-55ED-4311-9574-48E17C734918",
  "taskOperationId": "F6208AD7-D10C-4E1C-AB8A-6CA429AD559C",
  "workflowJobId": "",
  "statusCode": 0,
  "status": "new",
  "startOn": "2025-09-26T23:13:17Z",
  "endOn": "2025-09-30T23:13:17Z",
  "startedOn": "",
  "endedOn": "",
  "duration": 0,
  "levelOfEffort": 24,
  "assignTo": "",
  "isRework": false,
  "taskOrder": 1
 },
 "success": true
}