Click or drag to resize
IQMS2GetTaskStatus Method
Gets the status of a task.

Namespace: PIX.Services.V12.Api2
Assembly: 
Syntax
TaskStatus GetTaskStatus(
	Guid taskID,
	TaskStatusScope scope
)

Parameters

taskID
Type: SystemGuid
The ID of the task.
scope
Type: PIX.QMSAPI.DataObjectsTaskStatusScope
The scope.

Return Value

Type: TaskStatus
Depending on the scope it can return the task name, current operating status and other metadata information.
Remarks
Security note Security Note

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.

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

            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