The identifiers
fetch action retrieves a list of items that are present in the repository and returns an identifier for each item. This action can be used by front end applications for providing an interface to browse a repository. You can use the identifiers that are returned by this action in other connector actions that require you to identify items in the repository.
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. | No |
FilterTypes
|
A comma-separated list of the types of items to return identifiers for. If you omit this parameter, the action returns items of all types. | No |
IdentifiersAction
|
The name of an action to perform on the returned identifiers. 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 increase the maximum depth or 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. | 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. | 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:7002/action=Fetch&FetchAction=Identifiers &ConfigSection=MyTask &ParentIdentifiers=ROOT &MaxDepth=2
The fetch
action is asynchronous, so it returns a token. 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> ... <documentcounts> <documentcount errors="0" seen="3" task="MYTASK"/> </documentcounts> <fetchaction>IDENTIFIERS</fetchaction> <identifiers parent_identifier="ROOT"> <identifier attributes="container" name="C:\MyFiles" type="Directory">[ROOT_IDENTIFIER]</identifier> </identifiers> <identifiers parent_identifier="[ROOT_IDENTIFIER]"> <identifier attributes="document" name="File.txt" type="File">[identifier1]</identifier> <identifier attributes="container" name="MyFolder" type="Directory">[identifier2]</identifier> </identifiers> <token>...</token> </action> </actions> </responsedata> </autnresponse>
The response contains an <identifiers parent_identifier="...">
element for each of the identifiers passed to the action in the ParentIdentifiers
action parameter. If you set the MaxDepth
action parameter to a value greater than 1
, the response also contains an <identifiers parent_identifier="...">
element for descendant items that have child identifiers, down to the requested depth. The parent_identifier
attribute specifies the identifier of the parent item. Each <identifiers parent_identifier="...">
element contains <identifier ...>
elements for items that are direct descendants of the parent item. An <identifier ...>
element provides the following information:
name
attribute shows a display name for the item (if one is available).The attributes
attribute contains a comma-separated list of attributes for the item.
container
attribute it is an item that can contain other items. To retrieve the identifiers of the child items, increase the value of MaxDepth
or run the action again, using the identifier of the container as the value of the ParentIdentifiers
action parameter.document
attribute it is a file or has metadata that can be ingested.The type
attribute shows the type of item that the identifier represents.
The identifiers
action for the HPE File System Connector can return the following types:
Type | Possible Attributes | Description | Display Name | Child Identifier Types |
---|---|---|---|---|
Directory
|
container
|
A folder in the file system. | The folder path when the parent identifier is the root of the repository. Otherwise, the folder name. | Directory, File |
File
|
document
|
A file in the file system. | The file name. |
|