ProjectDocument.getTaskByIndexAsync method

Asynchronously gets the GUID of the task that has the specified index in the task collection.

Important: This API works only in Project 2016 on Windows desktop.

Hosts: Project
Available in Requirement set Selection
Added in 1.1
Office.context.document.getTaskByIndexAsync(taskIndex[, options][, callback]);


    Type: number

    The index of the task in the collection of tasks for the project. Required.

    The following optional parameter:

        Type: array, boolean, null, number, object, string, or undefined

        A user-defined item of any type that is returned in the AsyncResult object without being altered. Optional.

        For example, you can pass the asyncContext argument by using the format {asyncContext: 'Some text'} or {asyncContext: <object>}.

    Type: function

    A function that is invoked when the method call returns, where the only parameter is of type AsyncResult. Optional.

Callback Value

When the callback function executes, it receives an AsyncResult object that you can access from the parameter in the callback function.

For the getTaskByIndexAsync method, the returned AsyncResult object contains following properties.

Name Description
asyncContext The data passed in the optional asyncContext parameter, if the parameter was used.
error Information about the error, if the status property equals failed.
status The succeeded or failed status of the asynchronous call.
value The GUID of the task as a string.


To get the maximum index of the collection of tasks for the project, use the getMaxTaskIndexAsync method. The 0 index task represents the project summary task.


The following code example calls getMaxTaskIndexAsync to get the maximum index in the project's task collection, and then calls getTaskByIndexAsync to get the GUID for each task.

The example assumes that your add-in has a reference to the jQuery library and that the following page controls are defined in the content div in the page body.

<input id="get-info" type="button" value="Get info" /><br />
<span id="message"></span>
(function () {
    "use strict";
    var taskGuids = ;

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.

    // Get the maximum task index, and then get the task GUIDs.
    function getTaskInfo() {
            function (data) {

    // Get the maximum index of the tasks for the current project.
    function getMaxTaskIndex() {
        var defer = $.Deferred();
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                else {
        return defer.promise();

    // Get each task GUID, and then display the GUIDs in the add-in.
    function getTaskGuids(maxTaskIndex) {
        var defer = $.Deferred();
        for (var i = 0; i <= maxTaskIndex; i++) {
        return defer.promise();
        function getTaskGuid(index) {
                function (result) {
                    if (result.status === Office.AsyncResultStatus.Succeeded) {
                        if (index == maxTaskIndex) {
                    else {
    function onError(error) {
        app.showNotification( + ' ' + error.code + ': ' + error.message);

Support details

A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Office for Windows desktop Office Online (in browser)
Project Y
Available in requirement sets
Minimum permission level ReadDocument
Add-in types Task pane
Library Office.js
Namespace Office

Support history

Version Changes
1.1 Introduced

See also

Other resources

getMaxTaskIndexAsync AsyncResult object ProjectDocument object