URL commands for opening servers, databases, and views

The following commands access servers, databases, views, "About This Database" documents, Help documents, and database icons. Databases must be in the notes\data directory or a subdirectory of the notes\data directory in order to be accessed by a URL command, except server commands such as ?Login, ?Logout, and ?Redirect. You may use the name of a database that does not exist in the server command syntax if a database is required, as it is with Microsoft™ Internet Information Server. If the database referenced in a server command does not exist, it will be ignored. Use ?Redirect to redirect doclinks across servers. Hidden design elements are hidden from the server too; you can't use Domino® URL commands to access documents in hidden views.

CAUTION: If the database property "Do Not Allow URL Open" is set, these URL commands are disabled.

Note: The URLs shown are for example only. They do not point to existing Web sites.

Redirect

Syntax

http://Server/Dummy.nsf?Redirect&Name=notesserver&Id=To=encodedurl

Where:

http://Server refers to the Web server which is generating the URL.
Name=notesserver specifies a Domino® server name in its common or abbreviated form. This is optional when the "By Database" setting on the server is enabled.
ID=repid indicates the replica ID of the database to be located. This is an optional argument.
To=encodedurl specifies the rest of the URL.

Example

http://www.lotus-10.com/dummy.nsf?Redirect&Name=Mister%2FHankey&Id=0525666D0060ABBF&To=%FAView%3FOpenView

Note: If you force a logout using the ?Logout command, you can redirect to another Web site using the &RedirectTo parameter.

OpenDatabase

Syntax

http://Host/__DatabaseReplicaID.nsf?OpenDatabase

Examples

http://www.lotus-10.com/leads.nsf?OpenDatabase

http://www.lotus-10.com/sales/discussion.nsf?OpenDatabase

http://www.lotus-10.com/__852562F3007ABFD6.nsf?OpenDatabase

OpenView

Syntax

http://Host/Database/ViewName?OpenView

http://Host/Database/ViewUniversalID?OpenView

http://Host/Database/$defaultview?OpenView

Examples

http://www.lotus-10.com/leads.nsf/By+Salesperson?OpenView

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F300702264?OpenView

http://www.lotus-10.com/leads.nsf/$defaultview?OpenView

Optional arguments for OpenView

Append optional arguments to refine the URL. Combine any of the following arguments for the desired result except where otherwise noted.

Collapse=n

Where n is the row number to display in collapsed format in a hierarchical view. Do not combine this argument with the ExpandView or CollapseView arguments.

CollapseView

Displays the view in collapsed format

Count=n

Where n is the number of rows to display

Expand=n

Where n is the row number to display in expanded format in a hierarchical view. Do not combine this argument with the ExpandView or CollapseView arguments.

ExpandView

Displays the view in expanded format

RestrictToCategory=category

Sets the category for "Show Single Category" object

Where category is the category to be displayed in the view.

Start=n

Where n is the row number to start with when displaying the view. The row number in a hierarchical view can include sub indexes (for example, Start=3.5.1 means the view will start at the third main topic, sub-topic 5, document 1).

StartKey=string

Where string is a key to a document in the view. The view displays at that document.

Examples

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?OpenView&CollapseView

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?OpenView&ExpandView

http://www.lotus-10.com/leads.nsf/By+Category?OpenView&RestrictToCategory=pricing

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?OpenView&Start=3&Count=15

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?OpenView&StartKey=F

ReadViewEntries

Use this command to access view data in XML form without appearance attributes such as fonts, list separators, date formats, HTML settings, view templates and frame redirections.

Note: This command only returns the documents a user is allowed to access.

Syntax

http://Host/Database/ViewName?ReadViewEntries

http://Host/Database/ViewUniversalID?ReadViewEntries

http://Host/Database/$defaultview?ReadViewEntries

Examples

http://www.lotus-10.com/leads.nsf/By+Salesperson?ReadViewEntries

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F300702264?ReadViewEntries

http://www.lotus-10.com/leads.nsf/$defaultview?ReadViewEntries

Optional arguments for ReadViewEntries

Append optional arguments to refine the URL. Combine any of the following arguments for the desired result except where otherwise noted.

Collapse=n

