Click or drag to resize
IQMSDeleteServerObject Method
Removes a server object from a document.

Namespace: PIX.Services.V12
Assembly: 
Syntax
void DeleteServerObject(
	Guid qvsID,
	string documentName,
	string id
)

Parameters

qvsID
Type: SystemGuid
The ID of a QlikView Server
documentName
Type: SystemString
The full path of the document to delete server objects from.
id
Type: SystemString
The id of the server object to delete.
Remarks
Security note Security Note

Requires membership of local groups QlikView Management API and QlikView Administrator.

Examples
This example retrieves the server objects from a document hosted by a Qlik View Server and writes the information to the console.

The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.

C#
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using QMSAPI;

class Program
{
     static void Main(string[] args)
     {
         try
         {
             // create a QMS API client
             IQMS apiClient = new QMSClient();

             //retrieve a time limited service key
             ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();

            //Find a Qlik View Server 
            ServiceInfo qvsService = apiClient.GetServices(ServiceTypes.QlikViewServer).FirstOrDefault();

            if (qvsService != null)
            {
                //Get all server objects
                List<ServerObject> serverObjects = apiClient.GetServerObjects(qvsService.ID, "Test.qvw");

                //Find the ones belonging to johndoe
                var userObjects = serverObjects.Where(c => c.OwnerId == "Domain\\johndoe").ToList();

                //Delete the objects found.
                userObjects.ForEach(c => apiClient.DeleteServerObject(qvsService.ID, "Test.qvw", c.Id));
            }
         }
         catch (Exception ex)
         {
             Console.WriteLine("An exception occurred: " + ex.Message);
         }
         // wait for user to press any key
         Console.ReadLine();
     }
}
See Also