Appendix B: Web Service Interface Reference

ReportingService Web Service

Creating a Web Reference to ReportingService

In order to use a web service, you need to create code that knows how to send data to and retrieve data from that web service. Fortunately, this code is generated for you by Visual Studio through the process of creating a web reference. Once the web reference is in place, you can call the methods of the web service the same way you call the methods of a local .NET assembly. Here are the steps for creating a web reference:

1. In your Visual Basic .NET or C# project (not a Report project), right-click the project entry in the Solution Explorer and select Add Web Reference from the context menu. The Add Web Reference dialog box will appear.

2. Select the link for Web Services on the Local Machine.

3. When the list of web services on the local machine appears, click the link for ReportService.

4. When the Reporting Service Description appears in the dialog box, click Add Reference.

When you click the link for Web Services on the Local Machine, a URL beginning with “http://localhost” is used to locate the web services on the local machine. Because of this, the Reporting Services web service will use “localhost.ReportingService” as its namespace.

Credentials and the ReportingService Web Service

Most ReportingService methods require logon credentials to be authenticated prior to their execution. This is accomplished by creating a network credential object and assigning it to the Credentials property of the ReportingService object. In the following code, a logon is accomplished prior to the execution of the ListChildren method. The ListChildren method returns an array with one element for each report item found in the specified folder (the Home folder in this example). The array will only contain those items that the specified credentials have the right to view.

Dim rs As localhost.ReportingService Dim LogonCredentials As System.Net.NetworkCredential Dim items As localhost.CatalogItem() rs = New localhost.ReportingService LogonCredentials = New _    System.Net.NetworkCredential("LogonName", "Password", "Domain") rs.Credentials = LogonCredential rs.PreAuthenticate = True items = rs.ListChildren("/", False)

Of course, if you were to use this sample code, you would need to replace LogonName, Password, and Domain with the appropriate logon name, password, and domain name for a valid domain logon. Also, this code sample assumes that you have created a web reference to the ReportingService web service called localhost.ReportingService, as described in the previous section.

When the PreAuthenticate property is true, the credentials are sent with the first web service request. When the PreAuthenticate property is false, the credentials are not sent to the server until the server issues an authentication challenge. In other words, when the PreAuthenticate property is false, the credentials are not sent to the server until the server requires a login. Setting the PreAuthenticate property to true can save one roundtrip between the server and the client, but as long as you have the Credentials property initialized to a valid logon, either setting for the PreAuthenticate property (true or false) will work.

Code Sample

Unfortunately, space restrictions prevent the inclusion of code samples for each of the ReportingService web service properties, methods, and classes. A sample program incorporating all these items is available for download from the web page for this book. Go to http://www.osborne.com and locate the book’s page using the ISBN 0072232161.

ReportingService Properties

BatchHeaderValue

Description: This property is used to hold a unique, system-generated batch ID. This batch ID serves to group multiple method calls from the ReportingService web service into a single batch. The batch ID is created by calling the CreateBatch method. The batch is committed by calling the ExecuteBatch method. The batch is rolled back by calling the CancelBatch method.

Credentials

Description: This property is used to hold the logon credentials used by the client application to authenticate on the ReportingService web service. Most ReportingService methods require authentication before they will execute.

PreAuthenticate

Description: When the PreAuthenticate property is true, the credentials are sent with the first web service request. When the PreAuthenticate property is false, the credentials are not sent to the server until the server issues an authentication challenge.

ReportingService Methods

CancelBatch

Description: This method cancels the current batch of ReportingService method calls. The current batch is specified by the BatchHeader object and must be assigned to the BatchHeaderValue property of the ReportingService object. If the batch is cancelled, none of the method calls in the batch is executed.

This method does not return a value.

Parameters: None

CancelJob

Description: This method cancels an executing job. This method returns true if the job was cancelled; otherwise, it returns false.

Parameters:

Name	Type	Description
JobID	String	The ID of the job to cancel

CreateBatch

Description: This method creates a batch ID that can be used to group ReportingService method calls into a batch. If an error occurs in one of the method calls in the batch, all previous operations performed by the batch are rolled back and subsequent operations are not attempted. This is useful when you have one ReportingService method call that depends on the successful completion of a prior ReportingService method call. For instance, you may call the CreateFolder method to create a new folder, and then call the CreateReport method to create a report in your new folder. You do not want to attempt to create the report if the folder cannot be created.

This method returns a batch ID string. This batch ID must be assigned to the batchID property of a BatchHeader object. The BatchHeader object must be assigned to the BatchHeaderValue property of the ReportingService object. The methods in the batch are not executed until the ExecuteBatch method is called to commit the batch.

Parameters: None

CreateDataDrivenSubscription

Description: This method creates a data-driven subscription for a report. This method returns a string containing the subscription ID.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report to which to subscribe
ExtensionSettings	ExtensionSettings Object	An object containing the settings for the delivery extension (for example, e-mail delivery) used by this subscription
DataRetrievalPlan	DataRetrievalPlan Object	An object containing the information necessary to connect to and retrieve the data used for the data-driven subscription
Description	String	The description of this subscription
EventType	String	Either “TimedSubscription” for a subscription triggered by a schedule or “SnapshotUpdated” for a subscription triggered by the updating of a snapshot
MatchData	String	Information used to implement the event type
Parameters	An Array of ParameterValueOrFieldReference Objects	An array of the values used for the report’s parameters

CreateDataSource

Description: This method creates a new shared data source. This method does not return a value.

Parameters:

Name	Type	Description
DataSource	String	The name of the data source
Overwrite	Boolean	True if this data source should overwrite an existing data source; otherwise, false
Parent	String	The path to the folder where the shared data source is created
Definition	DataSourceDefinition Object	An object containing the connection information for the shared data source
Properties	An Array of Property Objects	An array of property settings for the shared data source

CreateFolder

Description: This method creates a new Reporting Services folder in the specified folder. This method does not return a value.

Parameters:

Name	Type	Description
Folder	String	The name of the new folder
Parent	String	The path to the folder where the new folder is created
Properties	An Array of Property Objects	An array of property settings for the folder

CreateLinkedReport

Description: This method creates a new linked report in the specified folder. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The name of the new linked report
Parent	String	The path to the folder where the new linked report is created
Link	String	The folder path and name of the report to which the new linked report should be linked
Properties	An Array of Property Objects	An array of property settings for the new linked report

CreateReport

Description: This method creates a new report in the specified folder. This method returns an array of Warning objects.

Parameters:

Name	Type	Description
Report	String	The name of the new report
Parent	String	The path to the folder where the new report is created
Overwrite	Boolean	True if an existing report with the same name in the same folder is to be replaced with the new report; otherwise, false
Definition	An Array of Bytes	The Report Definition Language (RDL) defining the new report in base-64 binary
Properties	An Array of Property Objects	An array of property settings for the report

CreateReportHistorySnapshot

Description: This method creates a history snapshot of a specified report. The snapshot is created immediately, not at a scheduled time. This method call will fail if report history is not enabled for the specified report.

This method returns a string representing the data and time at which the history snapshot was created.

Parameters:

Name	Type	Description
Report	String	The Reporting Services folder and the report name of the report from which the history snapshot is created
Warnings	An Array of Warning Objects	An array of warning messages generated when creating this report history snapshot. (This parameter must be called ByRef.)

