ReportingService2010.CreateReportEditSession Method

Creates a new report edit session in the report server database.

Namespace:  ReportService2010
Assembly:  ReportService2010 (in ReportService2010.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateReportEditSession", 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("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
Public Function CreateReportEditSession ( _
    Report As String, _
    Parent As String, _
    Definition As Byte(), _
    <OutAttribute> ByRef Warnings As Warning() _
) As String
'Usage
Dim instance As ReportingService2010
Dim Report As String
Dim Parent As String
Dim Definition As Byte()
Dim Warnings As Warning()
Dim returnValue As String

returnValue = instance.CreateReportEditSession(Report, _
    Parent, Definition, Warnings)
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateReportEditSession", 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("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
public string CreateReportEditSession(
    string Report,
    string Parent,
    byte[] Definition,
    out Warning[] Warnings
)
[SoapDocumentMethodAttribute(L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateReportEditSession", RequestNamespace = L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
public:
String^ CreateReportEditSession(
    String^ Report, 
    String^ Parent, 
    array<unsigned char>^ Definition, 
    [OutAttribute] array<Warning^>^% Warnings
)
[<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateReportEditSession", 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("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
member CreateReportEditSession : 
        Report:string * 
        Parent:string * 
        Definition:byte[] * 
        Warnings:Warning[] byref -> string 
public function CreateReportEditSession(
    Report : String, 
    Parent : String, 
    Definition : byte[], 
    Warnings : Warning[]
) : String

Parameters

  • Report
    Type: System.String
    The name of the report with which to associate the edit session.
  • Parent
    Type: System.String
    The path to an item. This can be a folder or a SharePoint library.
  • Definition
    Type: array<System.Byte[]
    A byte array that contains the report definition language (RDL) of the report associated with the edit session.
  • Warnings
    Type: array<ReportService2010.Warning[]%
    [out] An array of Warning objects that describes any warnings that occurred during the creation of the report edit session.

Return Value

Type: System.String
A string that identifies the edit session.

Remarks

The table below shows header and permissions information on this operation.

SOAP Header Usage

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

ExecuteReportDefinition AND, depending on the situation:

SharePoint Mode Required Permissions

Needs the system property EnableLoadReportDefinition set to true AND, depending on the situation:

  • If Parent is empty or nulla null reference (Nothing in Visual Basic): No more permission required

  • If Parent exists, but Report does not exist: AddListItems() on Parent AND ViewListItems() on data sources and datasets defined in Definition

  • If both Parent and Report exists: same as above AND all of the following permissions on Report:

    • OpenItems()

    • ViewListItems()

    • EidListItems()

An error occurs if the specified folder or document library does not exist.

If the report specified in the Report parameter does not exist at the specified location, the value of Report sets the Globals!ReportName in the RDL for the edit session.

Call the DeleteItem method to delete the report edit session, passing the EditSessionID as a parameter to the DeleteItem method.

Definition cannot include an expression-based connection string. When it does, the rsInvalidParameterValue is returned by this method.

By default, report edit sessions are set to 7200 seconds (2 hours) from last use, making it possible for users to keep a large amount of data in the cache for a prolonged period of time. In some usage patterns, this could lead to a larger load on the RSTempDB database and the report server. In these cases you should consider using LoadReport.