Share via


GrooveSpaces.ExportAsArchive Operation

The ExportAsArchive operation exports the targeted workspace as a .gsa file on the local file system.

HTTP Post URL

The HTTP Post URL targets the service for the workspace. This URI is provided by the Read operation in the URI element.

Input Message Header

GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.

Input Message Parameters

<FileURI />
<IncludeMembers />
<IncludeData />
<Passphrase />
<ReadOnly />
Element Data type Description

FileURI

xs:anyURI

Specifies a file on the file system that will contain the workspace archive, for example, "C:\temp\newspace.gsa".

IncludeMembers

xs:boolean

If true, the current members of the workspace will be members of a workspace created from the archive.

IncludeData

xs:boolean

If true, data in all the workspace tools will be preserved in the archive. Note that if the workspace contains one or more Forms tools, the Forms design data is always preserved even if IncludeData is false. If false, data in all workspace tools, which include Forms tool data records, will not be preserved.

Passphrase

xs:string

Specifies a passphrase to be used to encrypt the archive. If the passphrase is an empty string, then the archive will not be encrypted.

Readonly

xs:boolean

If true, the archive file will be created as a read-only file.

Output Message Header

GrooveResponseHeader specifies the Response key.

Return Value

None.

See Also

Reference

GrooveSpaces Web Service
GrooveSpaces.CreateFromGSA Operation
GrooveSpaces.CreateFromGSAByRef Operation