ListTasks
List all tasks or list only specified tasks.
Purpose
List existing IBM® eDiscovery Manager tasks:- All tasks
- All tasks for a specified case
- All tasks of a specified type, such as addToFolder tasks or repeating tasks
Used by
- Any users whose content server privileges allow them access to eDiscovery Manager cases.
Parameters (optional)
- CaseID
- Unique identifier of the case whose tasks are to be listed. If a unique identifier is not specified, all current tasks in the system are listed.
- TaskName
- Name of a specific type of task. Tasks of the specified type are listed only if they are still running.
Responses
- List of tasks
- A list of all tasks or only specified tasks
- XML example (success)
<?xml version="1.0" encoding="UTF-8" ?> <response> <status>0</status> <tasks> <task id="85 3 ICM7 cm8demo7 EDMTask59 26 A1001001A10J11B42902D1783518 A10J11B42902D178351 14 1019"> <name><![CDATA[DeleteFolder 20101011T142943511_McpM]]></name> <description> <![CDATA[Deleting folder TempFolder2]]> </description> <caseid><![CDATA[85 3 ICM7 cm8demo7 EDMCase59 26 A1001001A10J06B44057F6771518 A10J06B44057F677151 14 1014]]> </caseid> <action><![CDATA[DeleteFolder]]></action> <status><![CDATA[COMPLETE]]></status> <scheduletime/> <starttime> <![CDATA[October 11, 2010 2:30:11 PM EDT]]> </starttime> <finishtime> <![CDATA[October 11, 2010 2:30:12 PM EDT]]> </finishtime> <createdate> <![CDATA[October 11, 2010 2:29:02 PM EDT]]> </createdate> <createuser><![CDATA[EDISCADMIN]]></createdate> <total><![CDATA[2]]></total> <success><![CDATA[2]]></success> <failed><![CDATA[0]]></failed> <folderid> <![CDATA[87 3 ICM7 cm8demo9 EDMFolder59 26 A1001001A10J11B42618F7460718 A10J11B42618F746071 14 1017]]> </folderid> </task> </tasks> </response>- JSON example (success)
{ "status": 0, "tasks": [{ "finishtime":"October 11, 2010 2:30:12 PM EDT", "success":2, "total":2, "createuser":"EDISCADMIN", "folderid":"87 3 ICM7 cm8demo9 EDMFolder59 26 A1001001A10J11B42618F7460718 A10J11B42618F746071 14 1017", "createdate":"October 11, 2010 2:29:02 PM EDT", "name":"DeleteFolder 20101011T142943511_McpM", "caseid":"85 3 ICM7 cm8demo7 EDMCase59 26 A1001001A10J06B44057F6771518 A10J06B44057F677151 14 1014", "starttime":"October 11, 2010 2:30:11 PM EDT", "status":"COMPLETE", "action":"DeleteFolder", "id":"85 3 ICM7 cm8demo7 EDMTask59 26 A1001001A10J11B42902D1783518 A10J11B42902D178351 14 1019", "description":"Deleting folder TempFolder2", "failed":0 }
Sample
http://localhost:9080/EDMWorkMgrServer/api?CallName=ListTasks&User=administrator &password=password