Versions Compared

Old Version 25

changes.mady.by.user Min Zeng

Saved on

compared with

New Version Current

changes.mady.by.user Min Zeng

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 (PwsProjectDetail) 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.  , updates or deletes one or more project issues. Project issues to be inserted or updated are passed in SaveProjectIssues (PwsProjectIssueDetail). Issues to be deleted are passed in DeleteProjectissues (PwsProjectIssueRef). One or more of the project issues specified to this request may fail without preventing the remaining issues from being saved or deleted. The response will include ProjectIssueResults (PwsSaveProjectIssueResult) which will provide details about each specified issue, including the full details of the saved issue (PwsProjectIssueDetail), whether the issue was successfully saved or deleted, and if not, the specific reason for the failure.

Request Format


Panel
titlePwsSaveProjectIssuesRq

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.


DeleteProjectIssues

PwsProjectIssueRef[]

No


This is the identity of the project issue to be deleted. Click here for more information.


ProjectIdentity

PwsProjectRef

Yes


This is the identity of the project. Click here for more information.


SaveProjectIssues

PwsProjectIssueDetail[]

No


The detailed project issue information to be inserted or updated. Click here for more information.


OverrideDocumentLockFlagBooleanNo
If set to 'true', then request can update the attachment on the issue even if it is checked out/locked. If set to 'false', the save will fail if the attachment on the issue is checked out/locked.

Request Usage Example(s)


Code Block
languagexml
titleExample 01 - deletecreate
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:web="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveProjectIssues>
         <pws:serviceRequest>
            <req:SessionTicket>ASA2SxZGgEWiNl525VyqzwSessionTicket>Ade8vXDjCIr0kcDpdVTbCw==</req:SessionTicket>
            <web:DeleteProjectIssues>ProjectIdentity>
               <com:PwsProjectIssueRef>:ProjectCode>P001125-001</com:ProjectCode>
            </web:ProjectIdentity>
     <com:ProjectIssueUid>1152921504606875462</com:ProjectIssueUid>       <web:SaveProjectIssues>
        </com:PwsProjectIssueRef>       <web:PwsProjectIssueDetail>
     </web:DeleteProjectIssues>             <web:ProjectIdentity><com:ReferenceId>#1</com:ReferenceId>
                  <com:ProjectCode>P001053-WS2</com:ProjectCode><web:Attachments>
             <     </web:ProjectIdentity>Attachments>
                  <web:SaveProjectIssues>CategoryIdentity>
                     <<com:ProjectIssueCategoryUid>1152921504607339490</webcom:SaveProjectIssues>ProjectIssueCategoryUid>
           </pws:serviceRequest>       </pws:PwsSaveProjectIssues>web:CategoryIdentity>
         </soapenv:Body> </soapenv:Envelope>
Code Block
languagexml
titleExample 02 - create
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:web="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>      <web:Description>This is a new issue</web:Description>
            <pws:PwsSaveProjectIssues>      <web:DueDate>2018-10-31z</web:DueDate>
     <pws:serviceRequest>             <req:SessionTicket>ASA2SxZGgEWiNl525Vyqzw==</req:SessionTicket><web:DueDateClearFlag>false</web:DueDateClearFlag>
                  <web:ProjectIdentity>EmailIssueOwnerFlag>false</web:EmailIssueOwnerFlag>
                  <com<web:ProjectCode>P001053-WS2<EmailPmTeamFlag>false</comweb:ProjectCode>
EmailPmTeamFlag>
           </web:ProjectIdentity>       <web:IssueNumber>10</web:IssueNumber>
     <web:SaveProjectIssues>             <web:OwnerIdentity>
  <web:PwsProjectIssueDetail>                   <com:ReferenceId>#1<UserDisplayName>krakauer, larry</com:ReferenceId>UserDisplayName>
                  <web:AttachmentClearFlag>true<</web:AttachmentClearFlag>OwnerIdentity>
                  <web:Priority>M</web:Attachments>Priority>
                  <<web:Resolution>pending</web:Attachments>Resolution>
                  <web:CategoryIdentity>
:ResolutionClearFlag>false</web:ResolutionClearFlag>
                    <com:ProjectIssueCategoryUid>1152921504606992779</com:ProjectIssueCategoryUid> <web:StatusIdentity>
                  </web:CategoryIdentity>   <com:ProjectIssueStatusUid>1152921504608004811</com:ProjectIssueStatusUid>
               <web:Description>Created via web service #5<</web:Description>StatusIdentity>
                  <web:DueDate>2018-02-28z<</web:DueDate>PwsProjectIssueDetail>
            </web:SaveProjectIssues>
      <web:DueDateClearFlag>false</web:DueDateClearFlag>   </pws:serviceRequest>
      </pws:PwsSaveProjectIssues>
   </soapenv:Body>
