Identifiers
This action retrieves a list of document identifiers and optionally performs an action on them (currently only the collect
action is available). Do not use this action to perform queries that IDOL Server can process more efficiently.
http://host:port/action=Fetch&FetchAction=Identifiers [&Config=Base64_Config] &ConfigSection=Section_Name [&Identifiersaction=Collect &Destination=UNC_Path [&CollectActions=Document_Action_CSV]] &Connector-specific-Parameters [&Override_Config_Parameters]
Type: Asynchronous
Parameter Name | Description | Required |
---|---|---|
Config
|
A base-64 encoded configuration. The configuration parameters that are set override the same parameters in the connector's configuration file. |
No |
ConfigSection
|
The name of the configuration file section containing the task settings. | Yes |
IdentifiersAction
|
The name of the action to perform on the returned identifiers. If this action must be passed additional parameters, specify them as parameters to this action. | No |
Connector-specific_Parameters
|
Additional parameters that are connector-specific and determine which identifiers to return. | Yes |
Override_Config_Parameters
|
Any other action parameters that you set override settings in the connector's configuration file. For example: /action=fetch&fetchaction=... where |
No |
Example
http://localhost:1234/action=Fetch&FetchAction=Identifiers&ConfigSection=DIR1
Response
As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the QueueInfo
action) appears below.
The response shows that the action has completed. The identifiers are listed in between the <identifiers>
tags.
<action> <documentcounts> <documentcount added="0" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="0" ingestupdated="0" inserted="0" releasedholds="0" seen="0" task="DIR1" unchanged="0" updated="0"/> </documentcounts> <fetchaction>IDENTIFIERS</fetchaction> <identifiers> <identifier> PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== </identifier> </identifiers> <token>MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDotMTc4NTQ1MTYwOQ==</token> <status>Finished</status> <queued_time>2009-Oct-15 16:36:32</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-Oct-15 16:36:32</process_start_time> <time_processing>0</time_processing> <process_end_time>2009-Oct-15 16:36:32</process_end_time> </action>