Reference
The reference of one or more documents to send by e-mail.
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 Community 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 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 to return.
NOTE: If you are using Reference
to specify document sections, you must percent-encode the document reference twice if it contains a space, plus symbol (+
), dollar symbol ($
), or ampersand (&
).
Actions: | Custom |
Type: | String |
Default: | |
Example: | Reference=http%253A%252F%252Fwww%252Eexample%252Ecom%252F%253Fscript%252Epl%2526query%253Dtest
This example returns documents that have the reference http://www.example.com/?script.pl&query=test and http://www.example.com/?script.pl&query=cat+dog .
|
See Also: |