Jump to

• Request
• Response

Update a Budget Planning Scenario

put

/api/restapi/budgetPlanningScenario

Send a request to this endpoint to update a budget planning scenario. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityBudgetPlanningScenarioInput

Type: object

Title: ApiEntityBudgetPlanningScenarioInput

Show Source

• hidden: boolean
  Enables you to decide whether or not a scenario is hidden from other users.
• 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.

{
    "title":"ApiEntityBudgetPlanningScenarioInput",
    "required":[
        "planPeriod",
        "portfolioId",
        "scenarioName"
    ],
    "type":"object",
    "properties":{
        "targetBudgetCOR":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "planProjects":{
            "type":"array",
            "description":"The plan projects associated with a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetPlanProjectInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "targetBudgetPeriods":{
            "type":"array",
            "description":"The phase costs of target budget.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "targetSubCurveDetails":{
            "type":"array",
            "description":"The target capital and expense cost details of a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySubCostCurveInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Budget Plan Scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planPeriod":{
            "type":"integer",
            "description":"The period during which budget is allocated to projects within the plan. <br />This value determines the year in which budget planning timescales start. <br />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. <br />After the planning period for a budget plan has been set it cannot be changed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Capital Portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "hidden":{
            "type":"boolean",
            "description":"Enables you to decide whether or not a scenario is hidden from other users.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "scenarioStatus":{
            "type":"string",
            "description":"The status of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "APPROVED",
                "UNDER_REVIEW",
                "IN_PLANNING",
                "UNDER_APPROVAL",
                "RETIRED",
                "SHARED",
                "PENDING_APPROVAL",
                "PENDING_SHARED",
                "PENDING_IN_PLANNING"
            ]
        },
        "scenarioDescription":{
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed summary for the plan. <br />The description provides more information than short names or titles. <br />It can give background information or establish a purpose for the item. <br />These details help differentiate between items with similar names and are especially useful in multi-user environments.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : planProjects

Type: array

The plan projects associated with a scenario.

Show Source

• Array of: object ApiEntityBudgetPlanProjectInput
  Title: ApiEntityBudgetPlanProjectInput

{
    "type":"array",
    "description":"The plan projects associated with a scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetPlanProjectInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : targetBudgetPeriods

Type: array

The phase costs of target budget.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancialInput
  Title: ApiEntityScenarioPhaseFinancialInput

{
    "type":"array",
    "description":"The phase costs of target budget.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : targetSubCurveDetails

Type: array

The target capital and expense cost details of a scenario.

Show Source

• Array of: object ApiEntitySubCostCurveInput
  Title: ApiEntitySubCostCurveInput

{
    "type":"array",
    "description":"The target capital and expense cost details of a scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySubCostCurveInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetPlanProjectInput

Type: object

Title: ApiEntityBudgetPlanProjectInput

Show Source

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

{
    "title":"ApiEntityBudgetPlanProjectInput",
    "type":"object",
    "properties":{
        "totalCOR":{
            "type":"number",
            "description":"The total amount of budget for the project. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "startDate":{
            "type":"string",
            "description":"The start date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The finish date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planProjectPeriods":{
            "type":"array",
            "description":"The period budgets associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "planProjectSubCurveDetails":{
            "type":"array",
            "description":"The capital and expense cost details of a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntitySubCostCurveInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "state":{
            "type":"string",
            "description":"The state of capital plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SELECTED",
                "UNSELECTED",
                "FORCED_IN",
                "FORCED_OUT"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of  a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a 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"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "linked":{
            "type":"boolean",
            "description":"The flag to link or unlink a project in a scenario.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : planProjectPeriods

Type: array

The period budgets associated with a plan project.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancialInput
  Title: ApiEntityScenarioPhaseFinancialInput

{
    "type":"array",
    "description":"The period budgets associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : planProjectSubCurveDetails

Type: array

The capital and expense cost details of a plan project.

Show Source

• Array of: object ApiEntitySubCostCurveInput
  Title: ApiEntitySubCostCurveInput

{
    "type":"array",
    "description":"The capital and expense cost details of a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySubCostCurveInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityScenarioPhaseFinancialInput

Type: object

Title: ApiEntityScenarioPhaseFinancialInput

Show Source

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

{
    "title":"ApiEntityScenarioPhaseFinancialInput",
    "type":"object",
    "properties":{
        "year":{
            "type":"integer",
            "description":"The year of phase period of a target or proposed budget.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The month of phase period of a target or proposed budget.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phaseCostCOR":{
            "type":"number",
            "description":"The amount of a target or proposed budget for a particular period. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntitySubCostCurveInput

Type: object

Title: ApiEntitySubCostCurveInput

Show Source

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

{
    "title":"ApiEntitySubCostCurveInput",
    "type":"object",
    "properties":{
        "costSubCurveType":{
            "type":"string",
            "description":"The type of the cost curve.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL",
                "EXPENSE"
            ]
        },
        "totalCOR":{
            "type":"number",
            "description":"The total cost of the cost curve.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCurvePeriods":{
            "type":"array",
            "description":"The phase wise costs of cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : costCurvePeriods

Type: array

The phase wise costs of cost curve.

Show Source

• Array of: object ApiEntityScenarioPhaseFinancialInput
  Title: ApiEntityScenarioPhaseFinancialInput

{
    "type":"array",
    "description":"The phase wise costs of cost curve.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Examples

Select an example Update a Budget Planning Scenario Using Scenario ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request.

Back to Top