Méthode CreateCatalogItem

Ajoute un nouvel élément à une base de données du serveur de rapports ou à la bibliothèque SharePoint. Cette méthode s'applique aux types d'élément Rapport, Modèle, Dataset, Composant, Ressource et DataSource.

Espace de noms :  ReportService2010
Assembly :  ReportService2010 (en ReportService2010.dll)

Syntaxe

'Déclaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateCatalogItem", RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    ResponseNamespace := "https://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
'Utilisation
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)
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateCatalogItem", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://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
)
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateCatalogItem", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
CatalogItem^ CreateCatalogItem(
    String^ ItemType, 
    String^ Name, 
    String^ Parent, 
    bool Overwrite, 
    array<unsigned char>^ Definition, 
    array<Property^>^ Properties, 
    [OutAttribute] array<Warning^>^% Warnings
)
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateCatalogItem", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member CreateCatalogItem : 
        ItemType:string * 
        Name:string * 
        Parent:string * 
        Overwrite:bool * 
        Definition:byte[] * 
        Properties:Property[] * 
        Warnings:Warning[] byref -> CatalogItem 
public function CreateCatalogItem(
    ItemType : String, 
    Name : String, 
    Parent : String, 
    Overwrite : boolean, 
    Definition : byte[], 
    Properties : Property[], 
    Warnings : Warning[]
) : CatalogItem

Paramètres

  • Name
    Type : System. . :: . .String
    Nom du nouvel élément, y compris l'extension de fichier en mode SharePoint.
  • Overwrite
    Type : System. . :: . .Boolean
    Expression de type Boolean qui indique si un élément existant portant le même nom dans l'emplacement spécifié doit être remplacé.
  • Definition
    Type : array<System. . :: . .Byte> [] () [] []
    Définition de rapport .rdl, définition de modèle de rapport ou contenu de ressource à publier sur le serveur de rapports.
  • Warnings
    Type : array<ReportService2010. . :: . .Warning> [] () [] []%
    [out] Tableau d'objets Warning qui décrit les avertissements qui ont été rencontrés pendant la validation de la définition de l'élément.

Valeur de retour

Type : ReportService2010. . :: . .CatalogItem
Objet CatalogItem pour l'élément nouvellement créé.

Notes

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 DefinitionViewListItems()()()() 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.

Exemples

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());
        }
    }
}
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