Overview
This web service inserts or updates a single project based on a detailed project structure (PwsProjectDetail). The service returns the identity (PwsProjectRef) of the project that has been inserted or updated. The caller can optionally request that the full project detail (PwsProjectElement) be included in the response. Please note, upon creation of a new project, certain attributes may be derived from engagement type defaults or inherited from the engagement.
...
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | Ad0gaqAh34T3anLQ/dUmpQ== | ||
CloseDateClearFlag | Boolean | No | false | If set to "true", the end date of the project will be cleared. | false |
CostGlccOverrideClearFlag | Boolean | deprecated | *** This field has been deprecated *** | ||
DescriptionClearFlag | Boolean | No | false | If set to "true", project description will be cleared.. | false |
FullDetailFlag | Boolean | No | false | If set to "true", full project element will be included in response. | false |
Mode | String (1) | Yes | Applies if FullDetailFlag is set to true: A to retrieve booked data for roles. R to retrieve requested data for roles. E to retrieve effective data for roles (booked data for booked roles, requested data for requested roles). | A/R | |
PercentLikelihoodClearFlag | Boolean | No | false | If set to "true", project percent likelihood will be cleared. When this value is cleared, the percent likelihood is derived from the percent likelihood value associated with the project's stage. | false |
Project | Yes | Structure that contains the complete information of the project. Please click here for more information. If PwsProjectDetail refers to an existing project, this request updates this project; otherwise, this request creates a new project. | |||
StealLockFlag | Boolean | deprecated | *** This field has been deprecated *** | ||
TimeGlccOverrideClearFlag | Boolean | deprecated | *** This field has been deprecated *** | ||
WorkspaceMessagesClearFlag | Boolean | No | false | If set to "true", project workspace message will be cleared. | false |
ForceAdvancedSetupChangeFlag | Boolean | No | false | Advanced: This can be used to force PLCC mapping changes for time and/or cost mappings in the face of existing transactional data. If this flag is not set to true, an error will be returned if you attempt to change the time or cost PLCC mappings and there are time card or cost card transactions associated with the project. Note you must also have advanced project setup permission to force the mapping changes. | false |
EngagementTimestamp | String | deprecated | *** This field has been deprecated *** | ||
ManagementTeamClearFlag | Boolean | No | false | If set to "true", clear the non-PM members of the project management team. | false |
BdDashboardClearFlag | Boolean | No | false | If set to "true", clear the Belladati (advanced analytics) dashboard configuration for this project, and BdDashboards data is ignored. | false |
ExpenseTypeConfigurationClearFlag | Boolean | No | false | if set to "true", clear the expenes type configuration for this project. | false |
| LocksToSteal | PwsEntityLockSummary[1.100] | No | The detailed information of the locks that are to be stolen. If not specified, the request will fail if any requested locks are already held. If specified, the information supplied must exactly match the current state of existing locks or the attempt to steal the existing locks will fail. Typically, this service is invoked with LocksToSteal empty or null. If there are existing locks, they will be returned in the LockHolders member of PwsFault. This data can then be sent, as is, back to the server in a second invocation of this service, as LocksToSteal, if the caller desires to steal the locks. | ||
| ProjectorLockSetId | Int32 | No | A projector lock set id is an identifier for a group of one or more locks held as a unit. | ||
| AamDashboardClearFlag | Boolean | No | false | True to clear AAM dashboards for project. | |
| ExcludeReadNotesFlag | Boolean | No | false | If true, notes that have been marked as read by the current user are excluded from the data returned. Applies only when FullDetailFlag is true. | |
| IncludeDeletedRolesFlag | Boolean | No | false | If true, deleted roles are included in the response data. Applies only when FullDetailFlag is true. | |
| RevalueAction | String | No | N | This indicates how the service should respond if there are time cards that would become in need of revalue as a result of the changes. The valid values are:
| |
| InvoiceTabMessageClearFlag | Boolean | No | false | If set to "true", clear the invoice tab message for this project. | |
| IssueCategoryClearFlag | Boolean | No | false | If set to "true", clear the issue category for this project. | |
| IssueStatusClearFlag | Boolean | No | false | If set to "true", clear the issue status configuration for this project. | |
| ProjectLoginClearFlag | Boolean | No | false | If set to "true", clear the users on Client Logins tab. | |
| WorkspaceLogoClearFlag | Boolean | No | false | If set to "true", clear the project logo. | |
| SetCloseDateIfStageIsClosedFlag | Boolean |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsSaveProject>
<pws:serviceRequest>
<req:SessionTicket>Af3sL0FGHhwhM4iKAOvIew==</req:SessionTicket>
<sch:CloseDateClearFlag>true</sch:CloseDateClearFlag>
<sch:CostGlccOverrideClearFlag>false</sch:CostGlccOverrideClearFlag>
<sch:DescriptionClearFlag>false</sch:DescriptionClearFlag>
<sch:FullDetailFlag>false</sch:FullDetailFlag>
<sch:Mode>R</sch:Mode>
<sch:PercentLikelihoodClearFlag>false</sch:PercentLikelihoodClearFlag>
<sch:Project>
<com:ProjectCode>P001053-001</com:ProjectCode>
<com:EngagementIdentity>
<com:EngagementCode>P001053</com:EngagementCode>
</com:EngagementIdentity>
<com:NewProjectCode>P001053-WS1</com:NewProjectCode>
<com:ContractLineItemIdentity>
<com:ContractLineItemCode>P001053-CL1</com:ContractLineItemCode>
</com:ContractLineItemIdentity>
</sch:Project>
<sch:StealLockFlag>true</sch:StealLockFlag>
</pws:serviceRequest>
</pws:PwsSaveProject>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
DateTime | Click here for more information. | ||
Project | The complete set of information about the project. Populated only if FullDetailFlag is specified in the request. Click here for more information. | ||
ProjectIdentity | The unique keys used to identify the project. Click here for more information. | ||
| RevalueReport | PwsRevalueReport | Information about time cards on the project that were affected or would be affected by the change. Populated only when RevalueAction is R (Revalue) or C (Check). If RevalueAction is R, the values included in this structure reflect what was done. If RevalueAction is C, the values reflect what would be done if the service were invoked again with RevalueAction set to R. | |
EngagementTimestamp | String | *** This field has been deprecated *** | |
LockStolenFromUserIdentity | *** This field has been deprecated *** | ||
| ProjectTimestamp | String | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value. | |
| StolenLocks | PwsEntityLockSummary | This structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request. |
...