Export (0) Print
Expand All
Expand Minimize

ReportingService2010.CreateCatalogItem Method

Adds a new item to a report server database or SharePoint library. This method applies to the Report, Model, Dataset, Component, Resource, and DataSource item types.

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

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateCatalogItem", 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)> _
Public Function CreateCatalogItem ( _
	ItemType As String, _
	Name As String, _
	Parent As String, _
	Overwrite As Boolean, _
	Definition As Byte(), _
	Properties As Property(), _
	<OutAttribute> ByRef Warnings As Warning() _
) As CatalogItem
'Usage
Dim instance As ReportingService2010
Dim ItemType As String
Dim Name As String
Dim Parent As String
Dim Overwrite As Boolean
Dim Definition As Byte()
Dim Properties As Property()
Dim Warnings As Warning()
Dim returnValue As CatalogItem

returnValue = instance.CreateCatalogItem(ItemType, _
	Name, Parent, Overwrite, Definition, _
	Properties, Warnings)

Parameters

ItemType
Type: System.String
The item type.
Name
Type: System.String
The name of the new item, including the file extension in SharePoint mode.
Parent
Type: System.String
The fully qualified URL for the parent folder that will contain the item.
Overwrite
Type: System.Boolean
A Boolean expression that indicates whether an existing item that has the same name in the location specified should be overwritten.
Definition
Type: System.Byte()
The .rdl report definition, report model definition, or resource content to publish to the report server.
Properties
Type: ReportService2010.Property()
An array of Property objects that contains the property names and values to set for the item.
Warnings
Type: ReportService2010.Warning()%
[out] An array of Warning objects that describes any warnings that occurred when the item was validated.

Return Value

Type: ReportService2010.CatalogItem
A CatalogItem object for the newly created item.

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

SOAP Header Usage

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

Depends on the item type:

SharePoint Mode Required Permissions

Depends on the item type:

  • Report

    Creating a new report: AddListItems on Parent AND ViewListItems on data sources and datasets defined in Definition

    Updating an existing report: EditListItems on Item AND ViewListItems on data sources and datasets defined in Definition AND ViewListItems on Item (if Properties contains properties)

  • DataSet

    Creating a new shared dataset: AddListItems on Parent AND ViewListItems on data sources defined in Definition

    Updating an existing shared dataset: EditListItems on Item AND ViewListItems on data sources defined in Definition ViewListItems on Item (if Properties contains properties)

  • Resource, DataSource, Component:

    Creating a new item: AddListItems on Parent

    Updating an existing item: EditListItems on Item

  • Model: AddListItems on Parent

This method can create items of all supported item types. To see what item types are supported, use the ListItemTypes method.

The Model item type cannot be overwritten. Therefore, the Overwrite parameter must be False if ItemType is Model. Otherwise, an rsInvalidParameterCombination exception is thrown.

If ItemType is Report, then the XML data is defined by the Report Definition Language. If ItemType is Model, then the XML data is defined by the Semantic Model Definition Language.

If errors occur, the item is not created.

Adding an item to a report server database or SharePoint library modifies the ModifiedBy and ModifiedDate properties of the parent folder.

If the applicable file name extension (for example, .rdl) is excluded from the item name, an rsFileExtensionRequired error will be returned.

The length of the Parent parameter cannot exceed 260 characters; otherwise, a SOAP exception is thrown with the error code rsItemLengthExceeded.

The Parent parameter cannot be null or empty or contain the following reserved characters: : ? ; @ & = + $ , \ * > < | . ". You can use the forward slash character (/) to separate items in the full path name of the folder, but you cannot use it at the end of the folder name.

Imports System
Imports System.IO
Imports System.Text
Imports System.Web.Services
Imports System.Web.Services.Protocols

Class Sample

    Public Shared Sub Main()

        Dim rs As New ReportingService2010()
        rs.Url = "http://<Server Name>" + _
            "/_vti_bin/ReportServer/ReportService2010.asmx"
        rs.Credentials = _
            System.Net.CredentialCache.DefaultCredentials

        Dim definition As [Byte]() = Nothing
        Dim warnings As Warning() = Nothing
        Dim name As String = "MyReport.rdl"

        Try
            Dim stream As FileStream = File.OpenRead("MyReport.rdl")
            definition = New [Byte](stream.Length - 1) {}
            stream.Read(definition, 0, CInt(stream.Length))
            stream.Close()

        Catch e As IOException
            Console.WriteLine(e.Message)
        End Try

        Try
            Dim parentPath As String = _
                "http://<Server Name>/Docs/Documents/"
            rs.CreateCatalogItem("Report", name, parentPath, False, _
                definition, Nothing, warnings)

            If Not (warnings Is Nothing) Then
                Dim warning As Warning
                For Each warning In warnings
                    Console.WriteLine(warning.Message)
                Next warning

            Else
                Console.WriteLine("Report: {0} created " + _
                    "successfully with no warnings", name)
            End If

        Catch e As SoapException
            Console.WriteLine(e.Detail.InnerXml.ToString())
        End Try

    End Sub

End Class
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft