IDOL Server 24.4
IDOL Server Help

# GetContent

Allows you to display the content of one or more specified documents or document sections.

You must provide a document or set of documents by using at least one of ID, Reference, or StateID.

NOTE: If you use a Distributed Action Handler (DAH) to distribute the `GetContent` action, you cannot use any parameters that specify document IDs. Use parameters that identify documents by their reference instead.

## Example

    http://12.3.4.56:9000/action=GetContent&ID=10

This action requests the content of the document with the ID 10.

## Required Parameters

You must set at least one of the following parameters.

Parameter | Description
--- | ---
ID | The ID of the documents to return.
Reference | The references of documents to return.
StateID | A state token that specifies the documents to return.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Boolean | The format of the terms in the Links parameter.
Characters | The number of characters that a summary can contain.
DatabaseMatch | The database to retrieve results from.
DefaultOperator | The default operator to use between query terms in the text. You can use this parameter only if you set Boolean to `True`.
EndTag | The end HTML tag to apply to highlighted terms.
FieldRecurse | Returns the chain of values in a document ReferenceMemoryMappedType field.
FieldRestriction | Restricts a query to specified fields. You can use this parameter only if you set Boolean to `True`.
HardFieldRestriction | Whether to use only the fields that you list in the FieldRestriction parameter for matching in the Text and FieldText parameters. You can use this parameter only if you set Boolean to `True`.
Highlight | Whether to highlight link terms or sentences in the results.
HighlightTagTerm | Adds an attribute to the StartTag to indicate the term that is highlighted.
IgnoreSpecials | Treat special characters as normal characters in query syntax. You can use this parameter only if you set Boolean to `True`.
LanguageType | The language type of the terms.
Links | The terms to highlight.
MatchAllTerms | Return only results that match all terms in a query. You can use this parameter only if you set Boolean to `True`.
MaxPrintChars | The maximum number of terms to print in fields.
OutputEncoding | The encoding to convert the results to.
Print | The option to use to determine the fields to display.
PrintEngine | Whether to display information about the DAH child servers that results come from.
PrintFields | The fields to display in the results documents.
ReferenceField | The reference field that contains the references listed for Reference.
SecurityInfo | The security details.
Sentences | The number of sentences that the summary can contain.
StateMatchOriginalSection | Whether to return only sections from a state token that were matched in the original query.
StartTag | The opening HTML tag to apply to highlighted terms.
Stemming | Whether to disable stemming so that only documents that contain exact matches of query terms can return as results. You can use this parameter only if you set Boolean to `True`.
Summary | The type of summary to return with the document.
Synchronous | Whether to run the action synchronously or asynchronously.
XMLMeta | Whether to return additional metadata for each result.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.4

Topic Title: GetContent