Skip to main content Skip to complementary content

GetTaskStatuses Method

Overloads

GetTaskStatuses(TaskStatusFilter, TaskStatusScope)

Gets the task statuses.

Declaration

      List<TaskStatus> GetTaskStatuses(TaskStatusFilter filter, TaskStatusScope scope)
    

Parameters

Type Name Description
TaskStatusFilter filter

Filter filter to be used on the result.

TaskStatusScope scope

The scope.

Returns

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

Depending on the filter and scope it can return a list of all the task names, current operating status and other metadata information.

Remarks

implementnotes

This method does not support filtering on a certain FromDate. If this is required, GetTaskStatusNodes should be used instead.

security

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

Examples

The following code example retrieves a list of all task statuses which are running, and then writes part of the extended metadata of the first element in the list 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.

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

            TaskStatusFilter taskStatusFilter = new TaskStatusFilter();
            taskStatusFilter.TaskStatuses.Add(TaskStatusValue.Running);
            List<TaskStatus> taskStatuses = apiClient.GetTaskStatuses(taskStatusFilter, TaskStatusScope.Extended); // A service call.
            Console.WriteLine(taskStatuses[0].Extended.TaskSummary.ToString()); // Print part of the metadata of the first element in the list.
        }
        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