Skip to main content Skip to complementary content

GetServices Method

Overloads

GetServices(ServiceTypes)

Gets information about all registered services of the specified type.

GetServices(ServiceTypes)

Gets information about all registered services of the specified type.

Declaration

      List<ServiceInfo> GetServices(ServiceTypes serviceTypes)
    

Parameters

Type Name Description
ServiceTypes serviceTypes

The service types to return.

Returns

Type Description
System.Collections.Generic.List<ServiceInfo>

Information about all registered services of the specified type.

Remarks

It is not possible to retrieve Reload Engines with this method.

security

Requires membership of local group QlikView Management API.

Examples

The following code example retrieves all services, ordered by type, and prints them.

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

           //Retrieve all services.
           List<ServiceInfo> orderedServices = apiClient.GetServices(ServiceTypes.All).OrderBy(serviceInfo => serviceInfo.Type).ToList();

           ServiceTypes currentType = ServiceTypes.None;        

           orderedServices.ForEach( service=>
               {
                   if(currentType != service.Type)
                   {
                       currentType = service.Type;
                       Console.WriteLine( "\n" + Enum.GetName(typeof(ServiceTypes), service.Type));
                   }
                   Console.WriteLine(String.Format("Name:{0}\nAddress:{1}", service.Name, service.Address));

               }

           );
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

See Also

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Join the Analytics Modernization Program

Remove banner from view

Modernize without compromising your valuable QlikView apps with the Analytics Modernization Program. Click here for more information or reach out: ampquestions@qlik.com