Import a P6 XER file
post
/api/restapi/action/importP6xer
Send a request to this endpoint to create a job to import a well-formed P6 XER file. Send a request to the View Job Status endpoint to monitor the job status.Baseline import support is not available for XER.
Request
Query Parameters
-
prefLang: string
Preferred language by the user.
Supported Media Types
- multipart/form-data
Root Schema : schema
Type:
Show Source
object
-
data(required):
data
Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XER file.
-
file(required): object
file
The compressed xer file to be imported.
Nested Schema : data
Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XER file.
Match All
Show Source
-
object
ApiEntityImportP6XER
Title:
ApiEntityImportP6XER
Nested Schema : file
Type:
object
The compressed xer file to be imported.
Nested Schema : ApiEntityImportP6XER
Type:
object
Title:
Show Source
ApiEntityImportP6XER
-
importClobberConfig:
importClobberConfig
Project & Workspace Level Objects' clobber configuration.
-
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
projectsInfo(required): array
projectsInfo
The import option and baseline information for each project in the xml or xer file.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
workspaceCode: string
Maximum Length:
60
User provided identifier of workspace for importing xml or xer file. -
workspaceId(required): integer
(int64)
System generated identifier of workspace for importing xml or xer file.
Nested Schema : importClobberConfig
Project & Workspace Level Objects' clobber configuration.
Match All
Show Source
-
object
ApiEntityImportClobberConfig
Title:
ApiEntityImportClobberConfig
Nested Schema : projectsInfo
Type:
array
The import option and baseline information for each project in the xml or xer file.
Show Source
-
Array of:
object ApiEntityXerProjectInfo
Title:
ApiEntityXerProjectInfo
Nested Schema : ApiEntityImportClobberConfig
Type:
object
Title:
Show Source
ApiEntityImportClobberConfig
-
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
projectClobberOptions: array
projectClobberOptions
The options for taking action on project level items in the XML.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
workspaceClobberOptions: array
workspaceClobberOptions
The options for taking action on workspace level items in the XML.
Nested Schema : projectClobberOptions
Type:
array
The options for taking action on project level items in the XML.
Show Source
-
Array of:
object ApiEntityProjectClobberConfig
Title:
ApiEntityProjectClobberConfig
Nested Schema : workspaceClobberOptions
Type:
array
The options for taking action on workspace level items in the XML.
Show Source
-
Array of:
object ApiEntityWorkspaceClobberConfig
Title:
ApiEntityWorkspaceClobberConfig
Nested Schema : ApiEntityProjectClobberConfig
Type:
object
Title:
Show Source
ApiEntityProjectClobberConfig
-
importOption(required): string
Allowed Values:
[ "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ]
The import action indicates how to handle the entities from the import file that already exist in the application. -
isDeleteUnref: boolean
Enables you to remove the corresponding entity from OPC if it is not part of XML or XER file being imported.
-
item(required): string
Allowed Values:
[ "CALENDAR", "ACTIVITY", "ACTIVITYCODE", "RELATIONSHIP", "RESOURCE", "ROLE", "WBS", "RISK" ]
The project level entity which will be added to the application during import. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
promoteOption: stringAllowed Values:[ "INSERT_NEW", "IGNORE", "FAIL_AND_ABORT", "NOT_APPLICABLE" ]
Deprecated. As of 23.6.Promote setting for multiple matching shared data items which are found in lower-level child workspace. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : ApiEntityWorkspaceClobberConfig
Type:
object
Title:
Show Source
ApiEntityWorkspaceClobberConfig
-
importOption(required): string
Allowed Values:
[ "CREATE_NEW", "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ]
The import action indicates how to handle the entities from the import file that already exist in the application. -
isDeleteUnref: boolean
Enables you to remove the corresponding entity from OPC if it is not part of XML or XER file being imported.
-
item(required): string
Allowed Values:
[ "CALENDAR", "CURVE", "RESOURCE", "ROLE", "UNITSOFMEASURE", "ACTIVITYUDF", "ASSIGNMENTUDF", "PROJECTUDF", "WBSUDF", "RISKUDF", "ACTIVITYCODE", "PROJECTCODE", "RESOURCECODE" ]
The workspace level entity which will be added to the application during import. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
promoteOption(required): string
Allowed Values:
[ "INSERT_NEW", "IGNORE", "FAIL_AND_ABORT", "NOT_APPLICABLE" ]
Promote setting for multiple matching shared data items which are found in lower-level child workspace. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : ApiEntityXerProjectInfo
Type:
object
Title:
Show Source
ApiEntityXerProjectInfo
-
baselineProjectInfo: array
baselineProjectInfo
The baselines data of specific project. It is not available for XER.
-
importOption: string
Maximum Length:
255
Default Value:UPDATE_EXISTING
The import action to be taken for each project in the XML or XER. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
projectCode(required): string
Maximum Length:
60
The user provided identifier of the project being imported through XML or XER. -
projectId: integer
(int64)
The system generated identifier of the project being imported through XML or XER.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : baselineProjectInfo
Type:
array
The baselines data of specific project. It is not available for XER.
Show Source
-
Array of:
object ApiEntityXerBaselineProjectInfo
Title:
ApiEntityXerBaselineProjectInfo
Nested Schema : ApiEntityXerBaselineProjectInfo
Type:
object
Title:
Show Source
ApiEntityXerBaselineProjectInfo
-
id: integer
(int64)
The system generated identifier of a baseline or scenario within a project.
-
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
name: string
Maximum Length:
255
The name of the baseline or scenario of a project. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityJobDetail
Type:
object
Title:
Show Source
ApiEntityJobDetail
-
jobId: integer
(int64)
The unique identifier for the background service.
-
jobLog: string
Maximum Length:
4000
Log of the job. -
jobStatus: string
Allowed Values:
[ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]
The status of the background service. -
jobType: string
Allowed Values:
[ "MONTHLY", "DAILY", "FLEX_COLUMN_DELETE", "SCHEDULE_MONTE_CARLO", "SCHEDULE_MONTE_CARLO_LARGE", "SCHEDULE_MONTE_CARLO_EXPRESS", "SCHEDULE_MONTE_CARLO_ULTRALARGE", "GATEWAY_SYNC_JOB", "USER_DEFINED_REPORT", "LEVEL", "SCHEDULE_SCHEDULER", "APPLY_ACT_UNCERTAINTY", "RECALCULATE_SCHEDULE_COST", "STORE_PERIOD_PERFORMANCE", "SETUP_STORE_PERIOD_PERFORMANCE", "CALCULATE_PROJECT_SPREADS", "CALCULATE_ASSIGNMENT_SPREADS", "CALCULATE_ACTIVITY_SPREADS", "REPLACE_RESOURCES", "RUN_GLOBAL_CHANGE", "WORK_RATE_SYNC_TENANT", "WORK_RATE_SYNC_WORKSPACE", "RECALCULATE_COST", "RECALCULATE_PROJECTS_COST", "RECALCULATE_WORKSPACE_COST", "RECALCULATE_PROGRAM_COST", "CALCULATE_PROG_PROJ_COST_CURVE", "CREATE_SCENARIO", "IMPORT_FROM_P6", "P6_IMPORT_MIGRATION_JOB", "IMPORT_XER_FROM_P6", "IMPORT_FROM_P6_API", "IMPORT_XER_FROM_P6_API", "EXPORT_TO_P6", "EXPORT_XER_TO_P6", "EXPORT_TO_MSP", "GATEWAY_SYNC_MASTER_DATA", "MEASURES_BY_PORTFOLIO_CALC", "MEASURE_BY_PERIOD_CALC", "MEASURES_BY_STRATEGY_CALC", "MEASURES_BY_PROJECT_CALC", "PROJECT_MEASURES_BY_WORKSPACE_CALC", "PROJECT_MEASURES_BY_PORTFOLIO_CALC", "PROGRAM_MEASURES_BY_WORKSPACE_CALC", "PROGRAM_MEASURES_BY_PORTFOLIO_CALC", "PROJECT_ACTUALS_EXCEL_IMPORT", "SCOPE_ASSIGNMENT_EXCEL_IMPORT", "FUND_EXCEL_IMPORT", "PORTFOLIO_FUND_EXCEL_IMPORT", "WORKSPACE_ROLE_EXCEL_IMPORT", "TASKS_EXCEL_IMPORT", "ASSIGN_RISK_MATRIX_TO_PROJECT", "RISKS_EXCEL_IMPORT", "PROG_RISKS_EXCEL_IMPORT", "SYNC_ACTIVITY_BASED_RISK_DATA", "BUDGET_EXCEL_IMPORT", "PROG_BUDGET_EXCEL_IMPORT", "PROJECT_DELETE", "PORTFOLIO_AUTO_REFRESH", "RESOURCE_SCENARIO_APPROVAL", "RESOURCE_SCENARIO_DELETE", "RESOURCE_SCENARIO_PROPOSE", "WBS_EXCEL_IMPORT", "PROJECT_ACTIVITY_EXCEL_IMPORT", "RESOURCE_SCENARIO_COST_REFRESH", "PROJECT_DEMAND_COST_REFRESH", "PROJECT_DEMAND_ASSIGNMENT_FETCH", "SUBMITTAL_EXCEL_IMPORT", "WORKSPACE_RESOURCE_EXCEL_IMPORT", "PROJECT_RESOURCE_EXCEL_IMPORT", "PROJECT_ROLE_EXCEL_IMPORT", "SUBJECT_AREA_REFRESH", "RECOMPUTE_STRATEGIC_ALIGN_SCORE", "PROJECT_SCHEDULE_HEALTH_UPGRADE", "RECALCULATE_SCHEDULE_HEALTH", "BUDGET_SCENARIO_APPROVAL", "COPY_WORKSPACE", "SET_ACTIVITY_SCENARIO", "MERGE_ACTIVITIES", "ACTIVITY_RESOURCE_SYNC", "PROJECT_EXCEL_IMPORT", "SCENARIO_EXCEL_IMPORT", "BUDGET_SCENARIO_OPTIMIZATION", "RESOURCE_SCENARIO_OPTIMIZATION", "USER_MIGRATION_EXPORT", "USER_MIGRATION_IMPORT", "GLOBAL_AUTH_MIGRATION_EXPORT", "GLOBAL_AUTH_MIGRATION_IMPORT", "CONFIG_MIGRATION_EXPORT", "CONFIG_MIGRATION_IMPORT", "RECALCULATE_TASK_SUMMARY_CHECK", "PROJECT_YEARLY_COSTS_EXCEL_IMPORT", "PROJECT_QUARTERLY_COSTS_EXCEL_IMPORT", "PROJECT_MONTHLY_COSTS_EXCEL_IMPORT", "PROGRAM_YEARLY_COSTS_EXCEL_IMPORT", "PROGRAM_QUARTERLY_COSTS_EXCEL_IMPORT", "PROGRAM_MONTHLY_COSTS_EXCEL_IMPORT", "RECALCULATE_FUNCTION", "RECALCULATE_FUNCTION_SEGMENT", "RECALCULATE_FUNCTION_SEGMENT_OVERLAY", "RECALCULATE_FUNCTIONS_FOR_SCHEDULER", "RECALCULATE_FUNCTIONS_FOR_EXCEL_IMPORT", "MIGRATE_TENANT_TO_LOBBY", "RENUMBER_ACTIVITY", "PC_MIGRATION", "COMPANY_MIGRATION_EXPORT", "COMPANY_MIGRATION_IMPORT", "CUSTOM_LOG_EXCEL_IMPORT", "PORTFOLIO_PRIORITIZATION_MATRIX_EXCEL_IMPORT", "WEATHER_MONTE_CARLO", "PROGRAM_DELETE", "PROGRAM_PROJECT_FILTER", "PROGRAM_EXCEL_IMPORT", "PROJECT_MOVE", "PROGRAM_SECURITY_SYNC", "IDEA_SECURITY_SYNC", "IDEA_SECURITY_MIGRATION", "IDEA_USERLINK_MIGRATION", "WORKSPACE_DELETE", "WORKSPACE_MOVE", "CASHFLOW_MIGRATION", "CBS_SYNC", "EVALUATION_REFRESH", "SCHEDULE_COMPARISON_EXPORT", "PROJECT_MOVE_RECALCULATE_FUNCTION", "PROJECT_MOVE_RECALCULATE_FUNCTION_SEGMENT", "PROJECT_MOVE_RECALCULATE_FUNCTION_SEGMENT_OVERLAY", "WORKSPACE_EXCHANGE_RATE_REFRESH", "TASK_COPY_PASTE_WITH_HANDOFF", "EXPORT_SPREAD_TO_EXCEL", "SCENARIO_LINK_ALL" ]
The type of a job. -
lastCompletionDate: string
(date-time)
The date the background service was last performed.
-
lastStartDate: string
(date-time)
The date and time the last job was executed.
400 Response
Invalid input for the Action service.