GET_FILE

Service that returns a specific rendition of a content item revision to a browser. A copy of the file is retrieved without performing a checkout.

Given a dID or a dDocName and a RevisionSelectionMethod parameter, the service determines the file name of a particular rendition of the revision and returns that file to the client.

The most likely errors are some form of mismatched parameters or a request for a revision or rendition that does not exist.

Additional Required Service Parameters

	Note: It is recommended that dDocName be included in all requests for content items where the requester knows the dDocName. Error messages in the content server assume that it is present, as do other features such as forms.

	Important: Either the content item revision ID (dID) must be specified or a Content ID (dDocName) along with a RevisionSelectionMethod parameter must be defined.

dID: The generated content item revision ID.

If dID is not specified, dDocName and RevisionSelectionMethod must specified.

A rendition of the revision of the content item with this ID is returned, if it exists, and the RevisionSelectionMethod parameter does not exist or has the value Specific.

dDocName: The Content ID for the content item.

If dDocName is not present, dID must be present and RevisionSelectionMethod must not be present.

If RevisionSelectionMethod is present, a rendition of a revision of the content item with this name is returned, if it exists. If RevisionSelectionMethod is not present, dDocName is used in error messages.

Optional Service Parameters

allowInterrupt: If set to 1 (true), this suppresses an error if the user cancels the file download.

RevisionSelectionMethod: The revision selection method.

If present, dDocName must be present. The value of this variable is the method used to compute a dID from the specified dDocName. Its value can be Specific, Latest, or LatestReleased.

If the value is Specific, the dDocName is ignored, and dID is required and is used to get a rendition. If the value is Latest, the latest revision of the content item is used to compute the dID. If the value is LatestReleased, the latest released revision of the content item is used to compute the dID.

Rendition: The content item rendition. This parameter specifies the rendition of the content item and can be set to Primary, Web, or Alternate. If Rendition is not present, it defaults to Primary.

If the value is Primary, the primary rendition of the selected revision is returned.

If the value is Web, the web-viewable rendition of the selected revision is returned.

If the value is Alternate, the alternate rendition of the selected revision is returned.

Other rendition types may be available depending on the add-on products used with your instance (for example, thumbnail if the Inbound Refinery product is used).

IsXml: When set to true or 1, returns the XML data island which is present in some HCSP, HCST, and HCSF pages. It returns the data island that is wrappered inside the std_html_form_xml_wrapper include, which can be modified to pass additional information if desired.

Results

Response Template: null (Only the requested file is returned.)

Used By

Applets: Configuration Manager

Resource Includes:

doc_file_get_copy

doc_odma_select_get

download_form_fields

email_docinfo_body_by_id

email_docinfo_body_by_name

legacy_workflow_in_queue_table

subscription_info_cell

subscription_info_cells

wf_in_queue_display

wf_review_cannot_view_msg

Templates:

CHECKOUT_OK (chkook.htm)

DOWNLOAD_OK (dwnldok.htm)

QUERY_NOTIFICATION (query_notification_mail.htm)

REDIRECTION_FILE_TEMPLATE (redirectionfile_template.htm)

REV_HISTORY (rev_history.htm)

SELECTDOC_OK (slctdcok.htm)

WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)

Other: SoapCustom:Wsdl:GetFile:Services

Example

IdcCommand command file format:

# Retrieve a web-viewable revision

IdcService=GET_FILE

dDocName=corporatereport

RevisionSelectionMethod=LatestReleased

Rendition=Web

HDA format:

@Properties LocalData

IdcService=GET_FILE

dID=54321

@end

Services Reference Guide

Core Content Server Services > Indexer Services (Core Content Server) > GET_FILE