Archive.QueueArchiveProject Method

Saves a copy of the specified project from the Published to the Archive database. Creates a version of the project.

Namespace:  WebSvcArchive
Assembly:  ProjectServerWebServices (in ProjectServerWebServices.dll)


<SoapDocumentMethodAttribute("", RequestNamespace := "",  _
    ResponseNamespace := "",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function QueueArchiveProject ( _
    jobUID As Guid, _
    projectUID As Guid, _
    archivedProjectUID As Guid, _
    versionDescription As String, _
    retentionPolicy As Integer, _
    permanentArchive As Boolean _
) As Guid
Dim instance As Archive
Dim jobUID As Guid
Dim projectUID As Guid
Dim archivedProjectUID As Guid
Dim versionDescription As String
Dim retentionPolicy As Integer
Dim permanentArchive As Boolean
Dim returnValue As Guid

returnValue = instance.QueueArchiveProject(jobUID, _
    projectUID, archivedProjectUID, _
    versionDescription, retentionPolicy, _
[SoapDocumentMethodAttribute("", RequestNamespace = "", 
    ResponseNamespace = "", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public Guid QueueArchiveProject(
    Guid jobUID,
    Guid projectUID,
    Guid archivedProjectUID,
    string versionDescription,
    int retentionPolicy,
    bool permanentArchive


  • projectUID
    Type: System.Guid
    GUID of the project to archive.
  • archivedProjectUID
    Type: System.Guid
    GUID of the archived project.
  • versionDescription
    Type: System.String
    Description of the project version.
  • retentionPolicy
    Type: System.Int32
    Specifies the retention policy; values can be -2, -1, 0, or greater than 0.
  • permanentArchive
    Type: System.Boolean
    Set true to maintain a permanent copy and avoid accidental deletion.

Return Value

Type: System.Guid
Returns a GUID for the project version.


QueueArchiveProject is an asynchronous method that sends a message to the Project Server Queuing Service.

Following are the values for retention policy.

Value of retentionPolicy


> 0

Set the project retention policy; override the Project Server default retention policy.


Unlimited retention. Archive the project and do not check for retention delete.


Use the project policy if it is set, otherwise use the Project Server default.


Use the Project Server default retention policy and clear the project retention policy.

Save the returned project version GUID to use with QueueRestoreProject.

Project Server Permissions




Schedule or perform a backup of Project Server entities. Global permission.

See Also


Archive Class

Archive Members

WebSvcArchive Namespace