SharePoint Front-End Protocols
The Microsoft SharePoint Products and Technologies protocol documentation provides detailed technical specifications for Microsoft proprietary protocols (including extensions to industry-standard or other published protocols) that are used by SharePoint Products and Technologies software (namely Microsoft Office SharePoint Server and Microsoft SharePoint Server as well as Windows SharePoint Services and SharePoint Foundation) to communicate with other Microsoft products.
This section includes a set of companion overview and reference documents pertaining to protocols where SharePoint Products and Technologies implement only one of the protocol endpoints. These protocols are intended for interoperability between SharePoint Products and Technologies and external applications. The documents supplement the technical specifications with conceptual background, overviews of inter-protocol relationships and interactions, and technical reference information.
Audience
The Microsoft SharePoint Products and Technologies protocol documentation is intended for use in conjunction with publicly available standard specifications, and network programming art. It assumes that the reader either is familiar with this material or has immediate access to it.
The technical documentation provides the following levels of audience support:
-
Implementer: Conceptual and reference information for an implementation of one or more protocol specifications for a given task or scenario.
-
Reviewer: A resource for readers who want to evaluate or understand one or more protocols.
| Specification | Description |
|---|---|
|
[MS-AADT]: Access Application Design Time Protocol Specification |
Specifies the Access Application Design Time Protocol. This protocol enables a protocol client to create, modify and delete objects in an application on the protocol server. A typical scenario for this protocol is a client application that allows a user to create a table and related forms that are stored on the protocol server. |
|
Specifies the Access Template File Format, which is a collection of structures used to define a database application including schemas for storing data, the data to be stored, layout descriptions for views of the data, actions controlling workflow, and metadata describing the database application as a whole. | |
|
[MS-ADMINS]: Administration Web Service Protocol Specification |
Specifies the Administration Web Service Protocol, which allows a protocol client to create and delete Web sites and to retrieve information about which languages are supported by a Web site. |
|
Specifies the Alerts Service Protocol, which allows the remote enumeration and management of alerts on a server running Windows SharePoint Services 3.0 Service Pack 1 (SP1). This protocol specifies how to list and delete alert subscriptions, but does not specify how to create or edit alert subscriptions. | |
|
[MS-APPMWSP]: SharePoint App Management Web Service Protocol Specification |
Specifies the web services that perform runtime operations to manage SharePoint Apps. The protocol includes information to interact with application permissions and application licenses |
|
Specifies the Access Run Time Protocol. This protocol enables a protocol client to read and write data that is stored by the protocol server. | |
|
Specifies the Access Server Design Time Protocol. This protocol enables a protocol client to create, modify and delete applications that are stored on the protocol server. | |
|
Specifies the Access Services Protocol, which enables a protocol client to run and monitor tasks on a server application. | |
|
[MS-AUTHWS]: Authentication Web Service Protocol Specification |
Specifies the Authentication Web Service Protocol, which enables a protocol client to determine which authentication mode is used by a Web application. If authentication requests for that application are redirected to an HTML form, this protocol also enables a protocol client and a protocol server to authenticate a user. |
|
Specifies the Access Application Transfer Protocol Structure which is a collection of Web services used by Access to communicate with a Microsoft Office SharePoint Server 2007 installation that has the Access Services feature enabled. This protocol specifies the file format for the representation of a database application, and can include structures for layout descriptions of views of data, actions to control workflow, the combining, filtering and ordering of data, and metadata to describe the database application as a whole. | |
|
[MS-AXL2]: Access Application Transfer Protocol Structure Version 2 |
Specifies a revision of ([MS-AXL]), specifying structures that can be used to describe data application components. This version includes structures for layout descriptions of data views, workflow control, and combining, filtering and ordering of data and metadata describing the entire database application. |
|
[MS-BCSDPFFS]: Business Connectivity Services Deployment Package File Format |
Specifies the Business Connectivity Services (BCS) Deployment Package File Format, which describes the contents of a deployment package for a BCS solution, the BCS-specific extensions to the Office Server ClickOnce application manifest, and a BCS-specific file format representing the properties of an external list. |
|
[MS-BCSDWPS]: Business Connectivity Services Deployment Web Service Protocol Specification |
Specifies the Business Connectivity Services Deployment Web Service Protocol, which enables a protocol client to create a profile page for an external content type, retrieve solution package information for a collection of server objects, and assign a custom form to a server object. |
|
[MS-BDCDP]: Business Data Catalog Data Web Service Protocol Specification |
Specifies the Business Data Catalog Data Web Service Protocol, which is an interface that protocol clients can use to search a line-of-business system (LOB system) for an EntityInstance that matches a user input string. |
|
[MS-BDCMP]: Business Data Catalog Metadata Web Service Protocol Specification |
Specifies the Business Data Catalog Metadata Web Service Protocol, which enables the clients to query the business data stored on the server-side business data catalog. |
|
[MS-BDCRAWPS]: Business Data Connectivity Remote Administration Web Service Protocol Specification |
Specifies the Business Data Connectivity Remote Administration Web Service Protocol. This protocol enables protocol clients to create, store, and retrieve information about interfaces of line-of-business systems (LOB systems). |
|
[MS-COMMCSOM]: Community Client-Side Object Model Protocol Specification |
Specifies the Community Client-Side Object Model Protocol. This protocol specifies types, methods, and properties that can be used to moderate the content in community sites on a collaboration server. |
|
[MS-CONATB]: Content Area Toolbox Web Service Protocol Specification |
Specifies the Content Area Toolbox Web Service Protocol, which allows a protocol client to enumerate the Web controls that are stored on a protocol server and can be used on a Web page. |
|
Specifies the Copy Web Service Protocol, which is used to copy files, including file metadata such as creation date and author, to one or more locations on a single protocol server or between different protocol servers. | |
|
[MS-CPSWS]: SharePoint Claim Provider Web Service Protocol Specification |
Specifies the SharePoint Claim Provider Web Service Protocol. This protocol enables a protocol client to access claims returned by the claim providers available on a protocol server. A typical scenario for this protocol is a client application that allows users to search and resolve users and groups from a set of directory services and external identity providers. |
|
This document specifies the SharePoint Client Query Protocol, which allows a protocol client to call methods and access data on a protocol server. The actions to be executed are sent by a protocol client as part of a request, and the results are returned by a protocol server as part of a response. | |
|
[MS-CSOMREST]: SharePoint Client Query OData Protocol Specification |
Specifies the SharePoint Client Query OData Protocol, which allows a protocol client to use common web technologies to send Open Data protocol (OData) request to access data on a protocol server when the protocol server implements SharePoint Client Query Protocol. |
|
[MS-CSOMSPT]: SharePoint Client-Side Object Model Protocol Specification |
Specifies the types, methods, and properties of the SharePoint Client-Side Object Model API Protocol that can be used to communicate with and manipulate aspects of a collaboration server. |
|
[MS-DMCSOM]: Document Management Client-Side Object Model Protocol Specification |
Specifies the Client-Side Object Model Protocol for Document Management. This protocol enables uploading videos to SharePoint and retrieving video embed codes without use of server-side object model. A typical scenario for this protocol is a client application wants to store a video on SharePoint and then embed it on an HTML page. |
|
[MS-DOCTRANS]: Document Transforms Service Protocol Specification |
Specifies the Document Transforms Service Protocol, which grants a protocol client the ability to call a file conversion service in order to convert a file from one format to another. |
|
[MS-DSPSTSS]: Data-Source Adapter SharePoint Team Services Web Service Protocol Specification |
Specifies the Data-Source Adapter SharePoint Team Services Web Service Protocol, which provides access to list data and site data by using a Web service. |
|
[MS-DWSS]: Document Workspace Web Service Protocol Specification |
Specifies the Document Workspace Web Service Protocol. This protocol is used to create, edit, and delete workspaces and folders for a SharePoint site configured as a Document Workspace. |
|
[MS-EAWF]: Group Approval Web Service Protocol Specification |
Specifies the Group Approval Web Service Protocol, which enables the protocol client to specify and retrieve data required to submit or approve Group Approval documents. |
|
[MS-ECTPWPS]: External Content Type Picker Web Service Protocol Specification |
Specifies the External Content Type Picker Web Service Protocol, which a protocol client uses to search and pick from external content types on a protocol server. |
|
[MS-EDCSOM]: eDiscovery Client-Side Object Model Protocol Specification |
Specifies the eDiscovery Client-Side Object Model Protocol, which provides types, methods, and properties to enable a protocol client to access and control electronic discovery (eDiscovery) data stored on a protocol server. |
|
[MS-EDINTWS]: eDiscovery Internal Web Service Protocol Specification |
Specifies the eDiscovery Internal Web Service Protocol, which enables a protocol client to perform operations, such as validating locations to find out if they can be used as discovery sources.TBD |
|
[MS-EDUCSOM]: Education Client-Side Object Model Protocol Specification |
Specifies the Education Client-Side Object Model Protocol. This protocol defines the set of education specific types, properties and methods to access and manipulate education data in academic collaboration sites such as courses, project groups, and curriculum planning. |
|
[MS-EMMCSOM]: Enterprise Managed Metadata Client-Side Object Model Protocol Specification |
Specifies the Enterprise Managed Metadata Client-Side Object Model Protocol, which provides types, methods, and properties to enable a protocol client to create, read, update, and delete enterprise metadata on a collaboration server. |
|
[MS-EMMWCF]: Metadata Shared Service WCF Service Protocol Specification |
Specifies the Metadata Shared Service WCF Service. This protocol is used to communicate with an application that manages a store of structured metadata. |
|
[MS-EMMWS]: Microsoft Enterprise Managed Metadata Web Service Protocol Specification |
Specifies the Enterprise Managed Metadata Web Service protocol, which enables a protocol client to interact with a managed metadata store. A typical scenario for using this protocol is tagging a document with managed metadata via a rich client application. |
|
Specifies the Excel Web Services Protocol, which is a Web service protocol that is used to read from and perform basic operations on workbooks hosted on a protocol server. | |
|
Specifies the Excel Services REST Protocol extensions to the Atom Publishing Protocol (AtomPub) [RFC5023] and its extensions specified in Atom Publishing Protocol: Data Services URI and Payload Extensions [MC-APDSU]. These extensions enable applications to expose spreadsheet data, using common Web technologies, as a data service that can be consumed by clients within corporate networks and across the Internet. | |
|
[MS-ESURL]: Excel Services Publishing Protocol Specification |
Specifies the Excel Services Publishing Protocol, which specifies how the protocol client should form the URL to the protocol server to display the contents of a published workbook in the browser. |
|
Specifies the Forms Service protocol. This protocol enables a client to get a list of forms from a protocol server and to get individual forms from that list. | |
|
[MS-FSDAP]: Forms Services Design and Activation Web Service Protocol Specification |
Specifies the Forms Services Design and Activation Web Service Protocol, which enables a form server to respond to requests from a protocol client. |
|
[MS-FSFDP]: Forms Services Feature Detection Protocol Specification |
Specifies the Forms Services Feature Detection Protocol, which enables a protocol client to detect if form server features are present, return the form server version, and construct the URL that is required to render a form in a Web browser. |
|
[MS-FSPP]: Forms Services Proxy Web Service Protocol Specification |
Specifies the Forms Services Proxy Web Service Protocol, which enables the protocol client to call a WSDL operation through a centralized service located on a known protocol server. |
|
[MS-FSSHTTP]: File Synchronization via SOAP over HTTP Protocol Specification |
Specifies the File Synchronization via SOAP over HTTP Protocol, which enables one or more protocol clients to synchronize changes done on shared files stored on a server. |
|
[MS-FSSHTTPB]: Binary Requests for File Synchronization via SOAP Protocol Specification |
Specifies the Binary Requests for File Synchronization via SOAP Protocol, which enables protocol clients to synchronize the state of a structured file hosted by a protocol server. |
|
[MS-FSSHTTPD]: Binary Data Format for File Synchronization via SOAP |
Specifies the MS-FSSHTTP schema for representing file data. This schema represents a traditional file, which is an array of bytes, efficiently in the MS-FSSHTTP storage model. A typical scenario for this schema is a client or server application transmitting a traditional file to or from an MS-FSSHTTP protocol server. |
|
Specifies the Imaging Services Protocol, a set of client-server interactions that allows a client to retrieve, upload, and organize images on a server. | |
|
Specifies the InfoPath Digital Signing Protocol, which enables a protocol client to work with a protocol server to apply a digital signature to a form file. | |
|
Specifies the InfoPath Form Template Format, which enables a form server to render and edit new or existing form files in a Web browser. | |
|
Specifies the InfoPath Form Template Format, which enables a form server to parse and retrieve the files inside the form template (.xsn) file. The form server can then use the information to render and edit a new or existing form file in a Web browser. | |
|
Specifies the InfoPath Form File Format, which, with an associated form template, specifies how a form server will render and edit the data in a form file using a Web browser. | |
|
Specifies the Lists Web Service Protocol, which enables a protocol client to perform tasks related to list-based content on a protocol server. | |
|
[MS-MAR]: Microsoft Office SharePoint Server (MOSS) Analytics Reporting Protocol Specification |
Specifies the MOSS Analytics Reporting Protocol, which enables a protocol client to log specific events and then retrieve analytical reports about Web traffic, search, and inventory for various entities in the farm. |
|
Specifies the Meetings Web Services Protocol, which provides methods to create and update Meeting Workspace sites. | |
|
Specifies the MetaWeblog Extensions Protocol, which are a set of extensions to the MetaWeblog API to allow for more secure authentication mechanisms. | |
|
Specifies extensions to the OAuth 2.0 Authentication Protocol. These extensions consist of additional parameters in the request URI and the JSON objects returned in the HTTP response body. | |
|
[MS-OFBA]: Office Forms Based Authentication Protocol Specification |
Specifies the Office Forms Based Authentication Protocol, which enables HTTP-based, forms authentication when other authentication mechanisms are not available. |
|
[MS-OFFICIALFILE]: Official File Web Service Protocol Specification |
Specifies the Official File Web Service Protocol, which enables the submission of files to a repository. Click here to view this version of the [MS-OFFICIALFILE] PDF. |
|
Specifies the Office Mobile Service (OMS) Protocol. This protocol is used to transmit text and mobile messages between a protocol client and a protocol server. | |
|
[MS-OOWQWS]: Office Online Web Query Web Service Protocol Specification |
Specifies the Office Online Web Query Web Service Protocol. This protocol is used to enumerate details about files in the Office Online repository. This protocol allows the user to traverse through the different categories in which the files are organized and query details about the categories along with the sub-categories and files organized under them. |
|
Specifies the Alerts Interoperability Protocol, which is used to identify and interpret Internet messages that can be sent to protocol clients when a document, Web page or other type of resource is changed on a protocol server. This protocol also specifies the syntax and semantics of user-defined fields in message headers of those messages. | |
|
Specifies the Office Server ClickOnce Manifest Structure which contains runtime information specific to a Visual Studio Tools for Office solution. | |
|
Specifies the Lists Client Sync Protocol, which allows clients to transfer data to and from a server that implements the Lists Web service. | |
|
Specifies the People Web Service Protocol, which enables a protocol client to resolve and find principals. This protocol allows the protocol client to pass criteria, which consist of a list of keys and the principal type, to the protocol server and to receive back a list of resolved principals. | |
|
Specifies the Permissions Web Service Protocol, which enables protocol clients to manage permissions to content items on the protocol server. | |
|
[MS-PLSP]: Published Links Web Service Protocol Specification |
Specifies the Published Links Web Service Protocol. This protocol specifies an operation that allows a protocol client to retrieve a list of potentially useful URLs and descriptive details about each URL. |
|
[MS-PPSAS]: PerformancePoint Services Authoring Service Protocol Specification |
Specifies the PerformancePoint Services Authoring Service Web Service Protocol, which specifies the communication sequences used to author a dashboard. |
|
[MS-PPSDECO]: PerformancePoint Services Decomposition Tree Protocol Specification |
Specifies the PerformancePoint Services Decomposition Tree Web Service Protocol, which is used by a protocol client to perform contribution analysis on data known to the protocol server. |
|
Specifies the Deployment Package Format, which is a file format that is used to serialize website content. | |
|
Specifies the ADO XML Persistence Format Protocol, which is a subset of the ADO XML Persistence Format used by some communication protocols to represent the tabular data retrieved from relational databases. | |
|
[MS-PUBCSOM]: Publishing Client-Side Object Model Protocol Specification |
Specifies the Publishing Client-Side Object Model Protocol. This protocol identifies types, methods, and properties that a protocol client uses to manage publishing web sites on a protocol server. |
|
Specifies the Publishing Web Service Protocol, which enables a protocol client to perform tasks related to template-based published content on a protocol server. | |
|
[MS-QUIZCSOM]: Education Quiz Client-Side Object Model Protocol Specification |
Specifies the Education Quiz Client-Side Object Model Protocol, which defines a set of quiz-specific properties and methods to access and manipulate the quiz data in academic collaboration sites such as courses and study groups. |
|
Specifies the Search Protocol that enables clients to make queries against an Enterprise Search service, the protocol server responding with a list of items that are relevant to the search query. This protocol also allows protocol clients to request query suggestions for a given search query. | |
|
[MS-SHDACCWS]: Shared Access Web Service Protocol Specification |
Specifies the interface of the Shared Access Web Service protocol that is used for determining whether a document is being co-authored. |
|
[MS-SITED3S]: Site Data 2003 Web Service Protocol Specification |
Specifies the Site Data 2003 Web Service Protocol, which is used for building the site content index. |
|
Specifies the Site Data Web Service Protocol, which is used for full and incremental indexing of the site content. | |
|
Specifies the Sites Web Services Protocol, which enables a protocol client to execute tasks on a site collection. | |
|
[MS-SLIDELI]: Slide Library Web Service Protocol Specification |
Specifies the Slide Library Web Service Protocol, which enables protocol clients to obtain information about slides in a slide library on protocol server. |
|
[MS-SPACSOM]: SharePoint Analytics Client-Side Object Model Protocol Specification |
Specifies the SharePoint Analytics Client-Side Object Model Protocol. This protocol provides types, methods, and properties to enable a protocol client to access usage information stored on a protocol server. |
|
[MS-SPAFWI]: SharePoint Activity Feed Web Interfaces Protocol Specification |
Specifies the SharePoint Activity Feed Web Interfaces Protocol, which specifies extensions for serializing and distributing social metadata about how the users of a Web site interact. |
|
[MS-SPDIAG]: SharePoint Diagnostics Web Service Protocol Specification |
Specifies the SharePoint Diagnostics Web Service Protocol, which enables the protocol client to submit diagnostic reports describing application errors that occur on the client. |
|
[MS-SPEMAWS]: SharePoint E-Mail Web Service Protocol Specification |
Specifies the SharePoint E-Mail Web Service Protocol, which enables system administrators to manage information about contacts and groups of contacts that are controlled by certain directory services. |
|
Specifies the SpellCheck Web Service Protocol, which enables a protocol client to check the spelling of a set of words. This protocol allows the protocol client to pass a set of texts to the protocol server and receive back from the protocol server a set of words identified as containing errors and suggestions for correcting those errors. | |
|
Specifies the Really Simple Syndication (RSS) 2.0 Format Extensions, which extend the semantics of specific elements of the RSS 2.0 syndication format for Web content. These extensions can be used to serialize data from a Web site, such as updates to a list of site content or search results. | |
|
[MS-SPS2SAUTH]: OAuth 2.0 Authentication Protocol: SharePoint Profile |
Specifies the OAuth 2.0 Authentication Protocol – SharePoint Profile, which is used for the server to server authentication among the applications that communicate over REST. |
|
Specifies the SPSCrawl Web Service Protocol, which allows clients to read the value of item properties for any items on the server. | |
|
[MS-SPSTWS]: SharePoint Security Token Service Web Service Protocol Specification |
Specifies the SharePoint Security Token Service Web Service Protocol, which defines restrictions for several related protocols and enables interoperability and authentication with Web services that are provided by protocol servers. |
|
[MS-SPWFCSOM]: SharePoint Workflow Client-Side Object Model Protocol Specification |
Specifies the SharePoint Workflow Client-Side Object Model Protocol. This protocol provides types, methods, and properties to enable a protocol client to manage and interact with workflow functionality on a collaboration server.TBD |
|
Specifies the Search Client Query Protocol. This protocol provides types, methods, and properties to enable a protocol client to issue search queries against a protocol server hosting a search service application. | |
|
Specifies the StsSync Data Structure, which is a structure for encoding parameters necessary to connect to a remote list. | |
|
[MS-TMPLDISC]: Template Discovery Web Service Protocol Specification |
Specifies the Template Discovery Web Service Protocol. This protocol enables a protocol client to retrieve links to document templates that are associated with a document library on a protocol server. |
|
[MS-TSCSOM]: Translation Services Client-Side Object Model Protocol Specification |
Specifies the Translation Services Client-Side Object Model Protocol, which enables protocol clients to request that documents be translated and view the status of translations. |
|
Specifies the UserGroup Web Service Protocol, which enables the definition, modification, and retrieval of information about users, groups, and roles. | |
|
[MS-UPSDWS]: User Profile Social Data Web Service Protocol Specification |
Specifies the User Profile Social Data Web Service Protocol, which is used to add, update, remove, and retrieve user-provided data that facilitates social networking. These data are in the form of tags, notes, and ratings about documents, Web pages, and other types of items that are stored on a protocol server. |
|
[MS-USPSWS]: User Profile Service Web Service Protocol Specification |
Specifies the User Profile Service Web Service Protocol, which is a Web service to retrieve user profile data and data in common among users, as well as manage user profile properties, links, group memberships, and colleagues. |
|
[MS-USRPCH]: User Profile Change Log Web Service Protocol Specification |
Specifies the User Profile Change Log Web Service Protocol, which is used to query and sync changes made to individual user profiles from client applications. |
|
Specifies the Versions Web Service Protocol, which enables a protocol client to view and modify the version information for an existing file on a protocol server. | |
|
Specifies the Views Web Service Protocol, which enables a protocol client to manage a list view. | |
|
Specifies the Office Document Update Utility Extensions, which is an extended protocol for synchronization management between a WebDAV client and a Document Workspace site on a WebDAV server. | |
|
[MS-WEBDAVE]: Web Distributed Authoring and Versioning Error Extensions Protocol Specification |
Specifies the Web Distributed Authoring and Versioning Error Extensions Protocol, which are the currently implemented extended error codes between WebDAV servers and WebDAV clients. |
|
Specifies the Webs Web Service Protocol, which provides methods for modifying SharePoint sites in the site collection. | |
|
[MS-WMCSOM]: Work Management Client-Side Object Model Protocol Specification |
Specifies the Work Management Client-Side Object Model Protocol, which defines types, methods, and properties that protocol clients use to access and manipulate tasks that are assigned to a user. |
|
[MS-WPPS]: Web Part Pages Web Service Protocol Specification |
Specifies the Web Part Pages Web Service Protocol, which enables a client to gather the information necessary to create browsable Web pages, and also uses server resources to create execution logic that reacts to changes in the server state. |
|
[MS-WSSCAML]: Collaborative Application Markup Language (CAML) Structure Specification |
Specifies the Collaborative Application Markup Language (CAML) Structure, which are XML-based formats for queries, lists, and content types in Windows SharePoint Services, as used by other protocols. |
|
[MS-WSSCAP]: Windows SharePoint Services Collaborative Application Protocol Specification |
Specifies the Windows SharePoint Services Collaborative Application Protocol, which is the communication between the client and front-end Web server to get and manipulate lists, list views, and Web discussions on the server. This protocol allows the client to manage the schema and properties of the lists, create, and modify fields, and render list views. This protocol also allows for retrieving the schemas of sites on the server. |
|
[MS-WSSHP]: HTTP Windows SharePoint Services Headers Protocol Specification |
Specifies the HTTP Windows SharePoint Services Headers Protocol, which extends the Hypertext Transfer Protocol (HTTP) mechanisms to include new headers and messages that enable previously undefined behaviors, such as authenticating client connections, communicating error conditions, sending complex data, and interacting with information rights management systems, antivirus systems, and crawlers. |
|
Specifies the ListData Data Service Protocol extensions to the Atom Publishing Protocol (AtomPub) and its extensions specified in Atom Publishing Protocol: Data Services URI and Payload Extensions. This protocol enables applications to expose list data, using common Web technologies, as a data service that can be consumed by clients within corporate networks and across the Internet. | |
|
[MS-WSSTS]: Windows SharePoint Services Technical Specification |
Specifies the Windows SharePoint Services Technical specification, which provides an overview of abstract data structures, and specifies fields, field types, and lists used by protocols used in Microsoft SharePoint Products and Technologies. |
|
Specifies the Workflow Web Service Protocol, which is the communication sequences used to query, start, and manipulate workflows on a document. |
