ExportProjects Operation

Description: Exports one or more projects to an XML file. When you call the ExportProjects operation, you can specify one to many ProjectObjectID elements.

Service: Export Service

Style: Document/literal wrapped

Input:

Message: ExportProjects

Elements: ExportProject elements that contain the following elements:


 Field


 Type


 Description

Encoding

string

Specifies the encoding of the XML file that is exported, e.g., UTF-8.

FileType


FileTypeType

string
restricted to
GZIP
XML
ZIP

Specifies the file type that the system exports. If GZIP or ZIP is specified as the FileType, the exported XML file is compressed using the respective compression format.

LineSeparator


LineSeparator

string
restricted to
Windows
Unix

Specifies whether the Windows ("\r\n") or Unix ("\n") line endings will be used.

ProjectObjectId

int

The unique identifier project that is to be exported. This operation can contain one to many ProjectObjectID elements. List of int is used for returning Project Object Ids.

SpreadPeriodType

string
restricted to
Hour
Day
Week
Month
Quarter
Year
FinancialPeriod

Specifies the spread interval for the Activity. Specifying the SpreadPeriodType displays Future Bucket Planning data in the export file. It should only be specified if needed, as there are both performance and size implications of using this parameter.

Spacing

string

Specifies the indentation between the elements in the XML export file. For example, use " " to specify 5 spaces of indentation.

BusinessObjectOptions

BusinessObjectOptions Element

Specifies which business objects to export according to the following rules:

If no BusinessObjectOptions are specified, then all of the business objects in the project are exported. If any BusinessObjectOptions are specified, then only those business objects specified by the BusinessObjectOptions element are exported.


Output:

Message: ExportProjectsResponse

Elements:

The XML file containing the exported project data.


 Field


 Type


 Description

ProjectData

base64Binary

The XML file containing the exported project data.



Legal Notices | Your Privacy Rights
Copyright © 2008, 2023

Last Published Wednesday, February 1, 2023