CreateResource

Description: This method creates a new resource entry in the specified folder. This method does not return a value.

Parameters:

Name	Type	Description
Resource	String	The name of the new resource
Parent	String	The path to the folder where the new resource is created
Overwrite	Boolean	True if an existing resource with the same name in the same folder is to be replaced with the new resource; otherwise, false
Contents	An Array of Bytes	The contents of the resource in base-64 binary
MimeType	String	The MIME type of the resource (260 characters maximum)
Properties	An Array of Property Objects	An array of property settings for the resource

CreateRole

Description: This method creates a new Reporting Services security role. This method does not return a value.

Parameters:

Name	Type	Description
Name	String	The name of the new role
Description	String	The description of the new role
Tasks	An Array of Task Objects	An array of Reporting Services tasks that may be executed by this role

CreateSchedule

Description: This method creates a new shared schedule. This method returns a string containing the schedule ID.

Parameters:

Name	Type	Description
Name	String	The name of the schedule
ScheduleDefinition	ScheduleDefinition Object	An object containing the information necessary to define a schedule

CreateSubscription

Description: This method creates a new subscription for a report. This method returns a string containing the subscription ID.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report to which to subscribe
ExtensionSettings	ExtensionSettings Object	An object containing the settings for the delivery extension (for example, e-mail delivery) used by this subscription
Description	String	The description of this subscription
EventType	String	Either “TimedSubscription” for a subscription triggered by a schedule or “SnapshotUpdated” for a subscription triggered by the updating of a snapshot
MatchData	String	Information used to implement the event type
Parameters	An Array of ParameterValue Objects	An array of the values used for the report’s parameters

DeleteItem

Description: This method removes an item from a Reporting Services folder. This can be a report, a resource, a shared data source, or a Reporting Services folder. If a report is deleted, any subscriptions and snapshots associated with that report are also deleted. This method does not return a value.

You cannot use this method to delete the My Reports folder or the Users folders created when the My Reports option is enabled.

Parameters:

Name	Type	Description
Item	String	The folder path and name of the item to be deleted

DeleteReportHistorySnapshot

Description: This method removes a specified history snapshot. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report from which the history snapshot is to be deleted
HistoryID	String	The ID of the history snapshot to delete

DeleteRole

Description: This method removes a Reporting Services security role. This will also remove all security assignments involving the deleted security role. This method does not return a value.

Parameters:

Name	Type	Description
Name	String	The name of the security role to delete

DeleteSchedule

Description: This method removes a shared schedule. In addition, any snapshots or subscriptions using this schedule are also deleted. This method does not return a value.

Parameters:

Name	Type	Description
ScheduleID	String	The schedule ID of the schedule to delete

DeleteSubscription

Description: This method removes a subscription from a report. This method does not return a value.

Parameters:

Name	Type	Description
SubscriptionID	String	The subscription ID of the subscription to delete

DisableDataSource

Description: This method disables a shared data source. Any reports and data-driven subscriptions that use this shared data source will not execute. This method does not return a value.

Parameters:

Name	Type	Description
DataSource	String	The folder path and name of the shared data source to be disabled

EnableDataSource

Description: This method enables a shared data source. This method does not return a value.

Parameters:

Name	Type	Description
DataSource	String	The folder path and name of the shared data source to be enabled

ExecuteBatch

Description: This method executes all method calls that have been associated with the current batch. (See the CreateBatch method.) The method calls in the batch are not executed until the ExecuteBatch method is called. This method does not return a value.

Parameters: None

FindItems

Description: This method finds reports, resources, shared data sources, and folders whose name or description satisfies the search conditions. The contents of the specified folder and all the folders contained within that folder will be searched. This method returns an array of CatalogItem objects that satisfy the search conditions.

Parameters:

Name	Type	Description
Folder	String	The folder path and name of the folder that serves as the root of the search
BooleanOperator	BooleanOperatorEnum	Either AND if all of the search conditions must be true; otherwise, OR if only one of the search conditions must be true
Conditions	An Array of SearchCondition Objects	An array containing the search conditions

FireEvent

Description: This method triggers a Reporting Services event. You can use the ListEvents method to get an array of valid events and their parameters. This method does not return a value.

Parameters:

Name	Type	Description
EventType	String	The name of the event
EventData	String	The values for the parameters associated with this event

FlushCache

Description: This method clears any cached copies of the specified report. This includes cached copies created both by caching and by execution snapshots. It will not clear history snapshots. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose cache is to be flushed

GetCacheOptions

Description: This method checks whether there is a cached copy of the specified report. If there is a cached copy of the report, the expiration time or the scheduled expiration information for the cached copy is returned in the Item parameter. This method returns a boolean, which is true if caching is enabled for the report; otherwise, it returns false.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose cache options are to be checked.
Item	ExpirationDefinition Object	An object containing the expiration information for the cached copy of the report. (This parameter must be called ByRef.)

GetDataDrivenSubscriptionProperties

Description: This method gets the information from the specified data-driven subscription. The data-driven subscription information is returned in several reference parameters. This method returns a string containing the ID of the owner of the specified data-driven subscription.

Parameters:

Name	Type	Description
DataDrivenSubscriptionID	String	The data-driven subscription ID of the data-driven subscription whose information is to be returned.
ExtensionSettings	ExtensionSettings Object	An object containing the extension settings. (This parameter must be called ByRef.)
DataRetrievalPlan	DataRetrievalPlan Object	An object containing the data source and query used to select data for the data-driven subscription. (This parameter must be called ByRef.)
Description	String	The description of the data-driven subscription. (This parameter must be called ByRef.)
Active	ActiveState Object	An object containing the active state of the data-driven subscription. (This parameter must be called ByRef.)
Status	String	The status of the data-driven subscription. (This parameter must be called ByRef.)
EventType	String	The event type associated with the data-driven subscription. (This parameter must be called ByRef.)
MatchData	String	The parameter data for the event type associated with the data-driven subscription. (This parameter must be called ByRef.)
Parameters	An Array of ParameterValueOrFieldReference Objects	An array of parameter information for the report associated with the data-driven subscription. (This parameter must be called ByRef.)

GetDataSourceContents

Description: This method gets the information for the specified shared data source. This method returns a DataSourceDefinition object containing the information for the shared data source.

Parameters:

Name	Type	Description
DataSource	String	The folder path and name of the shared data source whose information is to be returned

GetExecutionOptions

Description: This method gets the execution options for the specified report. This method returns an ExecutionSettingEnum value of either “Live,” indicating the report will be executed, or “Snapshot,” indicating the report will be rendered from a history snapshot.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose execution option is to be returned.
Item	ScheduleDefinitionOrReference Object	An object containing a schedule definition or a reference to a shared schedule. (This parameter must be called ByRef.)

GetExtensionSettings

Description: This method gets the parameter information for the specified delivery extension. This method returns an array of ExtensionParameter objects containing the parameter information.

Parameters:

Name	Type	Description
Extension	String	The name of the delivery extension

GetItemType

Description: This method gets the type of the specified Reporting Services item. This method returns an ItemTypeEnum value as shown here:

Value	Description
Unknown	Invalid Item Path or Item of Unknown Type
Folder	This item is a folder
Report	This item is a report
Resource	This item is a resource
LinkedReport	This item is a linked report
DataSource	This item is a shared data source

