1.3 Overview

  • Article

The ReportService2006 web service protocol that is described in this document<1> provides methods for managing objects and settings on a report server [MSDN-SSRS] that is configured for SharePoint integrated mode [MSDN-SSMode]. Objects and settings that can be managed by the protocol include the following:

  • Security tasks, roles, and policies

  • Data source connections and credentials

  • Parameters for reports

  • Report execution and caching

  • Report history snapshots

  • Schedules

  • Subscriptions and deliveries of reports

  • Linked reports

  • Server system properties

Typically, the client establishes a connection with the server. After the connection is established by using the HTTP [RFC7230] or HTTPS [RFC2818] protocol, SOAP messages [SOAP1.1] [SOAP1.2-1/2007] are used to communicate between the client and the server.

The ReportService2006 web service protocol uses the security facilities that are built into HTTP or HTTPS for authentication and identification and for channel encryption negotiation. The protocol uses the facilities that are built into SOAP for specification of requests from client to server and for returning data from the server to the client. The following diagram depicts a (simplified) typical flow of communication in the protocol.

Communication flow for ReportService2006

Figure 1: Communication flow for ReportService2006

Each method in the protocol is a SOAP operation that accepts a set of parameters as a SOAP request and returns a set of values as a SOAP response. The client sends a request to the server through a SOAP request message, and the server sends return values to the client through a SOAP response message.

The following procedure describes a simple example client/server exchange for creating a report.

  1. The client calls the CreateReport method, which accepts the following parameters:

    • Report: The name of the new report

    • Parent: The full path name of the parent folder to which to add the report

    • Overwrite: A Boolean expression that indicates whether an existing report with the same name in the location specified is to be overwritten

    • Definition: The report definition to publish to the report server

    • Properties: An array of Property objects [MSDN-PropertyClass2006] that contains the property names and values to set for the report

  2. The server creates the report, modifies the ModifiedBy and ModifiedDate properties of the parent folder, and then returns an array of Warning objects [MSDN-WarningClass2006] that describes any warnings that occurred when the report definition was validated to the client.

    Note   If errors occur, the report is not created.