Click or drag to resize
IQMS2DeleteTask Method
Deletes a single task.

Namespace: PIX.Services.V12.Api2
Assembly: 
Syntax
bool DeleteTask(
	Guid taskID,
	TaskType taskType
)

Parameters

taskID
Type: SystemGuid
The task ID.
taskType
Type: PIX.QMSAPI.DataObjectsTaskType
Type of the task. This must be specified correctly to be able to perform the service. Undefined is a specific type and not a wildcard option.

Return Value

Type: Boolean
True if the task was successfully removed, otherwise false.
Remarks
Permanently removes a task from the task list.
Security note Security Note

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

Examples
The following code example simply deletes a task. Note however that there is no generic task type so you must to define the type parameter correctly.

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("ad549720-6bb5-4c66-b8c7-c6a5fb68e2a9"); // A known task Guid.

             bool result = apiClient.DeleteTask(taskId, TaskType.PauseTask); // A service call. Only applicable to pause type tasks.
             Console.WriteLine(result ? "Task deleted succesfully." : "Failed to delete task");
         }
         catch (Exception ex)
         {
             Console.WriteLine("An exception occurred: " + ex.Message);
         }
         // wait for user to press any key
         Console.ReadLine();
     }
}
See Also