ProjectPlanTasks_Load Operation

Applies to QAComplete 12.71 SaaS & On-Premises, last modified on January 25, 2021

Returns the ProjectPlanTask object corresponding to a project plan task specified by its ID.

To specify a project that contains the project plan task, use the ProjId value in the AuthenticationData object in the request body. To search for the project plan task 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 Project Plan Tasks (Project Team Members).

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 task you want to get.

TaskId  :  integer, required

The ID of the task in the QAComplete project.

Result

The ProjectPlanTask object that stores information on the needed task in the project plan.

Example

Sample Code

C#

ServiceSoapClient service = new ServiceSoapClient();

string login = "john.doe@example.com";
string password = "p@ssword";

// 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 = 25;

// Get the task
ProjectPlanTask task = service.ProjectPlanTasks_Load(authData, taskId);
Console.WriteLine(task.TaskName);

Java

String login = "john.doe@example.com";
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 = 25;

// Get the task
ProjectPlanTask task = new ProjectPlanTask();
task = service.projectPlanTasksLoad(authData, taskId);

System.out.println(task.getTaskName());

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 506 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/ProjectPlanTasks_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>
    <ProjectPlanTasks_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>25</TaskId>
    </ProjectPlanTasks_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: 514 {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>
    <ProjectPlanTasks_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>25</TaskId>
    </ProjectPlanTasks_Load>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1732 {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>
    <ProjectPlanTasks_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <ProjectPlanTasks_LoadResult>
        <TaskId>25</TaskId>
        <TaskName>Test new input controls</TaskName>
        <ProjPlanId>1</ProjPlanId>
        <Indent>3</Indent>
        <IsParent>Y</IsParent>
        <IsExpanded>N</IsExpanded>
        <SeqNum>6</SeqNum>
        <PredNum>5</PredNum>
        <EstStart>2014-07-18T08:00:00</EstStart>
        <EstFinish>2014-07-21T18:00:00</EstFinish>
        <EstHrs>12.000</EstHrs>
        <EstCostInt>60</EstCostInt>
        <EstCostExt>18</EstCostExt>
        <ActStart>0001-01-01T00:00:00</ActStart>
        <ActFinish>0001-01-01T00:00:00</ActFinish>
        <ActHrs>0.000</ActHrs>
        <ActCostInt>0</ActCostInt>
        <ActCostExt>0</ActCostExt>
        <RequestedBy>Doe, John</RequestedBy>
        <AssigneeUserId>24661</AssigneeUserId>
        <PriorityCode>2-Medium</PriorityCode>
        <PctComplete>0</PctComplete>
        <Description>New task description.</Description>
        <FunctSpecId>0</FunctSpecId>
        <IsBillable>Y</IsBillable>
        <EstHrsRemaining>4.000</EstHrsRemaining>
        <LinkedItemId>0</LinkedItemId>
        <AssignedToName>Doe, John</AssignedToName>
        <DateCreated>2014-07-17T06:33:08.43</DateCreated>
        <DateUpdated>2014-07-20T22:53:07</DateUpdated>
        <ImportId>0</ImportId>
        <IsActive>Y</IsActive>
        <IsEstFinishOverriden>N</IsEstFinishOverriden>
        <NbrEvents>0</NbrEvents>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
        <OriginalId>0</OriginalId>
        <OwnerName>Doe, John</OwnerName>
        <OwnerUserId>24661</OwnerUserId>
        <ProjId>11873</ProjId>
        <ProjPlanName>Test Plan</ProjPlanName>
        <UpdateUserId>24661</UpdateUserId>
        <UserName>Doe, John</UserName>
      </ProjectPlanTasks_LoadResult>
    </ProjectPlanTasks_LoadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1742 {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>
    <ProjectPlanTasks_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <ProjectPlanTasks_LoadResult>
        <TaskId>25</TaskId>
        <TaskName>Test new input controls</TaskName>
        <ProjPlanId>1</ProjPlanId>
        <Indent>3</Indent>
        <IsParent>Y</IsParent>
        <IsExpanded>N</IsExpanded>
        <SeqNum>6</SeqNum>
        <PredNum>5</PredNum>
        <EstStart>2014-07-18T08:00:00</EstStart>
        <EstFinish>2014-07-21T18:00:00</EstFinish>
        <EstHrs>12.000</EstHrs>
        <EstCostInt>60</EstCostInt>
        <EstCostExt>18</EstCostExt>
        <ActStart>0001-01-01T00:00:00</ActStart>
        <ActFinish>0001-01-01T00:00:00</ActFinish>
        <ActHrs>0.000</ActHrs>
        <ActCostInt>0</ActCostInt>
        <ActCostExt>0</ActCostExt>
        <RequestedBy>Doe, John</RequestedBy>
        <AssigneeUserId>24661</AssigneeUserId>
        <PriorityCode>2-Medium</PriorityCode>
        <PctComplete>0</PctComplete>
        <Description>New task description.</Description>
        <FunctSpecId>0</FunctSpecId>
        <IsBillable>Y</IsBillable>
        <EstHrsRemaining>4.000</EstHrsRemaining>
        <LinkedItemId>0</LinkedItemId>
        <AssignedToName>Doe, John</AssignedToName>
        <DateCreated>2014-07-17T06:33:08.43</DateCreated>
        <DateUpdated>2014-07-20T22:53:07</DateUpdated>
        <ImportId>0</ImportId>
        <IsActive>Y</IsActive>
        <IsEstFinishOverriden>N</IsEstFinishOverriden>
        <NbrEvents>0</NbrEvents>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
        <OriginalId>0</OriginalId>
        <OwnerName>Doe, John</OwnerName>
        <OwnerUserId>24661</OwnerUserId>
        <ProjId>11873</ProjId>
        <ProjPlanName>Test Plan</ProjPlanName>
        <UpdateUserId>24661</UpdateUserId>
        <UserName>Doe, John</UserName>
      </ProjectPlanTasks_LoadResult>
    </ProjectPlanTasks_LoadResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

ProjectPlanTasks_Add
ProjectPlanTasks_Delete
ProjectPlanTasks_LoadByCriteria
ProjectPlanTasks_Update
Project Operations
Project Plan Tasks Operations
SOAP API Reference

Highlight search results