Jump to

• Request
• Response

Export a P6 XML

post

/api/restapi/action/exportP6xml

Send a request to this endpoint to trigger a job to export data in P6 XML format. Send a request to the View Job Status endpoint to monitor the job status. Once the job has completed, the corresponding P6 XML file can be downloaded using the Download P6 XML/XER endpoint.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityExportP6XML

Type: object

Title: ApiEntityExportP6XML

Show Source

• exportCompressedFile: boolean
  The option to download XML/XER or compressed file with XML/XER. Default value is false.
• projectsInfo(required): array projectsInfo
  The projects to be exported in form of P6 XML/XER for a given workspace.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityExportP6XML",
    "required":[
        "projectsInfo",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectsInfo":{
            "type":"array",
            "description":"The projects to be exported in form of P6 XML/XER for a given workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityExportProjectInfo",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "exportCompressedFile":{
            "type":"boolean",
            "description":"The option to download XML/XER or compressed file with XML/XER. Default value is false.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : projectsInfo

Type: array

The projects to be exported in form of P6 XML/XER for a given workspace.

Show Source

• Array of: object ApiEntityExportProjectInfo
  Title: ApiEntityExportProjectInfo

{
    "type":"array",
    "description":"The projects to be exported in form of P6 XML/XER for a given workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityExportProjectInfo",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityExportProjectInfo

Type: object

Title: ApiEntityExportProjectInfo

Show Source

• baselineProjectInfo: array baselineProjectInfo
  The baselines information of the project exported in P6 XML format.
• isExportScenarioBaselineOnly: boolean
  Flag to enable export only baselines and scenarios as a project. Default value is 'false'.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.
• projectName: string
  Maximum Length: 255

  The exported file name of the XML/XER file. It should be valid file name.
• scenarioProjectInfo: array scenarioProjectInfo
  The scenarios information of the project exported in P6 XML format.

{
    "title":"ApiEntityExportProjectInfo",
    "required":[
        "projectId"
    ],
    "type":"object",
    "properties":{
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The exported file name of the XML/XER file. It should be valid file name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineProjectInfo":{
            "type":"array",
            "description":"The baselines information of the project exported in P6 XML format.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityExportBaselineInfo",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scenarioProjectInfo":{
            "type":"array",
            "description":"The scenarios information of the project exported in P6 XML format.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityExportScenarioInfo",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "isExportScenarioBaselineOnly":{
            "type":"boolean",
            "description":"Flag to enable export only baselines and scenarios as a project. Default value is 'false'.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : baselineProjectInfo

Type: array

The baselines information of the project exported in P6 XML format.

Show Source

• Array of: object ApiEntityExportBaselineInfo
  Title: ApiEntityExportBaselineInfo

{
    "type":"array",
    "description":"The baselines information of the project exported in P6 XML format.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityExportBaselineInfo",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : scenarioProjectInfo

Type: array

The scenarios information of the project exported in P6 XML format.

Show Source

• Array of: object ApiEntityExportScenarioInfo
  Title: ApiEntityExportScenarioInfo

{
    "type":"array",
    "description":"The scenarios information of the project exported in P6 XML format.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityExportScenarioInfo",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityExportBaselineInfo

Type: object

Title: ApiEntityExportBaselineInfo

Show Source

• projectBaselineId: integer (int64)
  The system-generated unique identifier of a project baseline.
• projectBaselineName: string
  Maximum Length: 255

  The name of a project baseline.

{
    "title":"ApiEntityExportBaselineInfo",
    "type":"object",
    "properties":{
        "projectBaselineId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a project baseline.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectBaselineName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of a project baseline.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityExportScenarioInfo

Type: object

Title: ApiEntityExportScenarioInfo

Show Source

• scenarioId: integer (int64)
  The system-generated unique identifier of a scenario.
• scenarioName: string
  Maximum Length: 255

  The name of a scenario.

{
    "title":"ApiEntityExportScenarioInfo",
    "type":"object",
    "properties":{
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Export a P6 XML File

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityJobDetail

Type: object

Title: ApiEntityJobDetail

Show Source

• 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.

{
    "title":"ApiEntityJobDetail",
    "type":"object",
    "properties":{
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobType":{
            "type":"string",
            "description":"The type of a job.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "jobLog":{
            "maxLength":"4000",
            "type":"string",
            "description":"Log of the job.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastStartDate":{
            "type":"string",
            "description":"The date and time the last job was executed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastCompletionDate":{
            "type":"string",
            "description":"The date the background service was last performed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Action service.

Back to Top