ImportProjects
post
/import/importProjects
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.
Request
Query Parameters
-
DownloadType(required): string
DownloadType is required to download Logfile of Import response, By default BOTH is enabled(Supported values - ATTACHMENT_ONLY,BOTH,RESPONSE_JSON_ONLY)Example:
BOTH
Header Parameters
-
Authorization(required):
OAuth token
Supported Media Types
- multipart/form-data
Root Schema : ProjectsImport
Type:
object
Title:
ProjectsImport
ProjectsImport Entity
Show Source
-
ImportProjects: object
ImportProjects
-
ProjectData: string
(binary)
File to import
Nested Schema : ImportProjects
Type:
Show Source
object
-
BusinessObjectOptions: object
BusinessObjectOptions
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.
-
CurrenciesImportInOption: string
Allowed Values:
[ "BASERATE", "XMLRATE" ]
-
DefaultGlobalImportOption: string
Allowed Values:
[ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]
Import options that may be applied to projects globally. -
DefaultProjectSpecificImportOption: string
Allowed Values:
[ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]
Import options that may be applied to specific projects. -
FileType: string
Allowed Values:
[ "GZIP", "XML", "ZIP" ]
Specifies the file type that the system imports. -
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.
-
ImportProject: array
ImportProject
-
LogLevel: string
Allowed Values:
[ "SEVERE", "WARNING", "INFO", "CONFIG", "FINE", "FINER", "FINEST" ]
Nested Schema : BusinessObjectOptions
Type:
object
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.
Show Source
Nested Schema : ImportProject
Type:
Show Source
array
-
Array of:
object ImportProject
Title:
ImportProject
ImportProject Entity
Nested Schema : GlobalBusinessObjectOptions
Type:
Show Source
object
-
ActivityCode: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ActivityCodeType: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ActivityCodeTypeEPS: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
Calendar: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
CalendarRsrc: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
CostAccount: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
Currency: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ExpenseCategory: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
FinancialPeriod: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
FundingSource: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
NotebookTopic: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
OBS: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectCode: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectCodeType: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectResourceCategory: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
Resource: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ResourceCode: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ResourceCodeType: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ResourceCurve: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ResourceRate: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ResourceRole: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskCategory: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskMatrix: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskMatrixScore: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskMatrixThreshold: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskThreshold: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskThresholdLevel: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
Role: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RoleLimit: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RoleRate: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
Shift: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ThresholdParameter: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
UDFCode: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
UDFType: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
UnitOfMeasure: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
WBSCategory: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity
Nested Schema : ProjectSpecificBusinessObjectOptions
Type:
Show Source
object
-
Activity: object
DeleteUnreferencedType
-
ActivityCode: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ActivityCodeType: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ActivityExpense: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ActivityNote: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ActivityPeriodActual: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ActivityRisk: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ActivityStep: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
Calendar: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ExtRelationship: object
DeleteUnreferencedType
-
ProjectBudgetChangeLog: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectFunding: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectIssue: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectNote: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectResource: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectResourceQuantity: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectSpendingPlan: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
ProjectThreshold: object
DeleteUnreferencedType
-
Relationship: object
DeleteUnreferencedType
-
ResourceAssignment: object
DeleteUnreferencedType
-
ResourceAssignmentPeriodActual: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
Risk: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskImpact: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskResponseAction: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskResponseActionImpact: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
RiskResponsePlan: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
WBS: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity -
WBSMilestone: object
BusinessObjectType
Title:
BusinessObjectType
BusinessObjectType Entity
Nested Schema : BusinessObjectType
Type:
object
Title:
BusinessObjectType
BusinessObjectType Entity
Show Source
-
ImportOption: string
Allowed Values:
[ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]
Nested Schema : DeleteUnreferencedType
Type:
Show Source
object
-
DeleteUnreferenced: boolean
-
ImportOption: string
Allowed Values:
[ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "UPDATE_EXISTING" ]
Nested Schema : ImportProject
Type:
object
Title:
ImportProject
ImportProject Entity
Show Source
-
EPSObjectId: integer
(int32)
If the ImportOption is Update Existing, then specifies the Project ID; if the ImportOption is Create New, then specifies the EPS ID.
-
ImportOption: string
Allowed Values:
[ "CREATE_NEW", "DO_NOT_IMPORT", "KEEP_EXISTING", "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. -
ProjectObjectId: integer
(int32)
Specifies the Project Id to be imported.
Response
Supported Media Types
- multipart/mixed
- application/json
201 Response
OK.
Root Schema : ImportProjectsResponse
Type:
object
Title:
ImportProjectsResponse
ImportProjectsResponse Entity
Show Source
-
ErrorMessage: string
If an exception is thrown, ErrorMessage contains the message part of the exception.
-
LogFile: string
Contains the logging information from the ImportProjects operation.
-
ProjectObjectId: array
ProjectObjectId
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.
-
Success: boolean
Boolean flag that indicates whether the ImportProjects operation was successful.
Nested Schema : ProjectObjectId
Type:
array
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.
Show Source
-
Array of:
integer(int32)
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.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.