Skip to main content Skip to complementary content

GetTaskStatus Method

Overloads

GetTaskStatus(Guid, TaskStatusScope)

Gets the status of a task.

GetTaskStatus(Guid, TaskStatusScope)

Gets the status of a task.

Declaration

      TaskStatus GetTaskStatus(Guid taskID, TaskStatusScope scope)
    

Parameters

Type Name Description
System.Guid taskID

The ID of the task.

TaskStatusScope scope

The scope.

Returns

Type Description
TaskStatus

Depending on the scope it can return the task name, current operating status and other metadata information.

Remarks

security

Requires membership of local group QlikView Management API.

Examples

The following code example retrieves the extended metadata for a specific task and then writes it 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();

            Guid taskId = new Guid("28a4fae4-8e75-4681-8ddc-751b7664a025"); //A known task id.
            TaskStatus taskStatus = apiClient.GetTaskStatus(taskId, TaskStatusScope.Extended); // A service call.
            Console.WriteLine(taskStatus.Extended.TaskSummary); // Print the resulting task summary.
        }
        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