</soapenv:Envelope>
Code Block
languagexml
titleExample 02 - delete
collapsetrue
<soapenv:Envelope    <web:EmailIssueOwnerFlag>false</web:EmailIssueOwnerFlag>
                  <web:EmailPmTeamFlag>false</web:EmailPmTeamFlag>
                  <web:IssueNumber>3</web:IssueNumber>
                  <web:OwnerIdentity>xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:web="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveProjectIssues>
         <pws:serviceRequest>
    <com:UserDisplayName>larry krakauer</com:UserDisplayName>       <req:SessionTicket>Ade8vXDjCIr0kcDpdVTbCw==</req:SessionTicket>
            </web<web:OwnerIdentity>DeleteProjectIssues>
                  <web:Priority>M</web:Priority><com:PwsProjectIssueRef>
                  <web<com:Resolution>pending<ProjectIssueUid>1152921504606877025</webcom:Resolution>
 ProjectIssueUid>
                <web:ResolutionClearFlag>false</web:ResolutionClearFlag></com:PwsProjectIssueRef>
            </web:DeleteProjectIssues>
      <web:StatusIdentity>      <web:ProjectIdentity>
               <com:ProjectIssueStatusUid>1152921504607253230<ProjectCode>P001125-001</com:ProjectIssueStatusUid>ProjectCode>
                  </web:StatusIdentity>ProjectIdentity>
               </web:PwsProjectIssueDetail><web:SaveProjectIssues>
            </web:SaveProjectIssues>
         </pws:serviceRequest>
      </pws:PwsSaveProjectIssues>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsSaveProjectIssuesRs

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.


ServerTimestampUtc

DateTime

Click here for more information. for more information.

2018-02-06T14:14:21.9169814Z

ProjectIssueResults

PwsSaveProjectIssueResult[]

This structure is part of a response of web service PwsSaveProjectIssues. Click here for more information.


...

Code Block
languagexml
titleExample 01 - deletecreate
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveProjectIssuesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveProjectIssuesResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:i="http://projectorpsawww.w3.comorg/PwsProjectorServices2001/XMLSchema-instance">
            <PwsSaveProjectIssuesResult<Messages xmlns:a="http://projectorpsa.com/DataContracts/Shared/WebCommonServices/" xmlns:ib="http://www.w3.org/2001/XMLSchema-instance"projectorpsa.com/DataContracts/Shared/Common/"/>
            <Messages<ResponseId xmlns="http://projectorpsa.com/CommonServices/" xmlns:b/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/DataContracts/Shared/CommonCommonServices/">Ok</>Status>
            <ResponseId<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>>2018-11-12T20:26:44.0483182Z</ServerTimestampUtc>
            <a:ProjectIssueResults>
              <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status><a:PwsSaveProjectIssueResult>
                  <ServerTimestampUtc<a:ErrorDetail i:nil="true" xmlns:b="http://projectorpsa.com/CommonServicesDataContracts/Shared/Common/">2018-02-06T14:14:21.9169814Z</ServerTimestampUtc>/>
                  <a:ProjectIssueResults/>ProjectIssue>
         </PwsSaveProjectIssuesResult>       </PwsSaveProjectIssuesResponse>     </s:Body>
</s:Envelope>
Code Block
languagexml
titleExample 02 - create
collapsetrue
<s:Envelope xmlns:s<ProjectIssueId i:nil="true" xmlns="http://schemas.xmlsoap.org/soap/envelope/">projectorpsa.com/DataContracts/Shared/Common/"/>
              <s:Body>       <PwsSaveProjectIssuesResponse<ProjectIssueUid xmlns="http://projectorpsa.com/PwsProjectorServices/">DataContracts/Shared/Common/">1152921504606877025</ProjectIssueUid>
                     <PwsSaveProjectIssuesResult<ReferenceId xmlns:a="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">Common/">#1</ReferenceId>
                     <Messages<ExternalSystemIdentifier xmlnsi:nil="http://projectorpsa.com/CommonServices/true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
              <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>       <a:AttachmentClearFlag>false</a:AttachmentClearFlag>
                    <Status xmlns="http<a://projectorpsa.com/CommonServices/">Ok</Status>Attachments/>
                     <ServerTimestampUtc<a:CategoryIdentity xmlns:b="http://projectorpsa.com/CommonServices/">2018-02-06T14:17:47.2506943Z</ServerTimestampUtc>.com/DataContracts/Shared/Common/">
            <a:ProjectIssueResults>            <b:ProjectIssueCategoryId i:nil="true"/>
   <a:PwsSaveProjectIssueResult>                   <a:ErrorDetail i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <b:ProjectIssueCategoryUid>1152921504607339490</b:ProjectIssueCategoryUid>
                     <a:ProjectIssue></a:CategoryIdentity>
                      <ProjectIssueId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">28487</ProjectIssueId><a:Description>This is a new issue</a:Description>
                     <a:DueDate>2018-10-31T00:00:00Z</a:DueDate>
                <ProjectIssueUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606875463</ProjectIssueUid>     <a:DueDateClearFlag>false</a:DueDateClearFlag>
                  <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">#1</ReferenceId>   <a:EmailIssueOwnerFlag>false</a:EmailIssueOwnerFlag>
                     <a:AttachmentClearFlag>false<EmailPmTeamFlag>false</a:AttachmentClearFlag>EmailPmTeamFlag>
                     <a:AttachmentsIssueNumber>2</>a:IssueNumber>
                     <a:CategoryIdentityOwnerIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueCategoryId>351612<UserDisplayName>Krakauer, Larry</b:ProjectIssueCategoryId>
                   UserDisplayName>
    <b:ProjectIssueCategoryUid>1152921504606992779</b:ProjectIssueCategoryUid>                      </a<b:CategoryIdentity>
