Applies to QAComplete 12.21 SaaS, last modified on July 15, 2019

Gets an agile task, appointment, or to do list 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 Update privilege for Agile Tasks.

Parameters

The operation uses the following parameters:

AuthenticationData  :  , required

An AuthenticationData object containing the login information and the ID of the project whose agile tasks, appointments, or to do lists you want to update.

ProjectTasks  :  ProjectTask, required

An updated ProjectTasks object.

SendEMailAlert  :  string, required

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

Result

None.

Remarks

The ProjectTask object has matching Id and Name properties, for example, FolderId and FolderName. To set them, specify the value only for the Id property. The corresponding Name property will be set automatically.

Example

Sample Code

C#

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

// Prepare the agile task object
ProjectTask agileTask = new ProjectTask();

// Specify the agile task object to update
int Id = 14;

// Load existing agile task data
agileTask = service.ProjectTasks_Load(authData, Id);

// Specify new values of the agile task properties
agileTask.PctComplete = 37;
agileTask.EstHrs = 12;
agileTask.AssigneeUserId = 24661;

// Update the agile task
service.ProjectTasks_Update(authData, agileTask, "Y");

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

// Prepare the agile task object
ProjectTask agileTask = new ProjectTask();

// Specify the agile task to update
int Id = 14;

// Load existing agile task data
agileTask = service.projectTasksLoad(authData, Id);

// Specify new values of the agile task properties
agileTask.setPctComplete(37);
agileTask.setEstHrs(new BigDecimal(12.0));
agileTask.setAssigneeUserId(24661);

// Update the agile task
service.projectTasksUpdate(authData, agileTask, "Y");

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 1944 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/ProjectTasks_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>
    <ProjectTasks_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <ProjectTasks>
        <TaskId>14</TaskId>
        <TaskTypeCode>ProjectTasks</TaskTypeCode>
        <Title>Create sample input data</Title>
        <MLSId>0</MLSId>
        <DateBegin>2014-07-24T00:00:00</DateBegin>
        <DateEnd>2014-07-25T00:00:00</DateEnd>
        <DateDue>0000-00-00T00:00:00</DateDue>
        <PctComplete>37</PctComplete>
        <EstHrs>12.000</EstHrs>
        <ActualHrs>12.000</ActualHrs>
        <EstCost>16</EstCost>
        <ActualCost>65</ActualCost>
        <RequestedBy>Doe, John</RequestedBy>
        <OwnerUserId>0</OwnerUserId>
        <AssigneeUserId>24661</AssigneeUserId>
        <PriorityCode>2-Medium</PriorityCode>
        <StatusCode>Active</StatusCode>
        <SortOrder>2</SortOrder>
        <IsOnActivityRpt>0</IsOnActivityRpt>
        <TaskUnits>2</TaskUnits>
        <TaskDuration>Hour(s)</TaskDuration>
        <ShowTimeAs>Busy</ShowTimeAs>
        <IsRecurring>N</IsRecurring>
        <IsMeeting>N</IsMeeting>
        <FirstRecurTaskId>0</FirstRecurTaskId>
        <FirstMeetingTaskId>0</FirstMeetingTaskId>
        <FolderId>0</FolderId>
        <OutlookId>0</OutlookId>
        <AssignedToName>Doe, John</AssignedToName>
        <DateCreated>2014-07-17T06:33:08.43</DateCreated>
        <DateUpdated>2014-07-20T22:53:07</DateUpdated>
        <FKId>0</FKId>
        <ImportId>0</ImportId>
        <NbrEvents>0</NbrEvents>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
        <NbrTasks>0</NbrTasks>
        <OriginalId>0</OriginalId>
        <ProjId>11873</ProjId>
        <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>
      <SendEMailAlert>Y</SendEMailAlert>
    </ProjectTasks_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: 1952 {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_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <ProjectTasks>
        <TaskId>14</TaskId>
        <TaskTypeCode>ProjectTasks</TaskTypeCode>
        <Title>Create sample input data</Title>
        <MLSId>0</MLSId>
        <DateBegin>2014-07-24T00:00:00</DateBegin>
        <DateEnd>2014-07-25T00:00:00</DateEnd>
        <DateDue>0000-00-00T00:00:00</DateDue>
        <PctComplete>37</PctComplete>
        <EstHrs>12.000</EstHrs>
        <ActualHrs>12.000</ActualHrs>
        <EstCost>16</EstCost>
        <ActualCost>65</ActualCost>
        <RequestedBy>Doe, John</RequestedBy>
        <OwnerUserId>0</OwnerUserId>
        <AssigneeUserId>24661</AssigneeUserId>
        <PriorityCode>2-Medium</PriorityCode>
        <StatusCode>Active</StatusCode>
        <SortOrder>2</SortOrder>
        <IsOnActivityRpt>0</IsOnActivityRpt>
        <TaskUnits>2</TaskUnits>
        <TaskDuration>Hour(s)</TaskDuration>
        <ShowTimeAs>Busy</ShowTimeAs>
        <IsRecurring>N</IsRecurring>
        <IsMeeting>N</IsMeeting>
        <FirstRecurTaskId>0</FirstRecurTaskId>
        <FirstMeetingTaskId>0</FirstMeetingTaskId>
        <FolderId>0</FolderId>
        <OutlookId>0</OutlookId>
        <AssignedToName>Doe, John</AssignedToName>
        <DateCreated>2014-07-17T06:33:08.43</DateCreated>
        <DateUpdated>2014-07-20T22:53:07</DateUpdated>
        <FKId>0</FKId>
        <ImportId>0</ImportId>
        <NbrEvents>0</NbrEvents>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
        <NbrTasks>0</NbrTasks>
        <OriginalId>0</OriginalId>
        <ProjId>11873</ProjId>
        <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>
      <SendEMailAlert>Y</SendEMailAlert>
    </ProjectTasks_Update>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

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

See Also

ProjectTasks_Add
ProjectTasks_Delete
ProjectTasks_Load
ProjectTasks_LoadByCriteria
Agile Tasks Operations
SOAP API Reference

Highlight search results