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 TRUE) that specifies whether to return just binary content.

  • TRUE - Return binary content.
  • FALSE - Return a normal ACI response with base-64 encoded content.
No
Range View part of a file. For example, an application can request the first 100 KB of a large video file by setting Range=bytes=0-99999. The connector must support the VIEW_RANGE feature, and the repository must support the retrieval of content ranges, otherwise the parameter is ignored and the connector returns the entire file. 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=...
&[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

http://localhost:17166/action=View&Identifier=PGlkIHQ9IkZpbGUiIHM9Ik1ZVEFTSyIgcj0iQzpcSURPTFxmaWxlLnR4dCIvPg==

Response

The response is the binary content of the file, unless you have specified NoACI=false.

When you set the Range parameter to retrieve a content range, the connector responds with an HTTP 206 (Partial content) response code and the response includes the Content-Range response header. If either the connector or the repository does not support retrieval of content ranges, the connector returns an HTTP 200 response, without the Content-Range response header, and the response includes the entire file.

With NoACI=false, the connector returns XML and provides the content base-64 encoded:

<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>

When NoACI=false and you set the Range parameter to retrieve a content range, the connector returns an HTTP 200 response. In the XML, the content element can include a range attribute:

        <content range="bytes 0-9999/12345678">[base64 encoded binary data]</content>

When 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.