URL Protocol
The following table lists Windows SharePoint Services Remote Procedure Call (RPC) methods that can be used in URL protocol to make HTTP GET requests. For more information about a specific method, click the command to see the related RPC method topic.
| Command (Cmd=) | Description | Parameters |
|---|---|---|
| dialogview | Opens a view of the document libraries within a site, of a specific document library, or of a folder within a document library that is used in a dialog box for opening or saving files; or opens the property form that is used when saving a file. | dialogview, location, FileDialogFilterValue |
| Display | Runs a database query against the list specified by a GUID and returns XML or HTML. | List, XMLDATA, View, Query, Using, CacheControl, ID |
| ExportList | Exports in CAML format the schema of the list specified by a GUID. | List |
| GetProjSchema | Requests the XML Schema for a Web site. | SiteTemplate |
| GetUsageBlob | Returns information about the usage of a Web site. | BlobType |
| HitCounter | Generates a hit on a page containing a hit counter. | Page, Image, Custom, Digits |
| RenderView | Requests the contents of a view for the list specified by a GUID. | List, View, URLBase |
The following parameters can also be used in the protocol:
- FileDialogFilterValue to set filters for a view and to return the list of all files of a specified type from a document library according to file name extension (for example, *.doc, *.ppt, or *.xls).
- FilterFieldn to specify the name of a field in the database, where n is an integer that is limited only by the number of fields allowed in the database table or by the length allowed for the URL field.
- FilterValuen to specify the string value on which to filter a field, where n is an integer that is limited only by the length allowed for the URL field.
- SortField to specify the name of the field on which to sort.
- SortDir to indicate an ascending (asc) or descending (desc) sort order.
- Using to specify the relative URL of a virtual file used in exporting an item or list, which can be one of the following values: vcard.vcf, event.ics, query.iqy, or query.bqy.
Using the URL protocol
Embedding a request in a URL is a basic mechanism for issuing a method and its parameters to a server running Microsoft Windows SharePoint Services. The syntax for using this mechanism is as follows:
http://Server_Name/[sites/][Site_Name/]_vti_bin/owssvr.dll?Cmd=Method_name[&Parameter1=Value1&Parameter2=Value2...]
The following example exports the schema of the list specified by a GUID:
http://Server_Name/[sites/][Site_Name/]_vti_bin/owssvr.dll?Cmd=ExportList&List=GUID
This example displays the Discussions list as a CAML file:
http://Server_Name/[sites/][Site_Name/]_vti_bin/owssvr.dll?Cmd=Display&List=GUID&XMLDATA=TRUE
The next example exports the Discussions list to a Microsoft Excel worksheet. Note that the GUID for the associated view must be assigned to the View parameter.
http://Server_Name/[sites/][Site_Name/]_vti_bin/owssvr.dll?CS=109&Using=_layouts/query.iqy&List=GUID&View=GUID&CacheControl=1
For information about how to use URL protocol to post requests, see Posting Windows SharePoint Services RPC Methods.