The identifiers
fetch action retrieves a list of documents that are present in the repository and generates an identifier for each document. This action might be used by front end applications for providing an interface to browse a repository.
Tip: The identifiers
fetch action does not expand container files, and does not provide identifiers for sub-files.
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 that contains the task settings. | Yes |
ContainersOnly
|
A Boolean value (default false) that specifies whether to return only those items that represent containers, for example folders. | No |
IdentifiersAction
|
The name of an action to perform on the returned identifiers. Currently only the collect fetch action is available. If the action you specify would require additional parameters, specify them as parameters to this action. |
No |
MaxDepth
|
The maximum depth that the connector crawls in the repository (from ParentIdentifiers ). The default maximum depth is 1. To specify no limit, set this parameter to 0 (zero). Be aware that if you specify an unlimited maximum depth, the action could take a long time to complete. |
No |
ParentIdentifiers
|
A comma-separated list of identifiers. The action returns identifiers for items that exist below these identifiers in the repository. To specify the root of the repository, set this parameter to ROOT . |
Yes |
ShowAttributes
|
A Boolean value (default true) that specifies whether to show attributes in the response. These attributes specify whether an identifier represents a document or a container . |
No |
ShowNames
|
A Boolean value (default true) that specifies whether the response shows a display name for each item (if one is available). | No |
ShowTypes
|
A Boolean value (default true) that specifies whether the response shows the type of item that each identifier represents. The possible types are determined by the type of repository that you are connecting to. | No |
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 |
The following example sends the identifiers
fetch action to the connector. The connector returns the items that it finds by crawling from the root of the repository to a maximum depth of two levels:
http://localhost:1234/action=Fetch&FetchAction=Identifiers &ConfigSection=MyTask &ParentIdentifiers=ROOT &MaxDepth=2
The fetch
action is asynchronous, so it returns a token:
<autnresponse> <action>FETCH</action> <response>SUCCESS</response> <responsedata> <token>MTYuMjguOTQuMTcyOjEyMzQ6RkVUQ0g6MTQzOTgyOTY0OTQ2NjAxMjY4ODQ1NTM2</token> </responsedata> </autnresponse>
You can use the token with the QueueInfo
action to retrieve the response.
<autnresponse> <action>QUEUEINFO</action> <response>SUCCESS</response> <responsedata> <actions> <action> <status>Finished</status> <queued_time>2015-Aug-17 17:40:49</queued_time> <time_in_queue>1</time_in_queue> <process_start_time>2015-Aug-17 17:40:50</process_start_time> <time_processing>2</time_processing> <process_end_time>2015-Aug-17 17:40:52</process_end_time> <documentcounts> <documentcount errors="0" seen="3" task="MYTASK"/> </documentcounts> <fetchaction>IDENTIFIERS</fetchaction> <identifiers parent_identifier="ROOT"> <identifier attributes="container" name="C:\MyFiles" type="Directory"> [identifier1] </identifier> </identifiers> <identifiers parent_identifier="[identifier1]"> <identifier attributes="document" name="File.txt" type="File"> [identifier2] </identifier> <identifier attributes="container" name="MyFolder" type="Directory"> [identifier3] </identifier> </identifiers> <token> MTYuMjguOTQuMTcyOjEyMzQ6RkVUQ0g6MTQzOTgyOTY0OTQ2NjAxMjY4ODQ1NTM2 </token> </action> </actions> </responsedata> </autnresponse>
The following information is available for each item:
parent_identifier
attribute specifies the identifier of the parent element. For example, a file might be contained inside a folder.The attributes
attribute contains a comma-separated list of attributes for the item.
container
attribute it represents a folder that contains other items. To retrieve the identifiers of the items inside the folder, increase the value of MaxDepth
or use the identifier of the container as the value of the ParentIdentifiers
parameter.document
attribute the item is a file.name
attribute shows a display name for the item. This is the file or folder name.The type
attribute shows the type of item that the identifier represents:
Directory
- the item represents a folder in the file system.File
- the item represents a file in the file system.
|