Click or drag to resize
IQMSRemoteGetDocumentTask Method
Retrieves a single task from a remote QlikView Management Service.

Namespace: PIX.Services.V12
Assembly: 
Syntax
DocumentTask RemoteGetDocumentTask(
	Guid remoteQmsId,
	Guid taskId,
	DocumentTaskScope scope
)

Parameters

remoteQmsId
Type: SystemGuid
The ID of the remote QlikView Management Service.
taskId
Type: SystemGuid
The ID of the task to import.
scope
Type: PIX.QMSAPI.DataObjectsDocumentTaskScope
The scope identifies which settings of the task to retrieve.

Return Value

Type: DocumentTask
A document task.
Remarks
Each document can have tasks associated with it.
Security note Security Note

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

Examples
This example retrieves detailed information about all tasks for a specific document.

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

            //Get a remote QlikView Management service.
            ServiceInfo remoteQMSService = apiClient.GetServices(ServiceTypes.RemoteQlikViewManagementService).FirstOrDefault();

            if (remoteQMSService != null)
            {
                Guid docId = new Guid ("12a32214-1122-112a-8099-8765ce564112"); // The document ID.      

                //Get a list of tasks for the document.
                List<TaskInfo> taskInfos = apiClient.RemoteGetTaskListForDocID(remoteQMSService.ID, docId);
                taskInfos.ForEach( delegate (TaskInfo taskInfo)
                    {
                        //Retrieve full information about the task.
                        DocumentTask documentTask = apiClient.RemoteGetDocumentTask(remoteQMSService.ID, taskInfo.ID, DocumentTaskScope.All);

                        if (documentTask == null) return;

                        Console.WriteLine("Name:" + documentTask.General.TaskName);
                        Console.WriteLine("Description" + documentTask.General.TaskDescription);
                        Console.WriteLine();
                    }
                );
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
See Also