IDOL Server 24.4
IDOL Server Help

# GetAllRefs

Displays the references of all documents in IDOL Server.

NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

## Example

    http://12.3.4.56:9000/action=GetAllRefs

This action requests the references of all documents stored in IDOL Server.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
DatabaseMatch | The names of databases to return references from.
FieldName | The fields that contain the references to return
ID | The IDs of documents to return references for.
MaxDate | The latest date permitted for a result.
MinDate | The earliest date permitted for a result.
NodeInfo | Whether to return the size of each document.
OutputEncoding | The encoding to convert results to.
Reference | The references of documents to return references for.
ReferenceField | Restricts the Reference parameter to the specified reference field.
StateID | The name of a state token that specifies the documents to return references for.
StateMatchOriginalSection | Whether to return only sections from a state token that were matched in the original query.
Synchronous | Whether to run the action synchronously or asynchronously.

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