TaskList
This action returns a list of the fetch tasks that are configured in the connector's configuration file, and fetch tasks that the connector ran as a result of receiving a fetch
action with a configuration included in the config
action parameter.
The connector returns (if applicable):
- The name of the task.
- The type of task performed (for example,
synchronize
,collect
, and so on). - The number of times that the task has been called.
- The time when the last call started.
- The time when the last call finished.
- The path of the datastore file that stores the state information for the task. (The information stored by the datastore usually includes information such as the files that were retrieved and the date and time when the files were last modified).
/action=TaskList [&matchname=Task_Name] [&matchaction=FetchAction_Name]
Type: Synchronous
Parameter Name | Description | Required |
---|---|---|
MatchName
|
To return information about a named fetch task, use this parameter to specify the name of the task. | No |
MatchAction
|
To return information for a single fetch action (for example, synchronize , collect , insert ), use this parameter to specify the name of the action. |
No |
Examples
The following action returns all task information:
http://localhost:1234/action=TaskList
The following action returns task information for all tasks named MyTask1
:
http://localhost:1234/action=TaskList&matchname=mytask1
The following action returns task information for the synchronize task named MyTask1
:
http://localhost:1234/action=TaskList&matchname=mytask1&matchaction=synchronize
The following action returns task information for all synchronize tasks:
http://localhost:1234/action=TaskList&matchaction=synchronize
The information returned by these actions will include tasks that are defined in the connector's configuration file, and tasks that the connector ran as a result of receiving action=fetch
with a configuration included in the config
action parameter.
Response
<autnresponse xmlns:autn="http://schemas.autonomy.com/aci/"> <action>TASKLIST</action> <response>SUCCESS</response> <responsedata> <task> <name>MYTASK1</name> <action>COLLECT</action> <calls>1</calls> <lastStartTime>2014-Feb-05 10:49:27</lastStartTime> <lastFinishTime>2014-Feb-05 10:49:28</lastFinishTime> </task> <task> <name>MYTASK1</name> <action>SYNCHRONIZE</action> <calls>1</calls> <datastore>C:\Autonomy\Connector_FileSystem\connector_MYTASK1_datastore.db</datastore> <lastStartTime>2014-Feb-05 10:50:24</lastStartTime> <lastFinishTime>2014-Feb-05 10:50:29</lastFinishTime> </task> <task> <name>MYTASK2</name> <action>SYNCHRONIZE</action> <calls>0</calls> </task> </responsedata> </autnresponse>