Skip to main content Skip to complementary content

GetDocumentTask Method

Overloads

GetDocumentTask(Guid, DocumentTaskScope)

Gets the document task. The scope parameter is used to define what information to retrieve about the task.

GetDocumentTask(Guid, DocumentTaskScope)

Gets the document task. The scope parameter is used to define what information to retrieve about the task.

Declaration

      DocumentTask GetDocumentTask(Guid documentTaskID, DocumentTaskScope scope)
    

Parameters

Type Name Description
System.Guid documentTaskID

The document task ID.

DocumentTaskScope scope

The scope.

Returns

Type Description
DocumentTask

A task with the specified ID and scope.

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 example retrieves a task associated with a document, displays the name of the task and then saves the document task. It would have been just as easy to change the task information instead of displaying it.

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 documentTaskId = new Guid("e95ecd5a-683d-1d33-26bf-66e94ff08223");
            DocumentTask documentTask = apiClient.GetDocumentTask(documentTaskId, DocumentTaskScope.All); // A service call to collect the document task.
            Console.WriteLine(documentTask.Document.Name); // Displays the name of the specified document.
            apiClient.SaveDocumentTask(documentTask); // A service call to save the document task.
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
  

See Also

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