| IQMSRemoteGetSourceDocumentFolders Method |
Namespace: PIX.Services.V12
List<DocumentFolder> RemoteGetSourceDocumentFolders( Guid remoteQmsId, Guid remoteQdsId, DocumentFolderScope scope )
Only source document folders that the caller have access to will be returned.
Requires membership of local group QlikView Management API and the role Document Folder Administrator. |
The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.
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(); //Get a remote QlikView Management service. ServiceInfo remoteQMSService = apiClient.GetServices(ServiceTypes.RemoteQlikViewManagementService).FirstOrDefault(); if (remoteQMSService != null) { //Get all QlikView Distribution services on the remote QMS. List<ServiceInfo> remoteQDS = apiClient.RemoteGetServices(remoteQMSService.ID, ServiceTypes.QlikViewDistributionService); { //Print the name of the QMS and the source folders found. remoteQDS.ForEach(delegate(ServiceInfo qdsInfo) { Console.WriteLine("Source document folders on " + qdsInfo.Name); List<DocumentFolder> sourceDocumentFolders = apiClient.RemoteGetSourceDocumentFolders(remoteQMSService.ID, qdsInfo.ID, DocumentFolderScope.All); sourceDocumentFolders.ForEach(folder=>Console.WriteLine(folder.General.Path)); } ); } } } catch (Exception ex) { Console.WriteLine("An exception occurred: " + ex.Message); } // wait for user to press any key Console.ReadLine(); } }