Batch Update Budget Planning Scenarios
put
/api/restapi/budgetPlanningScenario/batch
Send a request to this endpoint to update one or more budget planning scenarios. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityBudgetPlanningScenarioInput>
Type:
array
Title:
Show Source
List<ApiEntityBudgetPlanningScenarioInput>
-
Array of:
object ApiEntityBudgetPlanningScenarioInput
Title:
ApiEntityBudgetPlanningScenarioInput
Nested Schema : ApiEntityBudgetPlanningScenarioInput
Type:
object
Title:
Show Source
ApiEntityBudgetPlanningScenarioInput
- hidden: boolean
-
planPeriod(required): integer
(int32)
The period during which budget is allocated to projects within the plan.
This value determines the year in which budget planning timescales start.
You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
After the planning period for a budget plan has been set it cannot be changed. -
planProjects: array
planProjects
The plan projects associated with a scenario.
-
portfolioId(required): integer
(int64)
The system-generated identifier of the Capital Portfolio.
-
portfolioName: string
Maximum Length:
255
The name of the portfolio. -
scenarioDescription: string
Maximum Length:
4000
The detailed summary for the plan.
The description provides more information than short names or titles.
It can give background information or establish a purpose for the item.
These details help differentiate between items with similar names and are especially useful in multi-user environments. -
scenarioId: integer
(int64)
The system-generated identifier of the Budget Plan Scenario.
-
scenarioName(required): string
Maximum Length:
255
The name of Budget Plan Scenario. -
scenarioStatus: string
Allowed Values:
[ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ]
The status of Budget Plan Scenario. -
targetBudgetCOR: number
(double)
The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager. This is an input field, will not be a part of response.
-
targetBudgetPeriods: array
targetBudgetPeriods
The phase costs of target budget.
-
targetSubCurveDetails: array
targetSubCurveDetails
The target capital and expense cost details of a scenario.
-
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace.
Nested Schema : planProjects
Type:
array
The plan projects associated with a scenario.
Show Source
-
Array of:
object ApiEntityBudgetPlanProjectInput
Title:
ApiEntityBudgetPlanProjectInput
Nested Schema : targetBudgetPeriods
Type:
array
The phase costs of target budget.
Show Source
-
Array of:
object ApiEntityScenarioPhaseFinancialInput
Title:
ApiEntityScenarioPhaseFinancialInput
Nested Schema : targetSubCurveDetails
Type:
array
The target capital and expense cost details of a scenario.
Show Source
-
Array of:
object ApiEntitySubCostCurveInput
Title:
ApiEntitySubCostCurveInput
Nested Schema : ApiEntityBudgetPlanProjectInput
Type:
object
Title:
Show Source
ApiEntityBudgetPlanProjectInput
-
finishDate: string
(date-time)
The finish date of a plan project.
-
linked: boolean
The flag to link or unlink a project in a scenario.
-
planProjectPeriods: array
planProjectPeriods
The period budgets associated with a plan project.
-
planProjectSubCurveDetails: array
planProjectSubCurveDetails
The capital and expense cost details of a plan project.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier of a project.
-
projectName: string
Maximum Length:
255
The name of a plan project associated with a scenario. -
startDate: string
(date-time)
The start date of a plan project.
-
state: string
Allowed Values:
[ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ]
The state of capital plan project. -
totalCOR: number
(double)
The total amount of budget for the project. This is an input field, will not be a part of response.
-
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace.
Nested Schema : planProjectPeriods
Type:
array
The period budgets associated with a plan project.
Show Source
-
Array of:
object ApiEntityScenarioPhaseFinancialInput
Title:
ApiEntityScenarioPhaseFinancialInput
Nested Schema : planProjectSubCurveDetails
Type:
array
The capital and expense cost details of a plan project.
Show Source
-
Array of:
object ApiEntitySubCostCurveInput
Title:
ApiEntitySubCostCurveInput
Nested Schema : ApiEntityScenarioPhaseFinancialInput
Type:
object
Title:
Show Source
ApiEntityScenarioPhaseFinancialInput
-
month: integer
(int32)
The month of phase period of a target or proposed budget.
-
phaseCostCOR: number
(double)
The amount of a target or proposed budget for a particular period. This is an input field, will not be a part of response.
-
year: integer
(int32)
The year of phase period of a target or proposed budget.
Nested Schema : ApiEntitySubCostCurveInput
Type:
object
Title:
Show Source
ApiEntitySubCostCurveInput
-
costCurvePeriods: array
costCurvePeriods
The phase wise costs of cost curve.
-
costSubCurveType: string
Allowed Values:
[ "CAPITAL", "EXPENSE" ]
The type of the cost curve. -
totalCOR: number
(double)
The total cost of the cost curve.
Nested Schema : costCurvePeriods
Type:
array
The phase wise costs of cost curve.
Show Source
-
Array of:
object ApiEntityScenarioPhaseFinancialInput
Title:
ApiEntityScenarioPhaseFinancialInput
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}
400 Response
Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request.