Parameters:

Name	Type	Description
Item	String	The folder path and name of the item whose type is to be returned

GetPermissions

Description: This method gets the tasks that may be executed on the specified Reporting Services item by the logon credentials currently being used to access the ReportingService web service. This method returns an array of strings, with each string containing the name of one task that the logon credentials have permission to execute.

Parameters:

Name	Type	Description
Item	String	The folder path and name of the item whose permissions are to be returned

GetPolicies

Description: This method gets the Reporting Services security policies associated with the specified Reporting Services item. This method returns an array of Policy objects.

Parameters:

Name	Type	Description
Item	String	The folder path and name of the item whose policies are to be returned.
InheritParent	Boolean	True if the policies are inherited from the parent folder; otherwise, false. (This parameter must be called ByRef.)

GetProperties

Description: This method gets the values of each specified property of the Reporting Services item. This method returns an array of Property objects.

Parameters:

Name	Type	Description
Item	String	The folder path and name of the item whose properties are to be returned
Properties	An Array of Property Objects	An array of the properties whose values you want returned

GetRenderResource

Description: This method gets a resource for the specified rendering extension. This method returns a byte array containing a base-64 encoding of the requested resource.

Parameters:

Name	Type	Description
Format	String	The rendering extension format (for example, PDF or XML).
DeviceInfo	String	A device-specific setting for the specified rendering format.
MimeType	String	The MIME type of the resource. (This parameter must be called ByRef.)

GetReportDataSourcePrompts

Description: This method gets the prompt strings for all the data sources tied to the specified report. This method returns an array of DataSourcePrompt objects.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose data source prompts are to be returned

GetReportDataSources

Description: This method gets the data sources tied to the specified report. This method returns an array of DataSource objects.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose data sources are to be returned

GetReportDefinition

Description: This method gets the definition for the specified report. This method returns a byte array with the report definition as a base-64 encoded RDL structure.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose definition is to be returned

GetReportHistoryLimit

Description: This method gets the maximum number of history snapshots that may be saved for the specified report. This method returns an integer representing the history snapshot limit.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose snapshot history limit is to be returned.
IsSystem	Boolean	True if the report history snapshot limit comes from the system limit; otherwise, false. (This parameter must be called ByRef.)
SystemLimit	Integer	The system limit for report history snapshots. (This parameter must be called ByRef.)

GetReportHistoryOptions

Description: This method gets the report history snapshot options and properties for the specified report. This method returns a boolean value that is true if a history snapshot is enabled and is false otherwise.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose snapshot history options are to be returned.
KeepExecutionSnapshots	Boolean	True if a history snapshot is enabled; otherwise, false. (This parameter must be called ByRef.)
Item	ScheduleDefinitionOrReference Object	An object that contains information about a schedule definition or a reference to a shared schedule that is used to create the history snapshot. (This parameter must be called ByRef.)

GetReportLink

Description: This method gets the name of the report to which the specified linked report is tied. This method returns a string containing the folder path and the name of the report.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the linked report whose underlying report is to be returned

GetReportParameters

