View
The View
action retrieves a single document and returns it.
Type: Synchronous
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 |
Identifier
|
The identifier of the document to return. | Yes |
NoACI
|
A Boolean value (default
|
No |
WithMetadata
|
A Boolean value (default TRUE ) that specifies whether to return metadata in the action response when NoACI=FALSE . This parameter has no effect when NoACI=TRUE . The view action only returns metadata if the connector supports the VIEW_WITH_METADATA feature. |
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 |
Example
http://localhost:7178/action=View&Identifier=PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxmaWxlOC50eHQiLz4
Response
The response is the binary content of the file, unless you have specified NoACI=false
.
With NoACI=false
, the following XML response is returned:
<autnresponse> <action>VIEW</action> <response>SUCCESS</response> <responsedata> <mime-type>application/octet-stream</mime-type> <filename>file.txt</filename> <content>Base64+encoded+file+content</content> </responsedata> </autnresponse>
If NoACI=false
and the connector supports the VIEW_WITH_METADATA
feature, it also returns document metadata, for example:
<autnresponse> <action>VIEW</action> <response>SUCCESS</response> <responsedata> <reference>C:\file.txt</reference> <metadata> <CREATED>1499769017</CREATED> <FILESIZE>12</FILESIZE> <LASTACCESSED>1499769017</LASTACCESSED> <LASTCHANGED>1417178089</LASTCHANGED> <LASTMODIFIED>1357228211</LASTMODIFIED> </metadata> <mime-type>application/octet-stream</mime-type> <filename>file.txt</filename> <content>Base64+encoded+file+content</content> </responsedata>
The response includes the following elements:
reference
provides the document reference.metadata
provides the metadata associated with the requested document.page
elements (zero or more) provide text content, if the repository stores text alongside the document.