Identifiers

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. 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=...
&[Section]Parameter=Value

where [Section] (optional) is the name of a configuration file section, Parameter is the name of a configuration parameter, and Value is the parameter value.

No

Example

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:7036/action=Fetch&FetchAction=Identifiers
                                  &ConfigSection=MyTask
                                  &ParentIdentifiers=ROOT
                                  &MaxDepth=2

Response

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="identifier">
          <identifier attributes="document" name="file.txt" type="file">[identifier1]</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:

The identifiers action for the HPE OneDrive Connector can return the following types:

Type Possible Attributes Description Display Name Child Identifier Types
User container A OneDrive user. User: User display name (User principal name/email) [User ID] Drive, Folder, File
Drive container A OneDrive drive. Drive: drive ID, owner: user display name, type: drive type Folder, File
Folder container, document A folder. The folder name. Folder, File
File document A file. The file name.  

_HP_HTML5_bannerTitle.htm