Click or drag to resize
IQMSGetTask Method
Retrieves a single task using its id.

Namespace: PIX.Services.V12
Assembly: 
Syntax
TaskInfo GetTask(
	Guid taskID
)

Parameters

taskID
Type: SystemGuid
The task ID.

Return Value

Type: TaskInfo
A task with the provided ID.
Remarks
Security note Security Note

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

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.

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

           //Some known task id
           Guid taskId = new Guid("5ac16136-f00b-47c4-8099-23ff7f178423");

           TaskInfo taskInfo = apiClient.GetTask(taskId);

           if(taskInfo != null) {
               Console.WriteLine(String.Format("Name:{0}\nEnabled:{1}\nID:{2}\nQDSID:{3}\nType:{4}", taskInfo.Name, taskInfo.Enabled ? "Yes" : "No", taskInfo.ID, taskInfo.QDSID, Enum.GetName(typeof(TaskType), taskInfo.Type)));
           }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
See Also