ImportProjects Operation

Description: Imports one or more new projects from an XML file. Each new project is created under the EPS specified by the EPSObjectId. When you call the ImportProjects operation, you specify one or more ImportProject elements. Each of these elements contain information about the project you are importing.

Service: Import Service

Style: Document/literal wrapped

Input:

Message: ImportProjects

Elements: ImportProjects elements that contain the following elements:

Field	Type	Description
CurrenciesImporInOption	string restricted to baserate xmlrate	Specifies whether to use the currency exchange rate in the database or the currency exchange rate in the xml for import. Selecting the baserate option, will cause costs in the xml file to be converted using the currency exchange rates to ensure that the costs imported are the same as those which were exported. Selecting the xml option will not convert currencies so the costs imported may differ from those which were exported.
ImportProject	ImportProject. See ImportProject Type table below.
ProjectData	base64Binary	This element contains a reference to the data that is outside the SOAP message in compliance with MTOM specification.
FileType	FileType string restricted to GZIP XML ZIP	Specifies the file type that the system imports.
BusinessObjectOptions	BusinessObjectOptions Global ActivityCode ActivityCodeType ActivityCodeTypeEPS Calendar CalendarRsrc CostAccount Currency ExpenseCategory FinancialPeriod FundingSource NotebookTopic OBS ProjectCode ProjectCodeType ProjectResourceCategory Resource ResourceCode ResourceCodeType ResourceCurve ResourceRate ResourceRole RiskCategory RiskMatrixScore RiskMatrixThreshold RiskMatrix RiskThreshold RiskThresholdLevel Role RoleRate RoleLimit Shift ThresholdParameter UDFCode UDFType UnitOfMeasure WBSCategory ProjectSpecific Activity ActivityCode ActivityCodeType ActivityExpense ActivityNote ActivityPeriodActual ActivityRisk ActivityStep Calendar ExtRelationship ProjectBudgetChangeLog ProjectFunding ProjectIssue ProjectNote ProjectResource ProjectResourceQuantity ProjectSpendingPlan ProjectThreshold Relationship ResourceAssignment ResourceAssignmentPeriodActual Risk RiskImpact RiskResponseAction RiskResponseActionImpact RiskResponsePlan WBS WBSMilestone	Specifies which business objects to import according to the following rules: If no BusinessObjectOptions are specified, then all of the business objects in the project are imported. If any BusinessObjectOptions are specified, then only those business objects specified by the BusinessObjectOptions element are imported.
IgnoreGUID	boolean	When this flag is set to true, the XMLImporter ignores all GUID fields in the XML file, and allows new GUID values to be generated. When this flag is set to false, the XMLImporter uses the GUID fields.
IgnoreSequenceNumber	boolean	When this flag is set to true, the XMLImporter ignores all SequenceNumber fields in the XML file, and allows new SequenceNumber values to be generated. When this flag is set to false, XMLImporter uses the SequenceNumber fields.
LogLevel	LogLevel string restricted to SEVERE WARNING INFO CONFIG FINE FINER FINEST
DefaultGlobalImportOption	ImportOption string restricted to Create New Do Not Import Keep Existing Update Existing	Import options that may be applied to projects globally.
DefaultProjectSpecificImportOption	ImportOption string restricted to Create New Do Not Import Keep Existing Update Existing	Import options that may be applied to specific projects.

ImportProject Type Table

Field	Type	Description
ProjectObjectId	int	Specifies the Project Id to be imported.
ImportOption	ImportOption string restricted to Create New Update Existing	Specify Create New to import a project that already exists as a new project; specify Update Existing to import a project to update an existing project.
ESPObjectId	int	If the ImportOption is Update Existing, then specifies the Project ID; if the ImportOption is Create New, then specifies the EPS ID.

Field

Type

Description

ProjectObjectId

int

Specifies the Project Id to be imported.

ImportOption

ImportOption
string
restricted to

Create New
Update Existing

Specify Create New to import a project that already exists as a new project; specify Update Existing to import a project to update an existing project.

ESPObjectId

int

If the ImportOption is Update Existing, then specifies the Project ID; if the ImportOption is Create New, then specifies the EPS ID.

Output:

Message: ImportProjectsResponse

Elements:

Field	Type	Description
LogFile	base64Binary	Contains the logging information from the ImportProjects operation.
ErrorMessage	string	If an exception is thrown, ErrorMessage contains the message part of the exception.
Success	boolean	Boolean flag that indicates whether the ImportProjects operation was successful.
ProjectObjectId	int	The unique identifier of the project that was created or updated by the ImportProjects operation. If multiple objects are created, a list of project object IDs is returned.

Last Published Wednesday, February 1, 2023