Jump to

• Request
• Response

Batch Update Budget Planning Scenario Status

post

/api/restapi/budgetPlanningScenario/batchUpdateScenarioStatus

Send a request to this endpoint to update status of Budget Planning Scenarios. 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 : List<ApiEntityScenarioStatus>

Type: array

Title: List<ApiEntityScenarioStatus>

Show Source

• Array of: object ApiEntityScenarioStatus
  Title: ApiEntityScenarioStatus

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

  • scenarioId
  • scenarioName,planPeriod,portfolioId
  • scenarioName,planPeriod,portfolioName,workspaceCode

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

Nested Schema : ApiEntityScenarioStatus

Type: object

Title: ApiEntityScenarioStatus

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

• scenarioId
• scenarioName,planPeriod,portfolioId
• scenarioName,planPeriod,portfolioName,workspaceCode

Show Source

• planPeriod: 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.
• 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.
• 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":"ApiEntityScenarioStatus",
    "required":[
        "portfolioId",
        "scenarioName"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ScenarioStatus object, a unique ScenarioStatus object can be identified by the following combinations of the fields.<ul><li>scenarioId</li><li>scenarioName,planPeriod,portfolioId</li><li>scenarioName,planPeriod,portfolioName,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Budget Planning Scenario Status Using Scenario IDs

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityScenarioStatus>

Type: array

Title: List<ApiEntityScenarioStatus>

Show Source

• Array of: object ApiEntityScenarioStatus
  Title: ApiEntityScenarioStatus

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

  • scenarioId
  • scenarioName,planPeriod,portfolioId
  • scenarioName,planPeriod,portfolioName,workspaceCode

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

Nested Schema : ApiEntityScenarioStatus

Type: object

Title: ApiEntityScenarioStatus

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

• scenarioId
• scenarioName,planPeriod,portfolioId
• scenarioName,planPeriod,portfolioName,workspaceCode

Show Source

• planPeriod: 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.
• 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.
• 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":"ApiEntityScenarioStatus",
    "required":[
        "portfolioId",
        "scenarioName"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ScenarioStatus object, a unique ScenarioStatus object can be identified by the following combinations of the fields.<ul><li>scenarioId</li><li>scenarioName,planPeriod,portfolioId</li><li>scenarioName,planPeriod,portfolioName,workspaceCode</li>",
    "exampleSetFlag":false
}

400 Response

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

Back to Top