UserId i:nil="true"/>
                    <a:Description>Created via web service #5<<b:UserReferenceSystemId>097</a:Description>b:UserReferenceSystemId>
                        <a:DueDate>2018-02-28T00:00:00Z</a:DueDate><b:UserUid>1152921504606944254</b:UserUid>
                     <a:DueDateClearFlag>false<</a:DueDateClearFlag>OwnerIdentity>
                     <a:EmailIssueOwnerFlag>false<Priority>M</a:EmailIssueOwnerFlag>Priority>
                     <a:EmailPmTeamFlag>false<Resolution>pending</a:EmailPmTeamFlag>Resolution>
                     <a:IssueNumber>9<ResolutionClearFlag>false</a:IssueNumber>ResolutionClearFlag>
                     <a:OwnerIdentityStatusIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Larry Krakauer</b:UserDisplayName>ProjectIssueStatusId i:nil="true"/>
                        <b:UserId>217832<ProjectIssueStatusUid>1152921504608004811</b:UserId>ProjectIssueStatusUid>
                        <b:UserReferenceSystemId>097</b:UserReferenceSystemId></a:StatusIdentity>
                        <b:UserUid>1152921504606944254</b:UserUid><a:Timestamp>AAAAABFDKdg=</a:Timestamp>
                      </a:OwnerIdentity><a:NewExternalSystemIdentifier i:nil="true"/>
                     <a:Priority>M</a:Priority>:UserDefinedFields xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:Resolution>pending<</a:Resolution>
ProjectIssue>
                    <a:ResolutionClearFlag>false<ReferenceId>#1</a:ResolutionClearFlag>ReferenceId>
               </a:PwsSaveProjectIssueResult>
      <a:StatusIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">      </a:ProjectIssueResults>
         </PwsSaveProjectIssuesResult>
      </PwsSaveProjectIssuesResponse>
       <b:ProjectIssueStatusId>851626</b:ProjectIssueStatusId></s:Body>
</s:Envelope>
Code Block
languagexml
titleExample 02 - delete
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
                    <b:ProjectIssueStatusUid>1152921504607253230</b:ProjectIssueStatusUid>
   <PwsSaveProjectIssuesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
                 </a:StatusIdentity>
    <PwsSaveProjectIssuesResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages    <a:Timestamp>AAAAAA+RGxA=</a:Timestamp>xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  </a:ProjectIssue><ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
                  <a:ReferenceId>#1</a:ReferenceId><Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
               </a:PwsSaveProjectIssueResult><ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-11-12T20:32:01.0306358Z</ServerTimestampUtc>
            </a:ProjectIssueResults><a:ProjectIssueResults/>
         </PwsSaveProjectIssuesResult>
      </PwsSaveProjectIssuesResponse>
   </s:Body>
</s:Envelope>

...

ErrorNumberErrorCodeErrorText
57550UserNotSpecifiedUser is required. (*owner identity is missing)
84001? missingmissing (see issue #36109)
84007WorkspaceProjectIssueNotFoundProject issue not found.
84009ProjectIssueCategoryRefInvalidProjectIssueCategoryRef is required.
84011ProjectIssueCategoryNotFoundProject issue category not found.
84012ProjectIssueStatusRefInvalidProjectIssueStatusRef is required.
84014ProjectIssueStatusNotFoundProject issue status not found.
84015InvalidValueForIssuePriorityInvalid priority value.
84017PriorityRequiredForSaveProjectIssuePriority is required.
84018DescriptionRequiredForSaveProjectIssueDescription is required.
84019SpecifiedIssueDoesNotBelongToSpecifiedProjectProject mismatch.
84057IssueExternalSystemIdentifierAlreadyInUseThe specified project issue external system identifier is already in use. External system identifiers must be globally unique.