Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Overview

This web service inserts or updates a single project task based on a detailed project task structure (PwsProjectTaskDetail). The service returns the identity (PwsProjectTaskDetail) of the project Task that has been inserted or updated. 

Request Format

PwsSaveProjectTask Request
  • PwsSaveProjectTask
    • serviceRequest: PwsSaveProjectTaskRq
      • RequestId: Int32
      • SessionTicket: String
      • DescriptionClearFlag: Boolean
      • DriveEsdAndDurationFromPlannedDatesFlag: Boolean
      • EarliestStartDateClearFlag: Boolean
      • EngagementTimestamp: String
      • ParentTaskClearFlag: Boolean
      • PredecessorsClearFlag: Boolean
      • ProjectIdentity: PwsProjectRef
      • ProjectTask: PwsProjectTaskDetail
      • StealLockFlag: Boolean
      • SubscriptionsClearFlag: Boolean

Request Elements

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32



Click here for more information.


SessionTicket

String



Click here for more information.


DescriptionClearFlag

Boolean





DriveEsdAndDurationFromPlannedDatesFlag

Boolean





EarliestStartDateClearFlag

Boolean





EngagementTimestamp

String



This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned in a prior response. This will cause the request to fail if any change has been made between the two invocations.


ParentTaskClearFlag

Boolean





PredecessorsClearFlag

Boolean





ProjectIdentity

PwsProjectRef





ProjectTask

PwsProjectTaskDetail





StealLockFlag

Boolean



If set to 'true', any locks on the project will be stolen if it is currently locked, otherwise, if it is set to 'false' and a lock is in place the service will fail.

false

SubscriptionsClearFlag

Boolean




false

Request Usage Example(s)

Example 01 
<
Example 02 
<

Response Format

PwsSaveProjectTask Response

Response Elements

Element

Data Type

Description

Sample Data

Messages

PwsMessage

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

0

Status

RequestStatus

Click here for more information

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-05T15:44:50.3461017Z

ProjectTaskIdentity

PwsProjectTaskRef

The identity of the project task that was just saved. Click here for more information.


EngagementTimestamp

String

This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned in a prior response. This will cause the request to fail if any change has been made between the two invocations.


LockStolenFromUserIdentity

PwsUserRef

If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from. Click here for more information.


Response Usage Example(s)

Example 01 
</s:Envelope>
Example 02 
   </s:Body>
</s:Envelope>

Common Errors and Warnings

ErrorNumberErrorCodeErrorText
10111RequiredFieldMissingA required field is missing: PredecessorProjectTaskIdentity
54205ProjectTaskReferenceInvalidA specified project task identity was incomplete. Each project task identity must specify either a project task id, project task uid or project task external system identifier.
54655PreviousSiblingNotChildOfParentThe task identified as this task's previous sibling is not a child of the task specified as the parent task (or it is not a top level task if the specified parent task is null or being cleared).
55066TaskPurchaseOrderSpecifiedWhenInheritingPurchase order number may not be specified when inheriting purchase order number.



  • No labels