Click or drag to resize
IQMSRemoteGetServices Method
Retrieves information about services managed by a remote QlikView Management Console.

Namespace: PIX.Services.V12
Assembly: 
Syntax
List<ServiceInfo> RemoteGetServices(
	Guid remoteQmsId,
	ServiceTypes serviceTypes
)

Parameters

remoteQmsId
Type: SystemGuid
The ID of the remote QlikView Management Console.
serviceTypes
Type: PIX.QMSAPI.DataObjectsServiceTypes
The type of services to return.

Return Value

Type: ListServiceInfo
A list of services.
Remarks

Only source document folders that the caller have access to will be returned.

Security note Security Note

Requires membership of local group QlikView Management API and the role QlikView Administrator.

Examples
This example retrieves all services managed by a remote QlikView Management Service and prints information about them 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();

            //Retrieve a remote QlikViewManagement-service
            ServiceInfo remoteQMSService = apiClient.GetServices(ServiceTypes.RemoteQlikViewManagementService).FirstOrDefault();

            if(remoteQMSService != null)
            {
                //Get all services managed by the remote service.
                List<ServiceInfo> remoteServices = apiClient.RemoteGetServices(remoteQMSService.ID, ServiceTypes.All);
                {
                    remoteServices.ForEach( delegate (ServiceInfo serviceInfo)
                        {                            
                            Console.WriteLine( string.Format( "{0} {1}",serviceInfo.Name, serviceInfo.Type));
                        }
                    );
                }
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
See Also