Get a specific task
GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/tasks/{{TaskId}}
Get a specific task in Miralix OfficeTeam, whether if it's in a queue or if it's being handled by an agent.
HTTP GET: /tasks/{taskId}
| Parameter | Value | Description |
|---|---|---|
| taskId | Integer | ID for a task |
Example
https://192.168.1.10/mot/greenbox/tasks/QA3D-2332-QAS - Gets description for the task with taskId QA3D-2332-QAS
Result
- 200 OK - Description of the desired task.
- 403 Forbidden - Missing required License to access this request.
- 404 Not Found - The task does not exist
- 500 Internal Server Error - Internal processing error.
JSON result
For each task, the following results are displayed:
| Parameter | Value | Description |
|---|---|---|
| TaskId | {String} | A unique ID for the task |
| Subject | {String} | Title for the task |
| Text | {String} | Detailed description of the task |
| State | InQueue, OfferedToAgent | State of the task |
| EntryMenuId | {Integer} | ID for entry menu linked to a task created via an external source |
| EntryMenuParameters | {String} | The entry menu parameters that are linked to a task created via an external source. The parameters are Comma-separated and replace parameters (like <@CrmId@> and <@SubTaskId@>) specified in the entry menu URL or specified in the Arguments for a process. |
| Culture | {String: ISO Language Code} | Specifies which language to associate with the task. E.g. da-DK. If nothing is specified, the default language is used for the OfficeTeam configuration. |
| Tags | {String} | Comma-separated list of words describing the task. E.g. Tags=Error message,Sales |
| QueueInquiryId | {Integer} | ID for the task in the queue |
| FirstQueueName | {String} | Queue name of the first queue to which the task was added |
| FirstQueueId | {Integer} | ID on the first queue to which the task was added |
| CurrentQueueName | {String} | Queue name of the queue that the task is attached to now |
| CurrentQueueId | {Integer} | ID on the queue that the task is associated with now |
| AgentName | {String} | The name of the agent if the task is offered to an agent |
| AgentId | {Integer} | ID of the agent if the task is offered to an agent |
| ExternalSource | null, WebApi, AzureServiceBus | Which external source is used to create the task. |
| AddedToQueue | {date-time: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'} | Time the call arrived in the queued (Note! – This is not UTC time) |
RESPONSES
status: OK
{"TaskId":"QA3D-2332-QAS","Subject":"Update customer A","Text":"Help the customer with a little of this and that! https://www.google.com/search?q=QA3D-2332-QAS or call +45 83848586","State":"InQueue","EntryMenuId":105,"EntryMenuParameters":"CrmId=191597,SubTaskId=654","Culture":"da-DK","Tags":"Error message,Sales","QueueInquiryId":70,"FirstQueueName":"Queue for tasks","FirstQueueId":181,"CurrentQueueName":"Queue for tasks","CurrentQueueId":181,"AgentName":null,"AgentId":null,"ExternalSource":"WebApi","AddedToQueue":"2021-11-19T10:20:58.0196967+01:00"}