Export (0) Print
Expand All
Expand Minimize
0 out of 2 rated this helpful - Rate this topic

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)
[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 CatalogItem CreateCatalogItem(
	string ItemType,
	string Name,
	string Parent,
	bool Overwrite,
	byte[] Definition,
	Property[] Properties,
	out Warning[] 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:

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.

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;

        Byte[] definition = null;
        Warning[] warnings = null;
        string name = "MyReport.rdl";

        try
        {
            FileStream stream = File.OpenRead("MyReport.rdl");
            definition = new Byte[stream.Length];
            stream.Read(definition, 0, (int)stream.Length);
            stream.Close();
        }
        catch (IOException e)
        {
            Console.WriteLine(e.Message);
        }

        try
        {
            string parent = "http://<Server Name>/Docs/Documents/";
            CatalogItem report = rs.CreateCatalogItem("Report", name, parent,
                        false, definition, null, out warnings);

            if (warnings != null)
            {
                foreach (Warning warning in warnings)
                {
                    Console.WriteLine(warning.Message);
                }
            }

            else
                Console.WriteLine("Report: {0} created successfully " +
                                  " with no warnings", name);
        }
        catch (SoapException e)
        {
            Console.WriteLine(e.Detail.InnerXml.ToString());
        }
    }
}
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.