ProjectTasks_Load Operation

Applies to QAComplete 14.5, last modified on August 06, 2024

Returns the ProjectTask object that stores data on the agile task, to do list, or appointment specified by its ID.

To specify a project that contains the item, use the ProjId value in the AuthenticationData object in the request body. To search for the item in several projects, use the ProjIds value to specify the list of projects IDs in the AuthenticationData object.

Requirements

The authenticating user must belong to a security group that has the Read privilege for Agile Tasks.

Parameters

The operation uses the following parameters:

AuthenticationData  :  , required

An AuthenticationData object with the login information and the ID of the project (or the list of project IDs) whose agile task, to do list or appointment you want to get.

TaskId  :  integer, required

The ID of the agile task, to do list or appointment in the QAComplete project.

Result

The ProjecTask object that stores information on the needed agile task, to do list, or appointment in the project.

Example

Sample Code

C#

string login = "[email protected]";
string password = "p@ssword";

ServiceSoapClient service = new ServiceSoapClient();

// Prepare AuthenticationData
LoginInfo loginInfo = service.GetLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.AppCode = loginInfo.AppCode;
authData.UserId = loginInfo.UserId;
authData.PassCode = password;
authData.DeptId = loginInfo.DeptId;
authData.ProjId = loginInfo.ProjId;

// ID of the desired task
int taskId = 14;

// Get the agile task
ProjectTask agileTask = service.ProjectTasks_Load(authData, taskId);
Console.WriteLine(agileTask.Title);

Java

String login = "[email protected]";
String password = "p@ssword";

ServiceSoap service = new Service().getServiceSoap12();

// Prepare AuthenticationData
LoginInfo loginInfo = service.getLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.setAppCode(loginInfo.getAppCode());
authData.setUserId(loginInfo.getUserId());
authData.setPassCode(password);
authData.setDeptId(loginInfo.getDeptId());
authData.setProjId(loginInfo.getProjId());

// ID of the desired task
int taskId = 14;

// Get the agile task
ProjectTask agileTask = new ProjectTask();
agileTask = service.projectTasksLoad(authData, taskId);

System.out.println(agileTask.getTitle());

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 498 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/ProjectTasks_Load"
 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ProjectTasks_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <TaskId>14</TaskId>
    </ProjectTasks_Load>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 506 {Insert an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ProjectTasks_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <TaskId>14</TaskId>
    </ProjectTasks_Load>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1728 {The server returns an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ProjectTasks_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <ProjectTasks_LoadResult>
        <TaskId>14</TaskId>
        <TaskTypeCode>ProjectTasks</TaskTypeCode>
        <Title>Create sample input data</Title>
        <PctComplete>37</PctComplete>
        <EstHrs>12.000</EstHrs>
        <ActualHrs>12.000</ActualHrs>
        <EstCost>16</EstCost>
        <ActualCost>0.0000</ActualCost>
        <RequestedBy>Doe, John</RequestedBy>
        <OwnerUserId>24661</OwnerUserId>
        <AssigneeUserId>24661</AssigneeUserId>
        <PriorityCode>1-High</PriorityCode>
        <StatusCode>Active</StatusCode>
        <SortOrder>0</SortOrder>
        <Description>Create a set of input values for test 1.</Description>
        <TaskUnits>0</TaskUnits>
        <TaskDuration>Hour(s)</TaskDuration>
        <ShowTimeAs>Busy</ShowTimeAs>
        <IsRecurring>N</IsRecurring>
        <IsMeeting>N</IsMeeting>
        <FirstRecurTaskId>0</FirstRecurTaskId>
        <FolderId>0</FolderId>
        <AssignedToName>Doe, John</AssignedToName>
        <DateCreated>2014-07-17T06:33:08.43</DateCreated>
        <DateUpdated>2014-07-20T22:53:07</DateUpdated>
        <EventType>Project Task</EventType>
        <FKId>0</FKId>
        <ImportId>0</ImportId>
        <NbrEvents>0</NbrEvents>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
        <NbrTasks>0</NbrTasks>
        <OriginalId>0</OriginalId>
        <OwnerName>Doe, John</OwnerName>
        <ProjId>11873</ProjId>
        <ScheduledEventId>0</ScheduledEventId>
        <UpdateUserId>24661</UpdateUserId>
        <UserName>Doe, John</UserName>
        <ActStart>0001-01-01T00:00:00</ActStart>
        <ActFinish>0001-01-01T00:00:00</ActFinish>
        <EstStart>2014-07-18T08:00:00</EstStart>
        <EstFinish>2014-07-21T23:59:00</EstFinish>
      </ProjectTasks_LoadResult>
    </ProjectTasks_LoadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1738 {The server returns an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ProjectTasks_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <ProjectTasks_LoadResult>
        <TaskId>14</TaskId>
        <TaskTypeCode>ProjectTasks</TaskTypeCode>
        <Title>Create sample input data</Title>
        <PctComplete>37</PctComplete>
        <EstHrs>12.000</EstHrs>
        <ActualHrs>12.000</ActualHrs>
        <EstCost>16</EstCost>
        <ActualCost>0.0000</ActualCost>
        <RequestedBy>Doe, John</RequestedBy>
        <OwnerUserId>24661</OwnerUserId>
        <AssigneeUserId>24661</AssigneeUserId>
        <PriorityCode>1-High</PriorityCode>
        <StatusCode>Active</StatusCode>
        <SortOrder>0</SortOrder>
        <Description>Create a set of input values for test 1.</Description>
        <TaskUnits>0</TaskUnits>
        <TaskDuration>Hour(s)</TaskDuration>
        <ShowTimeAs>Busy</ShowTimeAs>
        <IsRecurring>N</IsRecurring>
        <IsMeeting>N</IsMeeting>
        <FirstRecurTaskId>0</FirstRecurTaskId>
        <FolderId>0</FolderId>
        <AssignedToName>Doe, John</AssignedToName>
        <DateCreated>2014-07-17T06:33:08.43</DateCreated>
        <DateUpdated>2014-07-20T22:53:07</DateUpdated>
        <EventType>Project Task</EventType>
        <FKId>0</FKId>
        <ImportId>0</ImportId>
        <NbrEvents>0</NbrEvents>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
        <NbrTasks>0</NbrTasks>
        <OriginalId>0</OriginalId>
        <OwnerName>Doe, John</OwnerName>
        <ProjId>11873</ProjId>
        <ScheduledEventId>0</ScheduledEventId>
        <UpdateUserId>24661</UpdateUserId>
        <UserName>Doe, John</UserName>
        <ActStart>0001-01-01T00:00:00</ActStart>
        <ActFinish>0001-01-01T00:00:00</ActFinish>
        <EstStart>2014-07-18T08:00:00</EstStart>
        <EstFinish>2014-07-21T23:59:00</EstFinish>
      </ProjectTasks_LoadResult>
    </ProjectTasks_LoadResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

ProjectTasks_Add
ProjectTasks_Delete
ProjectTasks_LoadByCriteria
ProjectTasks_Update
Agile Tasks Operations
SOAP API Reference

Highlight search results