.png)
ReportingService2010.GetSubscriptionProperties Method
SQL Server 2012
Returns the properties of a specified subscription.
Namespace: ReportService2010
Assembly: ReportService2010 (in ReportService2010.dll)
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetSubscriptionProperties", RequestNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)] [SoapHeaderAttribute("TrustedUserHeaderValue")] [SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)] public string GetSubscriptionProperties( string SubscriptionID, out ExtensionSettings ExtensionSettings, out string Description, out ActiveState Active, out string Status, out string EventType, out string MatchData, out ParameterValue[] Parameters )
Parameters
- SubscriptionID
- Type: System.String
The ID of the subscription.
- ExtensionSettings
- Type: ReportService2010.ExtensionSettings
[out] An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.
- Description
- Type: System.String
[out] A meaningful description that is displayed to users.
- Active
- Type: ReportService2010.ActiveState
[out] An ActiveState object that contains the active state of the subscription.
- Status
- Type: System.String
[out] The status of the subscription.
- EventType
- Type: System.String
[out] The type of event that triggers the subscription.
- MatchData
- Type: System.String
[out] The data that is associated with the specified type of event. This is used by an event processing extension to match the subscription with an event that has occurred.
- Parameters
- Type: ReportService2010.ParameterValue[]
[out] An array of ParameterValue objects that contains a list of parameters for the report.
The table below shows header and permissions information on this operation.
SOAP Header Usage | (Out) ServerInfoHeaderValue |
Native Mode Required Permissions | (ReadSubscription on the report AND the user is the subscription owner) OR ReadAnySubscription |
SharePoint Mode Required Permissions | ManageAlerts OR (CreateAlerts AND the user is the subscription owner) |
using System; using System.Collections.Generic; using System.IO; using System.Text; using System.Web; using System.Web.Services; using System.Web.Services.Protocols; class Sample { static void Main(string[] args) { ReportingService2010 rs = new ReportingService2010(); rs.Url = "http://<Server Name>" + "/_vti_bin/ReportServer/ReportService2010.asmx"; rs.Credentials = System.Net.CredentialCache.DefaultCredentials; ExtensionSettings extSettings; string desc; ActiveState active; string status; string eventType; string matchData; ParameterValue[] values = null; Subscription[] subscriptions = null; ParameterValueOrFieldReference[] extensionParams = null; try { subscriptions = rs.ListSubscriptions("http://<Server Name>"); if (subscriptions != null) { rs.GetSubscriptionProperties( subscriptions[0].SubscriptionID, out extSettings, out desc, out active, out status, out eventType, out matchData, out values); Console.WriteLine("Description: {0}", desc); Console.WriteLine("Status: {0}", status); Console.WriteLine("EventType: {0}", eventType); Console.WriteLine("matchData: {0}", matchData); Console.WriteLine("Extension: {0}", extSettings.Extension); extensionParams = extSettings.ParameterValues; if (extensionParams != null) { foreach (ParameterValueOrFieldReference extensionParam in extensionParams) { Console.WriteLine( ((ParameterValue)extensionParam).Name + ": " + ((ParameterValue) extensionParam).Value); } } if (values != null) { foreach (ParameterValue pv in values) { Console.WriteLine("Name: {0}", pv.Name); Console.WriteLine("Value: {0}", pv.Value); } } } } catch (SoapException e) { Console.WriteLine(e.Detail.InnerXml.ToString()); } } }
