ProjectPlanTasks_Update Operation

Applies to QAComplete 14.3, last modified on February 19, 2024

Gets a project plan task by its ID and updates its properties with specified values. All unspecified properties are cleared.

Requirements

The authenticating user must belong to a security group that has the following privileges:

  • Update access to Project Plan Tasks (Project Team Members).

  • Update access to Project Plan Maintenance (Project Manager).

Parameters

The operation uses the following parameters:

AuthenticationData  :  object, required

An AuthenticationData object containing the login information and the project ID whose task you want to update.

ProjectPlanTasks  :  , required

An updated ProjectPlanTasks object.

SendEMailAlert  :  string, required

Y if you want to send an email alert; N otherwise.

Result

None.

Example

Sample Code

C#

ServiceSoapClient service = new ServiceSoapClient();

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

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;

// Prepare the task object
ProjectPlanTask task = new ProjectPlanTask();

// Specify the task object to update
int Id = 25;

// Load existing task data
task = service.ProjectPlanTasks_Load(authData, Id);

// Specify new values of the task properties
task.AssigneeUserId = 24661;
task.PriorityCode = "2-Medium";

// Update the task
service.ProjectPlanTasks_Update(authData, task, "Y");

Java

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

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

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

// Prepare the task object
ProjectPlanTask task = new ProjectPlanTask();

// Specify the task to update
int Id = 25;

// Load existing task data
task = service.projectPlanTasksLoad(authData, Id);

// Specify new values of the task properties
task.setAssigneeUserId(24661);
task.setPriorityCode("2-Medium");

// Update the task
service.projectPlanTasksUpdate(authData, task, "Y");

Sample Request XML

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

<?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_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
      </AuthenticationData>
      <ProjectPlanTasks>
        <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</EstHrs>
        <EstCostInt>60</EstCostInt>
        <EstCostExt>18</EstCostExt>
        <ActStart>2014-07-18T08:00:00</ActStart>
        <ActFinish>2014-07-21T18:00:00</ActFinish>
        <ActHrs>10</ActHrs>
        <ActCostInt>0</ActCostInt>
        <ActCostExt>0</ActCostExt>
        <AssigneeUserId>24661</AssigneeUserId>
        <PriorityCode>2-Medium</PriorityCode>
        <PctComplete>100</PctComplete>
        <Description>New task description.</Description>
        <FunctSpecId>0</FunctSpecId>
        <IsBillable>Y</IsBillable>
        <EstHrsRemaining>0</EstHrsRemaining>
        <LinkedItemId>0</LinkedItemId>
        <AssignedToName>Doe, John</AssignedToName>
        <DateCreated>2014-07-17T06:33:08</DateCreated>
        <DateUpdated>2014-07-20T22:53:07</DateUpdated>
        <ImportId>0</ImportId>
        <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>
      <SendEMailAlert>Y</SendEMailAlert>
    </ProjectPlanTasks_Update>
  </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: 1711 {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_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
      </AuthenticationData>
      <ProjectPlanTasks>
        <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</EstHrs>
        <EstCostInt>60</EstCostInt>
        <EstCostExt>18</EstCostExt>
        <ActStart>2014-07-18T08:00:00</ActStart>
        <ActFinish>2014-07-21T18:00:00</ActFinish>
        <ActHrs>10</ActHrs>
        <ActCostInt>0</ActCostInt>
        <ActCostExt>0</ActCostExt>
        <AssigneeUserId>24661</AssigneeUserId>
        <PriorityCode>2-Medium</PriorityCode>
        <PctComplete>100</PctComplete>
        <Description>New task description.</Description>
        <FunctSpecId>0</FunctSpecId>
        <IsBillable>Y</IsBillable>
        <EstHrsRemaining>0</EstHrsRemaining>
        <LinkedItemId>0</LinkedItemId>
        <AssignedToName>Doe, John</AssignedToName>
        <DateCreated>2014-07-17T06:33:08</DateCreated>
        <DateUpdated>2014-07-20T22:53:07</DateUpdated>
        <ImportId>0</ImportId>
        <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>
      <SendEMailAlert>Y</SendEMailAlert>
    </ProjectPlanTasks_Update>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 317 {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_UpdateResponse xmlns="http://www.pragmaticsw.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 327 {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_UpdateResponse xmlns="http://www.pragmaticsw.com/" />
  </soap12:Body>
</soap12:Envelope>

See Also

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

Highlight search results