Click or drag to resize
IQMS2GetTaskStatuses Method
Gets the task statuses.

Namespace: PIX.Services.V12.Api2
Assembly: 
Syntax
List<TaskStatus> GetTaskStatuses(
	TaskStatusFilter filter,
	TaskStatusScope scope
)

Parameters

filter
Type: PIX.QMSAPI.DataObjectsTaskStatusFilter
Filter filter to be used on the result.
scope
Type: PIX.QMSAPI.DataObjectsTaskStatusScope
The scope.

Return Value

Type: ListTaskStatus
Depending on the filter and scope it can return a list of all the task names, current operating status and other metadata information.
Remarks
Note Note
This method does not support filtering on a certain FromDate. If this is required, GetTaskStatusNodes should be used instead.
Security note Security Note

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.

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

            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