Where n is the row number to display in collapsed format in a hierarchical view. Do not combine this argument with the ExpandView or CollapseView arguments.

CollapseView

Displays the view in collapsed format

Count=n

Where n is the number of rows to display

Endview=1

Causes the last document returned by ReadViewEntries to be the last document in the view. Use in conjunction with Count = n to view the last n documents in the view.

Expand=n

Where n is the row number to display in expanded format in a hierarchical view. Do not combine this argument with the ExpandView or CollapseView arguments.

ExpandView

Displays the view in expanded format

KeyType=text|time|number

Specifies the type of StartKey. The default when no argument is specified is text. Setting the KeyType to time allows you to use a time value as the value for StartKey which dictates from what row to display the view and the value for UntilKey, which specifies where to stop display of the view. If &KeyType=time is specified, then &StartKey and &UntilKey may be ISO date time values. For example, you might use the time value 20020101T140000,00Z to represent 9:00AM Eastern standard Time in Coordinated Universal Time (UTC) or Greenwich Mean Time (GMT), or you might use the time value 20020101T090000,00-05 to represent the same date and time in local time plus offset. Setting the KeyType to number when combined with the StartKey argument allows the specified StartKey to be treated as a numeric value.

NavigateReverse=1

Beginning with the starting document in the view, lists that starting document and documents with lesser row numbers.

Outputformat=JSON

Displays the view in a JavaScript™ Object Notation format.

PreFormat

Causes all data types to be converted to text on the server. Text lists, numbers, dates and lists of numbers are converted to text before being sent. The server's locale is used for all formatting. Without this argument, the XML output stream contains information in structured, locale-neutral formats.

ResortAscending=column number

ResortDescending=column number

Where column number is the 0-based number of the column in the view you wish to resort in ascending or descending alphanumeric order. Must be user sortable ("Click on Column Header to sort")

RestrictToCategory=category

Sets the category for the "Show Single Category" object, where category is the category to be displayed in the view

Start=n

Where n is the row number to start with when displaying the view. The row number in a hierarchical view can include subindexes (for example, Start=3.5.1 means the view will start at the third main topic, subtopic 5, document 1).

StartKey=string

Where string is a key to a document in sorted view. The view displays at that document. In cases where there is no match for the StartKey, the next document is returned. So, for example, if the StartKey is "A" and there are no documents that begin with "A", StartKey returns the first document that begins with "B."

UntilKey=string

UntilKey is only valid when used with StartKey. It allows you to display the range of view entries beginning with the document specified by StartKey until the document specified by UntilKey. For example, &StartKey=A&UntilKey=B would give you all the entries that start with A. Use the &Count keyword to further limit the number of entries returned within any given range.

Examples

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?ReadViewEntries&CollapseView

http://www.lotus-10.com/leads.nsf/By+Category?ReadViewEntries&Endview=1&Count=3

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?ReadViewEntries&ExpandView

http://www.lotus-10.com/leads.nsf/By+Category?ReadViewEntries&NavigateReverse=1&Start=50

http://www.lotus-10.com/leads.nsf/By+Category?ReadViewEntries&outputformat=JSON

http://www.lotus-10.com/leads.nsf/By+Category?ReadViewEntries&PreFormat

http://www.lotus-10.com/leads.nsf/By+Category?ReadViewEntries&RestrictToCategory=pricing

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?ReadViewEntries&Start=3&Count=15

http://www.lotus-10.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?ReadViewEntries&StartKey=F

http://www.lotus-10.com/leads.nsf/By+Department?ReadViewEntries&StartKey=312&KeyType=number

OpenAbout

Use the OpenAbout command to access the "About This Database" document.

Syntax

http://Host/Database/$about?OpenAbout

Example

http://www.lotus-10.com/leads.nsf/$about?OpenAbout

OpenHelp

Use the OpenHelp command to access the "Using This Database" document.

Syntax

http://Host/Database/$help?OpenHelp

Example

http://www.lotus-10.com/leads.nsf/$help?OpenHelp

OpenIcon

Use the OpenIcon command to access the database icon.

Syntax

http://Host/Database/$icon?OpenIcon

Example

http://www.lotus-10.com/leads.nsf/$icon?OpenIcon