IDOL Server 23.2

# Reference

The references of one or more documents whose content you want to display.

You should percent-encode document references. This ensures that any reserved characters that are part of a reference are not interpreted as query syntax. If you are sending HTTP requests using the content-type `application/x-www-form-urlencoded` you should percent-encode all parameter values, meaning that document references are percent-encoded twice. For more information, see Percent Encoding in Queries.

Reference encoding example.

If you have the following two references:

- http://www.example.com/?script.pl&query=test

- http://www.example.com/?script.pl&query=cat+dog

Percent-encode each reference:

    http%3A%2F%2Fwww%2Eexample%2Ecom%2F%3Fscript%2Epl%26query%3Dtest

    http%3A%2F%2Fwww%2Eexample%2Ecom%2F%3Fscript%2Epl%26query%3Dcat%2Bdog

Separate the two references with a plus symbol:

    http%3A%2F%2Fwww%2Eexample%2Ecom%2F%3Fscript%2Epl%26query%3Dtest+http%3A%2F%2Fwww%2Eexample%2Ecom%2F%3Fscript%2Epl%26query%3Dcat%2Bdog

If you send your HTTP request using the content-type `application/x-www-form-urlencoded`, all parameter values should be percent-encoded. When IDOL Server receives the request, the references should have been percent-encoded twice and the "+" separator should have been percent-encoded only once:

    http%253A%252F%252Fwww%252Eexample%252Ecom%252F%253Fscript%252Epl%2526query%253Dtest%2Bhttp%253A%252F%252Fwww%252Eexample%252Ecom%252F%253Fscript%252Epl%2526query%253Dcat%252Bdog

You can also set the ReferenceField parameter to specify the reference field that this reference must occur in.

You can also return the content of specific sections in documents by post-fixing a document `Reference` with the following string:

    $SectionNumber

where `SectionNumber` is the number of the document section whose content you want to return.

Actions: | GetContent
Type: | String
Default: |
Example: | `Reference=http%253A%252F%252Fwww%252Eexample%252Ecom%252F%253Fscript%252Epl%2526query%253Dtest%2Bhttp%253A%252F%252Fwww%252Eexample%252Ecom%252F%253Fscript%252Epl%2526query%253Dcat%252Bdog` In this example, documents that have the reference `http://www.example.com/?script.pl&query=test` and `http://www.example.com/?script.pl&query=cat+dog` are returned.
See Also: | ReferenceField

Copyright 2023 Open Text
Version 23.2 | Last updated March 2023

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Server 23.2

Topic Title: Reference