GetTask Method
Overloads
GetTask(Guid) |
Retrieves a single task using its id. |
GetTask(Guid)
Retrieves a single task using its id.
Declaration
TaskInfo GetTask(Guid taskID)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | taskID |
The task ID. |
Returns
Type | Description |
---|---|
TaskInfo |
A task with the provided ID. |
Remarks
security
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.
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();
}
}
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!