Description: This method gets the report parameter properties for the specified report. This method returns an array of ReportParameter objects.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose parameter properties are to be returned.
HistoryID	String	Set this parameter to a history ID to retrieve the parameters for a history snapshot; otherwise, set it to Nothing (Null for C#).
ForRendering	Boolean	Set this parameter to true to return the parameter properties used during the creation of the specified history snapshot; otherwise, set it to false.
Values	An Array of ParameterValue Objects	An array of the values that will be validated for the report.
Credentials	An Array of DataSourceCredential Objects	An array specifying data source credentials to be used when validating parameters.

GetResourceContents

Description: This method gets the contents of a Reporting Services resource. This method returns a byte array containing the base-64 encoded contents of the resource.

Parameters:

Name	Type	Description
Resource	String	The folder path and name of the resource whose contents are to be returned.
MimeType	String	This is the MIME type of the resource. (This parameter must be called ByRef.)

GetRoleProperties

Description: This method gets a description of the specified role, along with the tasks this role is able to complete. This method returns an array of Task objects.

Parameters:

Name	Type	Description
Name	String	The name of the role whose description and tasks are to be returned.
Description	String	The description of the role. (This parameter must be called ByRef.)

GetScheduleProperties

Description: This method gets the properties of the specified shared schedule. This method returns a Schedule object.

Parameters:

Name	Type	Description
ScheduleID	String	The schedule ID of the schedule to be returned

GetSubscriptionProperties

Description: This method gets the properties of the specified subscription. This method returns a string containing the ID of the owner of this subscription.

Parameters:

Name	Type	Description
SubscriptionID	String	The subscription ID of the subscription whose properties are to be returned.
ExtensionSettings	An ExtensionSettings Object	An object containing the settings for the delivery extension associated with this subscription. (This parameter must be called ByRef.)
Description	String	The description of the subscription. (This parameter must be called ByRef.)
Active	An ActiveState Object	An object containing the active state of the subscription. (This parameter must be called ByRef.)
Status	String	The status of the subscription. (This parameter must be called ByRef.)
EventType	String	Either “TimedSubscription” for a subscription triggered by a schedule or “SnapshotUpdated” for a subscription triggered by the updating of a snapshot. (This parameter must be called ByRef.)
MatchData	String	Information used to implement the event type. (This parameter must be called ByRef.)
Parameters	An Array of ParameterValue Objects	An array of the values used for the report’s parameters. (This parameter must be called ByRef.)

GetSystemPermissions

Description: This method gets the system permissions assigned to the logon credentials currently being used to access the ReportingService web service. This method returns an array of strings that contain the system permissions.

Parameters: None

GetSystemPolicies

Description: This method gets the system role assignments for this Reporting Services installation. This method returns an array of Policy objects.

Parameters: None

GetSystemProperties

Description: This method gets the value of each specified system property. This method returns an array of Property objects.

Parameters:

Name	Type	Description
Properties	An Array of Property Objects	An array of properties and their values

InheritParentSecurity

Description: This method sets the Reporting Services item to inherit its security from its parent folder. As a result, any role assignments made specifically for this item will be deleted. This method does not return a value.

Parameters:

Name	Type	Description
Item	String	The folder path and name of the item whose security is to be inherited

ListChildren

Description: This method lists all the Reporting Services items that are children of the specified folder. The list includes only those items that the logon credentials currently being used to access the ReportingService web service have a right to view. This method returns an array of CatalogItem objects.

Parameters:

Name	Type	Description
Item	String	The folder path and name of the folder whose children are to be listed
Recursive	Boolean	True if the list should recurse down the folder tree; otherwise, false

ListEvents

Description: This method lists the events supported by this Reporting Services installation. This method returns an array of Event objects.

Parameters: None

ListExtensions

Description: This method lists the extensions of the specified type that have been defined for this Reporting Services installation. This method returns an array of Extension objects.

Parameters:

Name	Type	Description
ExtensionType	ExtensionTypeEnum	Either Delivery for delivery extensions, Render for rendering extensions, Data for data access extensions, or All for all of the above

ListJobs

Description: This method lists the jobs that are currently running on this Reporting Services installation. This method returns an array of Job objects.

Parameters: None

ListLinkedReports

Description: This method lists the linked reports tied to a specific report. This method returns an array of CatalogItem objects.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose linked reports are to be listed

ListReportHistory

Description: This method lists the history snapshots and their properties for the specified report. This method returns an array of ReportHistorySnapshot objects.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose history snapshots are to be listed

ListReportsUsingDataSource

Description: This method lists the reports using the specified shared data source. This method returns an array of CatalogItem objects.

Parameters:

Name	Type	Description
DataSource	String	The folder path and name of the shared data source whose reports are to be listed

ListRoles

Description: This method lists the roles defined for this Reporting Services installation. This method returns an array of Role objects.

Parameters: None

ListScheduledReports

Description: This method lists the reports using the specified shared schedule. This method returns an array of CatalogItem objects.

Parameters:

Name	Type	Description
ScheduleID	String	The schedule ID of the shared schedule whose reports are to be listed

ListSchedules

Description: This method lists all the shared schedules. This method returns an array of Schedule objects.

Parameters: None

ListSecureMethods

Description: This method lists all the ReportingService web service methods that require a secure connection. This method returns an array of strings containing the method names.

Parameters: None

ListSubscriptions

Description: This method lists the subscriptions that a specified user has created for a specified report. This method returns an array of Subscription objects.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose subscriptions are to be listed
Owner	String	The name of the owner whose subscriptions are to be retrieved

ListSubscriptionsUsingDataSource

Description: This method lists the subscriptions using the specified shared data source. This method returns an array of Subscription objects.

Parameters:

Name	Type	Description
DataSource	String	The folder path and name of the shared data source whose subscriptions are to be listed

ListSystemRoles

Description: This method lists the system roles defined for this Reporting Services installation. This method returns an array of Role objects.

Parameters: None

ListSystemTasks

Description: This method lists the system tasks defined for this Reporting Services installation. This method returns an array of Task objects.

Parameters: None

ListTasks

Description: This method lists the tasks defined for this Reporting Services installation. This method returns an array of Task objects.

Parameters: None

MoveItem

Description: This method moves the specified Reporting Services item to the specified folder path. This method does not return a value.

Parameters:

Name	Type	Description
Item	String	The folder path and name of the item to be moved
Target	String	The folder path to which this item is to be moved

PauseSchedule

Description: This method pauses the execution of the specified schedule. This method does not return a value.

Parameters:

Name	Type	Description
ScheduleID	String	The ID of the schedule to pause

PrepareQuery

Description: This method determines the fields that will be returned by the specified query running against the specified data source. This information can be used by the CreateDataDrivenSubscription and SetDataDrivenSubscriptionProperties methods. This method returns a DataSetDefinition object.

Parameters:

Name	Type	Description
DataSource	DataSource Object	An object containing the data source information.
DataSet	DataSetDefinition Object	An object containing the query to return the fields for the data-driven subscription.
Changed	Boolean	True if the dataset passed in the DataSet parameter is different from the dataset returned in the DataSetDefinition object; otherwise, false. (This parameter must be called ByRef.)

Render

Description: This method renders the specified report. This method returns a byte array containing the rendered report.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report to be rendered.
Format	String	The rendering format to be used.
HistoryID	String	The ID of the history snapshot from which to render the report. (Set this to Nothing if the report should not be rendered from a history snapshot.)
DeviceInfo	String	An XML structure to control the behavior of the Report Viewer.
Parameters	An Array of ParameterValue Objects	An array of values for the report parameters.
Credentials	An Array of DataSourceCredentials Objects	An array of credentials to use when accessing the data sources.
ShowHideToggle	String	The Show/Hide Toggle ID. (Set this to Nothing when not used.)
Encoding	String	The encoding used for the contents of the report. (This parameter must be called ByRef.)
MimeType	String	The MIME type of the rendered report. (This parameter must be called ByRef.)
ParametersUsed	An Array of ParameterValue Objects	If the report is rendered from a history snapshot, this will contain an array of the parameter values used to create the history snapshot. (This parameter must be called ByRef.)
Warnings	An Array of Warning Objects	An array containing any warnings that resulted from the rendering of the report. (This parameter must be called ByRef.)
StreamIDs	String	A stream identifier used by the RenderStream method. This is used to render an external resource such as an image. (This parameter must be called ByRef.)

RenderStream

Description: This method obtains the contents of an external resource used by a rendered report. This method returns a byte array containing the external resource.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report associated with the specified resource.
Format	String	The rendering format to be used.
StreamID	String	The ID of the stream for the main report.
HistoryID	String	The ID of the history snapshot from which to render the report. (Set this to Nothing if the report should not be rendered from a history snapshot.)
DeviceInfo	String	An XML structure to control the behavior of the Report Viewer.
Parameters	An Array of ParameterValue Objects	An array of values for the report parameters.
Encoding	String	The encoding used for the contents of the report. (This parameter must be called ByRef.)
MimeType	String	The MIME type of the rendered report. (This parameter must be called ByRef.)

ResumeSchedule

Description: This method resumes a schedule that has been paused. This method does not return a value.

Parameters:

Name	Type	Description
ScheduleID	String	The ID of the schedule to resume

SetCacheOptions

Description: This method sets the caching options for the specified report. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose caching options are to be set
CacheReport	Boolean	True if each execution of the report is to be cached; otherwise, false
Item	ExpirationDefinition Object	An object containing information telling when the cached report is to expire

SetDataDrivenSubscriptionProperties

Description: This method sets the properties of a data-driven subscription. This method does not return a value.

Parameters:

Name	Type	Description
DataDrivenSubscriptionID	String	The ID of the data-driven subscription whose properties are to be set
ExtensionSettings	ExtensionSettings Object	An object containing the settings for the delivery extension (for example, e-mail delivery) used by this subscription
DataRetrievalPlan	DataRetrievalPlan Object	An object containing the information necessary to connect to and retrieve the data used for the data-driven subscription
Description	String	The description of this subscription
EventType	String	Either “TimedSubscription” for a subscription triggered by a schedule or “SnapshotUpdated” for a subscription triggered by the updating of a snapshot
MatchData	String	Information used to implement the event type
Parameters	An Array of ParameterValueOrFieldReference Objects	An array of the values used for the report’s parameters

SetDataSourceContents

Description: This method sets the properties of a shared data source. This method does not return a value.

Parameters:

Name	Type	Description
DataSource	String	The name of the data source
Definition	DataSourceDefinition Object	An object containing the connection information for the shared data source

SetExecutionOptions

Description: This method sets the execution options of the specified report. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose execution option is to be set.
ExecutionSetting	ExecutionSettingEnum	Either Live if the report is to be executed from the data sources or Snapshot if the report is to come from an execution snapshot.
Item	ScheduleDefinitionOrReference Object	An object containing the information for a schedule or a reference to a shared schedule. This schedule is used to create the execution snapshot and is valid only if the ExecutionSetting is Snapshot.

SetPolicies

Description: This method sets the security policies for the specified report. This method does not return a value.

Parameters:

Name	Type	Description
Item	String	The folder path to the Reporting Services item for which the security policies are to be set
Policies	An Array of Policy Objects	An array of security policy information

SetProperties

Description: This method sets the properties of the specified Reporting Services item. This method does not return a value.

Parameters:

Name	Type	Description
Item	String	The folder path to the Reporting Services item for which the properties are to be set
Properties	An Array of Property Objects	An array of properties and their values

SetReportDataSources

Description: This method sets the properties for data sources associated with the specified report. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path to the report for which the data source properties are to be set
DataSources	An Array of DataSource Objects	An array of data sources and their properties

SetReportDefinition

Description: This method sets the report definition of the specified report. This method returns an array of Warning objects containing any warning messages that may result from this operation.

Parameters:

Name	Type	Description
Report	String	The folder path to the report for which the report definition is to be set
Definition	An Array of Bytes	A byte array containing the Report Definition Language (RDL) in base-64 binary

SetReportHistoryLimit

Description: This method sets the limit for the number of history snapshots that may be saved for the specified report. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path to the report for which the history snapshot limit is to be set
UseSystem	Boolean	True if the system default history snapshot limit is to be used with this report; otherwise, false
HistoryLimit	Integer	The limit for the number of history snapshots saved for this report

SetReportHistoryOptions

Description: This method sets the options specifying when a history snapshot is created for the specified report. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path to the report for which the history snapshot options are to be set.
EnableManualSnapshotCreation	Boolean	True if snapshots can be created using the CreateReportHistorySnapshot method; otherwise, false.
KeepExecutionSnapshots	Boolean	True if execution snapshots are saved as history snapshots; otherwise, false.
Item	ScheduleDefinitionOrReference Object	An object containing the information for a schedule or a reference to a shared schedule. This schedule is used to create the history snapshot.

SetReportLink

Description: This method sets the report to which the specified linked report should be linked. This method does not return any value.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the linked report
Link	String	The folder path and name of the report to which this should be linked

SetReportParameters

Description: This method sets the parameter property for the specified report. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose parameter property should be set
Parameters	An Array of ReportParameter Objects	An array of information on report parameter properties

SetResourceContents

Description: This method sets the contents of a Reporting Services resource. This method does not return a value.

Parameters:

Name	Type	Description
Resource	String	The folder path and name of the resource whose contents is to be set
Contents	An Array of Bytes	The contents of the resource in base-64 binary
MimeType	String	The MIME type of the resource

SetRoleProperties

Description: This method sets the properties of a security role. This method does not return a value.

Parameters:

Name	Type	Description
Name	String	The folder path and name of the security role whose properties are to be set
Description	String	The description of the security role
Tasks	An Array of Task Objects	An array of Reporting Services tasks that may be executed by this role

SetScheduleProperties

Description: This method sets the properties of a shared schedule. This method does not return a value.

Parameters:

Name	Type	Description
Name	String	The name of the shared schedule
ScheduleID	String	The ID of the shared schedule whose properties are to be set
ScheduleDefinition	ScheduleDefinition Object	An object containing the information necessary to define a schedule

SetSubscriptionProperties

Description: This method sets the properties of a subscription. This method does not return a value.

Parameters:

Name	Type	Description
SubscriptionID	String	The ID of the subscription whose properties are to be set
ExtensionSettings	ExtensionSettings Object	An object containing the settings for the delivery extension (for example, e-mail delivery) used by this subscription
Description	String	The description of this subscription
EventType	String	Either “TimedSubscription” for a subscription triggered by a schedule or “SnapshotUpdated”for a subscription triggered by the updating of a snapshot
MatchData	String	Information used to implement the event type
Parameters	An Array of ParameterValue Objects	An array of the values used for the report’s parameters

SetSystemPolicies

Description: This method sets the system role assignments for this Reporting Services installation. This method does not return a value.

Parameters:

Name	Type	Description
Policies	An Array of Policy Objects	An array of the values used to set the system policies

SetSystemProperties

Description: This method sets the specified system properties. This method does not return a value.

Parameters:

Name	Type	Description
Properties	An Array of Property Objects	An array of properties and their values

UpdateReportExecutionSnapshot

Description: This method updates the report execution snapshot for the specified report. This method does not return a value.

Parameters:

Name	Type	Description
Report	String	The folder path and name of the report whose execution snapshot is to be updated

ValidateExtensionSettings

Description: This method validates the settings for a Reporting Services extension. This method returns an array of ExtensionParameter objects.

Parameters:

Name	Type	Description
Extension	String	The name of the extension
ParameterValues	An Array of ParameterValueOrFieldReference Objects	An array of parameter values that are to be validated

ReportingService Web Service Classes

The Namespace for ReportingService Web Service Classes

The namespace for ReportingService web service classes is the same as the namespace used for ReportingService itself. If the ReportingService has a namespace of

localhost.ReportingService

then the namespace for each ReportingService web service class would be

localhost.{ClassName}

where {ClassName} is the name of one of the classes.

The “Specified” Properties

Many of the properties for these classes have a corresponding property by the same name, with “Specified” on the end. These properties are used to let any code using the class know if a value has been specified for this property or if it has been left with no value specified. In most cases, these “specified” properties are added to correspond to class properties with data types of boolean, date, and others that cannot easily represent an empty state.

For example, the DataSourceDefinition class has a property named Enabled. When this property is set to true, the data source is enabled. When this property is set to false, the data source is disabled. If you do not specify a value for this property, it will default to false and the data source will be disabled. To prevent this from happening, a property called EnabledSpecified of type boolean has been added to the DataSourceDefinition class. This additional property lets the code using this class know whether the value for the Enabled property should be used because it has been specified by the user or if it should be ignored because it has not been specified.

It is up to you as the developer to make sure that these “specified” properties are set properly. Any time you provide a value for a property that has a corresponding “specified” property, you need to set that “specified” property to true. If you do not take care of this in your code, these property values will be ignored by the methods that are using these classes.

In some cases, “specified” properties have been added for class properties that are read-only. This would seem to make no sense because you cannot specify a value for a property that is read-only. Nevertheless, there they are. In these cases, the “specified” properties can be safely ignored.

ActiveState

Description: An object of the ActiveState class type is returned by the GetSubscriptionProperties method to provide information on various error conditions that may be present in a specified subscription. In addition to the properties listed here, this class includes a “specified” property for each of the properties shown. These “specified” properties can be ignored.

Properties:

Property	Type	Description
DeliveryExtensionRemoved	Boolean	True if the delivery extension used by the subscription has been removed; otherwise, false. (Read-only.)
InvalidParameterValue	Boolean	True if a parameter value saved with a subscription is invalid; otherwise, false. (Read-only.)
MissingParameterValue	Boolean	True if a required parameter value is not saved with a subscription; otherwise, false. (Read-only.)
SharedDataSourceRemoved	Boolean	True if a shared data source used with a subscription has been removed; otherwise, false. (Read-only.)
UnknownReportParameter	Boolean	True if a parameter name saved with a subscription is not recognized as a parameter for this report; otherwise, false.

BatchHeader

Description: This class contains the Batch ID for a batch of web service method calls.

Properties:

Property	Type	Description
BatchID	String	The identifier for a batch

CatalogItem

Description: This class contains information about a single item in the Report Catalog. This may be a Reporting Services folder, a report, a shared data source, or a resource.

Properties:

Property	Type	Description
CreatedBy	String	The name of the user who created the item.
CreationDate	Date	The date and time that the item was created.
CreationDateSpecified	Boolean	True if a value for CreationDate is specified; otherwise, false.
Description	String	The description of the item.
ExecutionDate	Date	The date and time that a report item was last executed. (Valid only for report items.)
ExecutionDateSpecified	Boolean	True if a value for ExecutionDate is specified; otherwise, false.
Hidden	Boolean	True if the item is hidden; otherwise, false.
HiddenSpecified	Boolean	True if a value for Hidden is specified; otherwise, false
ID	String	The ID of the item.
MimeType	String	The MIME type of a resource item. (Valid only for resource items.)
ModifiedBy	String	The name of the user who last modified the item.
ModifiedDate	Date	The date and time that the item was last modified.
ModifiedDateSpecified	Boolean	True if a value for ModifiedDate is specified; otherwise, false.
Name	String	The name of the item.
Path	String	The folder path to the item.
Size	Integer	The size of the item in bytes.
SizeSpecified	Boolean	True if a value for Size is specified; otherwise, false.
Type	ItemTypeEnum	The type of the item. Valid values are Unknown, Folder, Report, Resource, LinkedReport, and Datasource.
VirtualPath	String	The virtual path to the item. This is populated only when viewing items under the MyReports folder.

DailyRecurrence

Description: This class contains the time that must elapse, in days, before a schedule recurs. This class inherits from RecurrencePattern.

Properties:

Property	Type	Description
DaysInterval	Integer	The number of days before a schedule recurs

DataRetrievalPlan

Description: This class is used to define the data that will be selected for a data-driven subscription.

Properties:

Property	Type	Description
DataSet	DataSetDefinition	Defines the dataset to use with the data-driven subscription
Item	DataSourceDefinitionOrReference	Defines the data source to use with the data-driven subscription

DataSetDefinition

Description: This class contains the information necessary to define a dataset.

Properties:

Property	Type	Description
AccentSensitivity	SensitivityEnum	True if this dataset is sensitive to accents, False if this dataset is not sensitive to accents, or Auto if the sensitivity setting should be determined from the data provider.
AccentSensitivitySpecified	Boolean	True if a value for AccentSensitivity has been specified; otherwise, false.
CaseSensitivity	SensitivityEnum	True if this dataset is case sensitive, False if this dataset is not case sensitive, or Auto if the sensitivity setting should be determined from the data provider.
CaseSensitivitySpecified	Boolean	True if a value for CaseSensitivity has been specified; otherwise, false.
Collation	String	The locale used when sorting the data in the dataset. (Uses the SQL Server collation codes.)
Fields	An Array of Field Objects	An array containing the field information.
KanatypeSensitivity	SensitivityEnum	True if this dataset is kanatype sensitive, False if this dataset is not kanatype sensitive, or Auto if the sensitivity setting should be determined from the data provider. (This is used only for some Japanese character sets.)
KanatypeSensitivitySpecified	Boolean	True if a value for KanatypeSensitivity has been specified; otherwise, false.
Name	String	The name of the dataset.
Query	QueryDefinition Object	An object containing the query used to retrieve the data.
WidthSensitivity	SensitivityEnum	True if this dataset is width sensitive, False if this dataset is not width sensitive, or Auto if the sensitivity setting should be determined from the data provider.
WidthSensitivitySpecified	Boolean	True if a value for WidthSensitivity has been specified; otherwise, false.

DataSource

Description: This class contains either a reference to a shared data source or an object with the information necessary to define a data source.

Properties:

Property	Type	Description
Item	A DataSourceReference Object or a DataSourceDefinition Object	If the data source is referencing a shared data source, this will be a DataSourceReference object; otherwise, this will be a DataSourceDefinition object.
Name	String	The name of the data source.

DataSourceCredentials

Description: This class contains the credentials used to access a data source.

Properties:

Property	Type	Description
DataSourceName	String	The name of the data source that will use these credentials
Password	String	The password used to connect to the data source
UserName	String	The user name used to connect to the data source

DataSourceDefinition

Description: This class contains the information necessary to define a data source. This class inherits from DataSourceDefinitionOrReference.

Properties:

Property	Type	Description
ConnectString	String	The connection string.
CredentialRetrieval	CredentialRetrievalEnum	Prompt if the user is to be prompted for credentials when accessing this data source, Store if the credentials are stored in the data source definition, Integrated if Windows Authentication is to be used to access the data source, or None if no credentials are required.
Enabled	Boolean	True if the data source is enabled; otherwise, false.
EnabledSpecified	Boolean	True if a value for Enabled has been specified; otherwise, false.
Extension	String	The name of the data source extension. Valid values include SQL, OLEDB, ODBC, and a custom extension.
ImpersonateUser	Boolean	True if the report server is to impersonate the user after a connection has been made to the data source; otherwise, false.
ImpersonateUserSpecified	Boolean	True if a value for ImpersonateUser has been specified; otherwise, false.
Password	String	The password when the credentials are stored in the data source definition.
Prompt	String	The message used when prompting the user for credentials.
UserName	String	The user name when the credentials are stored in the data source definition.
WindowsCredentials	Boolean	True if the stored credentials are Windows credentials or False if the stored credentials are database credentials.

DataSourceDefinitionOrReference

Description: This class serves as a parent class. Any class that inherits from the DataSourceDefinitionOrReference class can be used where a DataSourceDefinitionOrReference type object is required.

Classes Inheriting from This Class:

Class Name	Description
DataSourceDefinition	Used when a data source definition is to be specified
DataSourceReference	Used when a reference to a shared data source is to be specified

DataSourcePrompt

Description: This class contains information about the message displayed to the user when prompting for data source credentials.

Properties:

Property	Type	Description
DataSourceID	String	The unique ID of a data source
Name	String	The name of the data source
Prompt	String	The prompt message

DataSourceReference

Description: This class contains a reference to a shared data source. This class inherits from DataSourceDefinitionOrReference.

Properties:

Property	Type	Description
Reference	String	The folder path and name of the shared data source

DaysOfWeekSelector

Description: This class contains information for the days of the week on which a schedule runs.

Properties:

Property	Type	Description
Friday	Boolean	True if the schedule is to run on Friday; otherwise, false.
Monday	Boolean	True if the schedule is to run on Monday; otherwise, false.
Saturday	Boolean	True if the schedule is to run on Saturday; otherwise, false.
Sunday	Boolean	True if the schedule is to run on Sunday; otherwise, false.
Thursday	Boolean	True if the schedule is to run on Thursday; otherwise, false.
Tuesday	Boolean	True if the schedule is to run on Tuesday; otherwise, false.
Wednesday	Boolean	True if the schedule is to run on Wednesday; otherwise, false.

ExpirationDefinition

Description: This class serves as a parent class. Any class that inherits from the ExpirationDefinition class can be used where an ExpirationDefinition type object is required.

Classes Inheriting from This Class:

Class Name	Description
ScheduleExpiration	Used when a date and time is to be specified for the expiration
TimeExpiration	Used when an elapsed time, in minutes, should be specified for the expiration

Extension

Description: This class represents a Reporting Services extension.

Properties:

Property	Type	Description
ExtensionType	ExtensionTypeEnum	Delivery for a delivery extension, Render for a rendering extension, Data for a data-processing extension, or All to represent all extension types. (Read-only.)
LocalizedName	String	The localized name of the extension for display to the user. (Read-only.)
Name	String	The name of the extension. (Read-only.)
Visible	Boolean	True if the extension is visible to the user interface; otherwise, false.

ExtensionParameter

Description: This class contains information about a setting for a delivery extension.

Properties:

Property	Type	Description
DisplayName	String	The name of the extension parameter.
Encrypted	Boolean	True if the Value property should be encrypted; otherwise, false. (Read-only.)
Error	String	An error message describing a problem with the value specified for this extension parameter. (Read-only.)
IsPassword	Boolean	True if the value for this parameter should not be returned in SOAP responses (this prevents passwords from being sent in clear text); otherwise, false. (Read-only.)
Name	String	The name of the device information setting. (Read-only.)
ReadOnly	Boolean	True if this extension parameter is read-only; otherwise, false. (Read-only.)
Required	Boolean	True if this extension parameter is required; otherwise, false. (Read-only.)
RequiredSpecified	Boolean	True if a value for Required has been specified; otherwise, false.
ValidValues	An Array of ValidValue Objects	An array of valid values for this extension parameter.
Value	String	The value of this extension parameter.

ExtensionSettings

Description: This class contains information for a delivery extension.

Properties:

Property	Type	Description
Extension	Extension Object	An object representing a Reporting Services extension
ParameterValues	An Array of ParameterValueOfFieldReference Objects	An array of parameter values for this extension

Field

Description: This class contains information for a field within a dataset.

Properties:

Property	Type	Description
Alias	String	The alias of a field in a report
Name	String	The name of a field in a query

MinuteRecurrence

Description: This class contains the time that must elapse, in minutes, before a schedule recurs. This class inherits from RecurrencePattern.

Properties:

Property	Type	Description
MinutesInterval	Integer	The number of minutes before a schedule recurs

MonthlyDOWRecurrence

Description: This class contains the days of the week, the weeks of the month, and the months of the year on which a schedule runs. This class inherits from RecurrencePattern.

Properties:

Property	Type	Description
DaysOfWeek	DaysOfWeekSelector Object	An object that determines the days of the week on which the schedule runs
MonthsOfYear	MonthsOfYearSelector	An object that determines the months of the year on which the schedule runs
WhichWeek	WeekNumberEnum	FirstWeek if the schedule is to run the first week of the month, SecondWeek if the schedule is to run the second week of the month, ThirdWeek if the schedule is to run the third week of the month, FourthWeek if the schedule is to run the fourth week of the month, or LastWeek if the schedule is to run the last week of the month
WhichWeekSpecified	Boolean	True if a value for WhichWeek has been specified; otherwise, false

MonthlyRecurrence

Description: This class contains the days of the month and the months of the year on which a schedule runs. This class inherits from RecurrencePattern.

Properties:

Property	Type	Description
Days	String	The days of the month on which the schedule recurs
MonthsOfYear	MonthsOfYearSelector	An object that determines the months of the year on which the schedule recurs

MonthsOfYearSelector

Description: This class contains information on the months of the year in which a schedule runs.

Properties:

Property	Type	Description
April	Boolean	True if the schedule is to run in April; otherwise, false.
August	Boolean	True if the schedule is to run in August; otherwise, false.
December	Boolean	True if the schedule is to run in December; otherwise, false.
February	Boolean	True if the schedule is to run in February; otherwise, false.
January	Boolean	True if the schedule is to run in January; otherwise, false.
July	Boolean	True if the schedule is to run in July; otherwise, false.
June	Boolean	True if the schedule is to run in June; otherwise, false.
March	Boolean	True if the schedule is to run in March; otherwise, false.
May	Boolean	True if the schedule is to run in May; otherwise, false.
November	Boolean	True if the schedule is to run in November; otherwise, false.
October	Boolean	True if the schedule is to run in October; otherwise, false.
September	Boolean	True if the schedule is to run in September; otherwise, false.

NoSchedule

Description: This class is used when no schedule is associated with an execution snapshot or a history snapshot. This class inherits from ScheduleDefinitionOrReference. It does not contain any properties.

ParameterFieldReference

Description: This class represents a field in a dataset used to supply the value for a parameter. This class inherits from ParameterValueOrFieldReference.

Properties:

Property	Type	Description
FieldAlias	String	The alias of a field
ParameterName	String	The name of a field

ParameterValue

Description: This class represents the actual value for a parameter. This class inherits from ParameterValueOrFieldReference.

Properties:

Property	Type	Description
Label	String	The label used for this parameter
Name	String	The name of the parameter
Value	String	The value of the parameter

ParameterValueOrFieldReference

Description: This class serves as a parent class. Any class that inherits from the ParameterValueOrFieldReference class can be used where a ParameterValueOrFieldReference type object is required.

Classes Inheriting from This Class:

Class Name	Description
ParameterFieldReference	Used when a reference to a field is to be specified
ParameterValue	Used when a parameter value is to be specified

Policy

Description: This class represents a domain user or domain group and the security roles assigned to that user or group.

Properties:

Property	Type	Description
GroupUserName	String	The name of a domain user or domain group
Roles	An Array of Role Objects	An array of security roles

Property

Description: This class represents a property of a Reporting Services item.

Properties:

Property	Type	Description
Name	String	The name of the property
Value	String	The value of the property

QueryDefinition

Description: This class contains information to define a query used for a dataset or a data-driven subscription.

Properties:

Property	Type	Description
CommandText	String	The query text (usually a SELECT statement).
CommandType	String	The type of query supplied in the CommandText property. (For data-driven subscriptions, this will always have a value of Text.)
Timeout	Integer	The number of seconds the query may execute before it times out.
TimeoutSpecified	Boolean	True if a value for Timeout has been specified; otherwise, false.

RecurrencePattern

Description: This class serves as a parent class. Any class that inherits from the RecurrencePattern class can be used where a RecurrencePattern type object is required.

Classes Inheriting from This Class:

Class Name	Description
MinuteRecurrence	Used when the schedule is to recur in minutes
DailyRecurrence	Used when the schedule is to recur on a daily basis
WeeklyRecurrence	Used when the schedule is to occur on certain days of the week and to recur on a weekly basis
MonthlyRecurrence	Used when the schedule is to occur on certain days of the month and certain months of the year
MonthlyDOWRecurrence	Used when the recurrence is to occur on a day of the week, week of the month, and month of the year

ReportHistorySnapshot

Description: This class contains information defining a history snapshot.

Properties:

Property	Type	Description
CreationDate	Date	The date and time that the history snapshot was created. (Read-only.)
HistoryID	String	The ID of the history snapshot. (Read-only.)
Size	Integer	The size (in bytes) of the history snapshot. (Read-only.)

ReportParameter

Description: This class contains information about a report parameter.

Properties:

Property	Type	Description
AllowBlank	Boolean	True if this report parameter can be empty; otherwise, false. (Read-only.)
AllowBlankSpecified	Boolean	True if a value for AllowBlank was specified; otherwise, false.
DefaultValues	String	The default value of the report parameter.
DefaultValuesQueryBased	Boolean	True if the default value comes from a query; otherwise, false. (Read-only.)
DefaultValuesQueryBasedSpecified	Boolean	True if a value for DefaultValuesQueryBased is specified; otherwise, false.
Dependencies	An Array of Strings	An array showing which other report parameters are depended on by the query used to provide the default value and the query used to provide valid values. Used only if the default value or the valid values come from a parameterized query. (Read-only.)
ErrorMessage	String	Any error messages describing errors with this report parameter.
MultiValue	Boolean	True if the parameter can be a multivalued parameter. (Read-only.)
MultiValueSpecified	Boolean	True if a value for MultiValue is specified; otherwise, false.
Name	String	The name of the parameter. (Read-only.)
Nullable	Boolean	True if the report parameter may be null; otherwise, false.
NullableSpecified	Boolean	True if a value for Nullable is specified; otherwise, false.
Prompt	String	The message displayed to the user when prompting for a value for this parameter.
PromptUser	Boolean	True if the user is to be prompted for this report parameter; otherwise, false.
PromptUserSpecified	Boolean	True if a value for PromptUser has been specified; otherwise, false.
QueryParameter	Boolean	True if this parameter is used in a data source query; otherwise, false. (Read-only.)
QueryParameterSpecified	Boolean	True if a value for QueryParameter is specified; otherwise, false.
State	Parameter StateEnum	HasValidValue if the report parameter has a valid value, MissingValidValue if a valid value for the report parameter does not exist, HasOutstandingDependencies if other report parameters that are depended on by this report parameter have not yet been specified, or DynamicValuesUnavailable if no values were returned by a query designated to provide the list of valid values. (Read-only.)
StateSpecified	Boolean	True if a value for State is specified; otherwise, false.
Type	Parameter TypeEnum	Boolean if type boolean, DateTime if type datetime, Float if type float, Integer if type integer, or String if type string. (Read-only.)
TypeSpecified	Boolean	True if a value for Type is specified; otherwise, false.
ValidValues	An Array of ValidValue Objects	An array of the valid values for this report parameter.
ValidValuesQueryBased	Boolean	True if the valid values come from a query; otherwise, false.
ValidValuesQueryBasedSpecified	Boolean	True if a value for ValidValuesQueryBased is specified; otherwise, false.

Role

Description: This class contains information about a security role.

Properties:

Property	Type	Description
Description	String	The description of the role
Name	String	The name of the role

Schedule

Description: This class contains information about a schedule.

Properties:

Property	Type	Description
Creator	String	The name of the user who created the schedule. (Read-only.)
Definition	ScheduleDefinition Object	The definition of the schedule.
Description	String	The description of the schedule.
LastRunTime	Date	The date and time the schedule was last run. (Read-only.)
LastRunTimeSpecified	Boolean	True if a value for LastRunTime is specified; otherwise, false.
Name	String	The name of the schedule.
NextRunTime	Date	The date and time the schedule will run next. (Read-only.)
NextRunTimeSpecified	Boolean	True if a value for NextRunTime is specified; otherwise, false.
ReferencesPresent	Boolean	True if this is a shared schedule and it is referenced by reports and subscriptions.
ScheduleID	String	The ID of the schedule. (Read-only.)
State	ScheduleStateEnum	Running if one or more reports associated with this schedule are currently running, Ready if one or more reports associated with this schedule are ready to run, Paused if the schedule is paused, Expired if the end date for this schedule has passed, or Failing if an error has occurred and the schedule has failed.

ScheduleDefinition

Description: This class contains information for defining a schedule. This class inherits from ScheduleDefinitionOrReference.

Properties:

Property	Type	Description
EndDate	Date	The end date and time for the schedule
EndDateSpecified	Boolean	True if a value for EndDate has been specified; otherwise, false
Item	RecurrencePattern Object	An object containing information about when the schedule should run
StartDateTime	Date	The start date and time for the schedule

ScheduleDefinitionOrReference

Description: This class serves as a parent class. Any class that inherits from the ScheduleDefinitionOrReference class can be used where a ScheduleDefinitionOrReference type object is required.

Classes Inheriting from This Class:

Class Name	Description
NoSchedule	Used when no schedule is to be specified
ScheduleDefinition	Used when a schedule definition is to be specified
ScheduleReference	Used when a reference to a shared schedule is to be specified

ScheduleExpiration

Description: This class defines when a cached copy of a report should expire. This class inherits from ExpirationDefinition.

Properties:

Property	Type	Description
Item	ScheduleDefinitionOrReference Object	Either a schedule definition or a reference to a shared schedule

ScheduleReference

Description: This class contains a reference to a shared schedule. This class inherits from ScheduleDefinitionOrReference.

Properties:

Property	Type	Description
Definition	ScheduleDefinition Object	The definition of the schedule
ScheduleID	String	The ID of the shared schedule

SearchCondition

Description: This class provides information on a search within the Report Catalog.

Properties:

Property	Type	Description
Condition	ConditionEnum	Contains if the search must match only a portion of the property’s value to be considered a match or Equals if the search must match all of the property’s value to be considered a match
ConditionSpecified	Boolean	True if a value for Condition has been specified; otherwise, false
Name	String	The name of the property being searched
Value	String	The value to find

Subscription

Description: This class contains information to define a subscription.

Properties:

Property	Type	Description
Active	ActiveState Object	The active state of the subscription. (Read-only.)
DeliverySettings	ExtensionSettings Object	The settings specific to the delivery extension.
Description	String	A description of the format and the delivery method.
EventType	String	The type of event that triggers the subscription.
IsDataDriven	Boolean	True if the subscription is data-driven; otherwise, false.
LastExecuted	Date	The date and time the subscription was last executed. (Read-only.)
LastExecutedSpecified	Boolean	True if a value for LastExecuted is specified; otherwise, false.
ModifiedBy	String	The name of the user who last modified the subscription. (Read-only.)
ModifiedDate	Date	The date and time of the last modification to the subscription. (Read-only.)
Owner	String	The user name of the owner of the subscription. (Read-only.)
Path	String	The full path and name of the report associated with the subscription.
Report	String	The name of the report associated with the subscription.
Status	String	The status of the subscription. (Read-only.)
SubscriptionID	String	The ID of the subscription.
VirtualPath	String	The virtual path to the report associated with the subscription. This is populated only if the associated report is under the MyReports folder.

Task

Description: This class contains information about a Reporting Services task.

Properties:

Property	Type	Description
Description	String	The description of this task. (Read-only.)
Name	String	The name of this task. (Read-only.)
TaskID	String	The ID for this task. (Read-only.)

TimeExpiration

Description: This class contains the time that must elapse, in minutes, before a cached copy of a report expires. This class inherits from ExpirationDefinition.

Properties:

Property	Type	Description
Minutes	Integer	The number of minutes before expiration

ValidValue

Description: This class contains information on a valid value for an extension parameter or a report parameter.

Properties:

Property	Type	Description
Label	String	The label for the valid value
Value	String	The valid value for the setting

Warning

Description: This class contains information on a warning message or an error message.

Properties:

Property	Type	Description
Code	String	The error or warning code. (Read-only.)
Message	String	The error or warning message. (Read-only.)
ObjectName	String	The name of the object associated with the warning or error. (Read-only.)
ObjectType	String	The type of the object associated with the warning or error. (Read-only.)
Severity	String	Warning if this is a warning or Error if this is an error.

WeeklyRecurrence

Description: This class contains the days of the week on which a schedule runs and the number of weeks to elapse before each recurrence. This class inherits from RecurrencePattern.

Properties:

Property	Type	Description
DaysOfWeek	DaysOfWeekSelector Object	An object that determines the days of the week on which the schedule runs.
WeeksInterval	Integer	The number of weeks before a schedule runs again.
WeeksIntervalSpecified	Boolean	True if a value for WeeksInterval is specified; otherwise, false.