GetSourceDocuments Method

Overloads

GetSourceDocuments(Guid)

Declaration

      List<DocumentNode> GetSourceDocuments(Guid qdsID)
    

Parameters

Returns

Remarks

Examples

The following code example uses the QMS API to retrieve a registered QlikView Distribution Service and all its source documents. The names and paths of the source documents are then printed. If anything goes wrong, it prints an error message.

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.IO;
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 list of QDS services
            List<ServiceInfo> qdsServices = apiClient.GetServices(ServiceTypes.QlikViewDistributionService);
            if (qdsServices.Count > 0)
            {
                // retrieve all source documents for the first QDS in the list
                List<DocumentNode> sourceDocuments = apiClient.GetSourceDocuments(qdsServices[0].ID);
                // print the names of all source documents
                Console.WriteLine("The " + qdsServices[0].Name + " contains the following source documents:" + Environment.NewLine);
                foreach (DocumentNode sourceDocument in sourceDocuments.OrderBy(x => x.RelativePath).ThenBy(x => x.Name))
                {
                    Console.WriteLine(Path.Combine(sourceDocument.RelativePath, sourceDocument.Name));
                }
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadKey();
    }
}
  

See Also