Jump to

• Request
• Response

Manage Fund Allocation of Budget Planning Scenarios

put

/api/restapi/budgetPlanningScenario/manageFundAllocation/batch

Send a request to this endpoint to assign, unassign and update funds of 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

Request Body - application/json ()

Root Schema : List<ApiEntityFundPlanningScenarioInput>

Type: array

Title: List<ApiEntityFundPlanningScenarioInput>

Show Source

• Array of: object ApiEntityFundPlanningScenarioInput
  Title: ApiEntityFundPlanningScenarioInput

{
    "title":"List<ApiEntityFundPlanningScenarioInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFundPlanningScenarioInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityFundPlanningScenarioInput

Type: object

Title: ApiEntityFundPlanningScenarioInput

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
  Minimum Length: 1

  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.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityFundPlanningScenarioInput",
    "required":[
        "planPeriod",
        "portfolioId",
        "scenarioName"
    ],
    "type":"object",
    "properties":{
        "planProjects":{
            "type":"array",
            "description":"The plan projects associated with a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundPlanProjectInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "hidden":{
            "type":"boolean",
            "description":"Enables you to decide whether or not a scenario is hidden from other users.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Capital Portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : planProjects

Type: array

The plan projects associated with a scenario.

Show Source

• Array of: object ApiEntityFundPlanProjectInput
  Title: ApiEntityFundPlanProjectInput

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

Nested Schema : ApiEntityFundPlanProjectInput

Type: object

Title: ApiEntityFundPlanProjectInput

Show Source

• linked: boolean
  The flag to link or unlink a project in a scenario.
• portfolioProjectFunds: array portfolioProjectFunds
  The funds assigned to 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.
• state: string
  Allowed Values: [ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ]

  The state of capital plan project.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityFundPlanProjectInput",
    "type":"object",
    "properties":{
        "portfolioProjectFunds":{
            "type":"array",
            "description":"The funds assigned to a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityPortfolioProjectFundInput",
                "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 : portfolioProjectFunds

Type: array

The funds assigned to a plan project.

Show Source

• Array of: object ApiEntityPortfolioProjectFundInput
  Title: ApiEntityPortfolioProjectFundInput

{
    "type":"array",
    "description":"The funds assigned to a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityPortfolioProjectFundInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityPortfolioProjectFundInput

Type: object

Title: ApiEntityPortfolioProjectFundInput

Show Source

• fundAssignUnAssignAction: string
  Allowed Values: [ "ASSIGN", "UNASSIGN" ]

  The action to be taken for a fund associated with a plan project.
• fundCode: string
  Maximum Length: 60

  The user-specified identifier of a fund associated with a plan project.
• fundEndDate: string (date-time)
  The date when money in the fund will no longer be available.
• fundId: integer (int64)
  The unique identifier of a fund associated with a plan project.
• fundName: string
  Maximum Length: 255

  The name of a fund associated with a plan project.
• fundStartDate: string (date-time)
  The date when money in the fund will start being available.
• periods: array periods
  The phase wise fund associated with a plan project.
• proposedFundCOR: number (double)
  The proposed fund of a fund associated with a plan project based on base currency.

{
    "title":"ApiEntityPortfolioProjectFundInput",
    "type":"object",
    "properties":{
        "proposedFundCOR":{
            "type":"number",
            "description":"The proposed fund of a fund associated with a plan project based on base currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "fundId":{
            "type":"integer",
            "description":"The unique identifier of a fund associated with a plan project. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of a fund associated with a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a fund associated with a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundStartDate":{
            "type":"string",
            "description":"The date when money in the fund will start being available.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundEndDate":{
            "type":"string",
            "description":"The date when money in the fund will no longer be available.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "periods":{
            "type":"array",
            "description":"The phase wise fund associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFundPeriodInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "fundAssignUnAssignAction":{
            "type":"string",
            "description":"The action to be taken for a fund associated with a plan project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ASSIGN",
                "UNASSIGN"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : periods

Type: array

The phase wise fund associated with a plan project.

Show Source

• Array of: object ApiEntityFundPeriodInput
  Title: ApiEntityFundPeriodInput

{
    "type":"array",
    "description":"The phase wise fund associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFundPeriodInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityFundPeriodInput

Type: object

Title: ApiEntityFundPeriodInput

Show Source

• proposedFundCostCOR: number (double)
  The cost of portfolio project fund. This is an input field, will not be a part of response.
• year: integer (int32)
  The year of phase period of a fund.

{
    "title":"ApiEntityFundPeriodInput",
    "type":"object",
    "properties":{
        "year":{
            "type":"integer",
            "description":"The year of phase period of a fund.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "proposedFundCostCOR":{
            "type":"number",
            "description":"The cost of portfolio project fund. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Manage Fund Allocation of Budget Planning Scenarios Using Scenario IDs

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.

Back to Top