Jump to

• Request
• Response

Export Project Cashflows Using Project Details

post

/api/restapi/projectCashflows/export

Send a request to this endpoint to trigger a job to export project cashflows in a compressed ZIP file containing a CSV file. Send a request to the View Job Status endpoint to monitor the job status. After the job has completed, the ZIP file can be downloaded using the Download Project Cashflows endpoint.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityCashflowExportProjectInput

Type: object

Title: ApiEntityCashflowExportProjectInput

Show Source

• costCurves: array costCurves
  List of cost curves to be exported. If omitted or empty, all curves will be exported.
• endDate: string (date-time)
  Finish date of the curve. If no value is provided, a maximum of 20 years from the start date is considered as the end date.
• projectsInfo(required): array projectsInfo
  List of projects for which to export cashflows in a compressed ZIP file containing a CSV file.
• startDate(required): string (date-time)
  Start date of the curve.

{
    "title":"ApiEntityCashflowExportProjectInput",
    "required":[
        "projectsInfo",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "projectsInfo":{
            "type":"array",
            "description":"List of projects for which to export cashflows in a compressed ZIP file containing a CSV file.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCashflowExportProjectIdentifierInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "costCurves":{
            "type":"array",
            "description":"List of cost curves to be exported. If omitted or empty, all curves will be exported.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ],
                "enum":[
                    "ACTUALS",
                    "BENEFITS",
                    "FORECAST",
                    "PLANNED_BUDGET",
                    "PORTFOLIO_APPROVED_BUDGET",
                    "PORTFOLIO_PROPOSED_BUDGET"
                ]
            },
            "types":[
                "array"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"Finish date of the curve. If no value is provided, a maximum of 20 years from the start date is considered as the end date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"Start date of the curve.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurves

Type: array

List of cost curves to be exported. If omitted or empty, all curves will be exported.

Show Source

• Array of: string
  Allowed Values: [ "ACTUALS", "BENEFITS", "FORECAST", "PLANNED_BUDGET", "PORTFOLIO_APPROVED_BUDGET", "PORTFOLIO_PROPOSED_BUDGET" ]

{
    "type":"array",
    "description":"List of cost curves to be exported. If omitted or empty, all curves will be exported.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ],
        "enum":[
            "ACTUALS",
            "BENEFITS",
            "FORECAST",
            "PLANNED_BUDGET",
            "PORTFOLIO_APPROVED_BUDGET",
            "PORTFOLIO_PROPOSED_BUDGET"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectsInfo

Type: array

List of projects for which to export cashflows in a compressed ZIP file containing a CSV file.

Show Source

• Array of: object ApiEntityCashflowExportProjectIdentifierInput
  Title: ApiEntityCashflowExportProjectIdentifierInput

  This entity represents a CashflowExportProjectIdentifier object, a unique CashflowExportProjectIdentifier object can be identified by the following combinations of the fields.

  • projectId
  • projectCode,workspaceCode

{
    "type":"array",
    "description":"List of projects for which to export cashflows in a compressed ZIP file containing a CSV file.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCashflowExportProjectIdentifierInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCashflowExportProjectIdentifierInput

Type: object

Title: ApiEntityCashflowExportProjectIdentifierInput

This entity represents a CashflowExportProjectIdentifier object, a unique CashflowExportProjectIdentifier object can be identified by the following combinations of the fields.

• projectId
• projectCode,workspaceCode

Show Source

• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of the project's workspace.

{
    "title":"ApiEntityCashflowExportProjectIdentifierInput",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of the project's workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CashflowExportProjectIdentifier object, a unique CashflowExportProjectIdentifier object can be identified by the following combinations of the fields.<ul><li>projectId</li><li>projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Back to Top

Response

Supported Media Types

• application/json

201 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", "IMPORT_SCHEDULE_RECALCULATION", "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", "RISK_IMPACT_RECALCULATION", "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", "WBS_DELETE_WITH_ACTIVITIES_TASKS", "PROJECT_ACTIVITY_EXCEL_IMPORT", "RESOURCE_SCENARIO_COST_REFRESH", "PROJECT_DEMAND_COST_REFRESH", "PROJECT_CASHFLOW_RESOURCE_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_HARD_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", "P6_IMPORT_MIGRATION_RECALCULATE_FUNCTION_JOB", "SCENARIO_LINK_ALL_SEGMENT", "EXTRACT_CASHFLOW_DATA" ]

  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":{
        "lastCompletionDate":{
            "type":"string",
            "description":"The date the background service was last performed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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",
                "IMPORT_SCHEDULE_RECALCULATION",
                "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",
                "RISK_IMPACT_RECALCULATION",
                "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",
                "WBS_DELETE_WITH_ACTIVITIES_TASKS",
                "PROJECT_ACTIVITY_EXCEL_IMPORT",
                "RESOURCE_SCENARIO_COST_REFRESH",
                "PROJECT_DEMAND_COST_REFRESH",
                "PROJECT_CASHFLOW_RESOURCE_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_HARD_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",
                "P6_IMPORT_MIGRATION_RECALCULATE_FUNCTION_JOB",
                "SCENARIO_LINK_ALL_SEGMENT",
                "EXTRACT_CASHFLOW_DATA"
            ]
        },
        "jobLog":{
            "maxLength":4000,
            "type":"string",
            "description":"Log of the job.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "lastStartDate":{
            "type":"string",
            "description":"The date and time the last job was executed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Project service.

Back to Top