Versions Compared

Version Old Version 4 New Version 5
Changes made by

Bettina Borces

Luke Wright

Saved on

Key

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

...

This web service deletes a version (PwsDocumentVersionRef) of a specified document (PwsDocumentRef). Multiple versions of a single document can be stored for project workspace documents, invoice documents, resource resumes and project issue attachments. If you delete the current version of a document, the prior version will become the current version. If a document contains a single version, you will not be able to delete the version. Use PwsDeleteDocument to delete the document instead.

Request Format


Panel
titlePwsDeleteDocumentVersion Request

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes 


Click here for more information.


DocumentIdentity

PwsDocumentRef

Yes 


This is the identity of the document containing the version to be deleted 


DocumentVersionIdentity

PwsDocumentVersionRef

Yes 


This is the identity of the document version to be deleted 


OverrideLockFlag

Boolean

No 

false

If set to 'true', any locks an existing lock on the engagement will be stolen if it is currently locked / checked out, otherwise, if it is set to 'false' and a lock is in place the service will fail document will not prevent the version from being deleted.


Request Usage Example(s)


Code Block
languagexml
titleExample 01
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:doc="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDeleteDocumentVersion>
         <pws:serviceRequest>
            <req:SessionTicket>AW1UpKK1eVCbgfEayQrXEA==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607571571</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:DocumentVersionIdentity>
               <com:DocumentVersionUid>1152921504607572664</com:DocumentVersionUid>
            </doc:DocumentVersionIdentity>
            <doc:OverrideLockFlag>true</doc:OverrideLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteDocumentVersion>
   </soapenv:Body>
</soapenv:Envelope>

...