Reference

The references of one or more documents to display references for. You can return the values of all reference fields in the given documents (for example, to find the value of another reference field from a value that you know).

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.

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 Content Component 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 return only the values of a particular reference field by specifying the ReferenceField parameter.

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