Skip to main content Skip to complementary content

GetTasksForDocument Method

Overloads

GetTasksForDocument(Guid)

Gets the tasks for document.

GetTasksForDocument(Guid)

Gets the tasks for document.

Declaration

      List<TaskInfo> GetTasksForDocument(Guid documentID)
    

Parameters

Type Name Description
System.Guid documentID

The document ID.

Returns

Type Description
System.Collections.Generic.List<TaskInfo>

A list of all tasks associated with a specific document.

Remarks

Each document can have tasks associated with it.

security

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

Examples

The following code example retrieves a list of the tasks associated with a specific document and displays the task name of the first element.

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 documentId = new Guid("e95ecd5a-683d-1d33-26bf-66e94ff08223");
            IList<TaskInfo> documentTasks = apiClient.GetTasksForDocument(documentId); // A service call.
            Console.WriteLine(documentTasks[0].Name); // Displays the name of the first element.
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

See Also

GetTasks(System.Guid)
DeleteTask(System.Guid, TaskType)
RunTask(System.Guid)
AbortTask(System.Guid)
GetTaskLog(System.Guid, System.Guid, System.Int32)

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