Jump to

• Request
• Response

Update a Resource Planning Scenario Status

put

/api/restapi/resourcePlanningScenario/updateScenarioStatus

Send a request to this endpoint to update status of Resource 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 : ApiEntityResourcePlanningScenarioStatusInput

Type: object

Title: ApiEntityResourcePlanningScenarioStatusInput

Show Source

• capitalPortfolioId: integer (int64)
  Deprecated. As of 25.8.
  The system-generated identifier of the Portfolio.
• capitalPortfolioName: string
  Deprecated. As of 25.8.
  The name of the Portfolio.
• planPeriod: integer (int32)
  The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.
• scenarioId: integer (int64)
  The system-generated identifier of the Resource Plan Scenario.
• scenarioName: string
  The name of Resource 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 Resource Plan Scenario.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ApiEntityResourcePlanningScenarioStatusInput",
    "type":"object",
    "properties":{
        "capitalPortfolioName":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>25.8</i>.</br>The name of the Portfolio.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>25.8</i>.</br>The system-generated identifier of the Portfolio.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Resource Plan Scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "type":"string",
            "description":"The name of Resource Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scenarioStatus":{
            "type":"string",
            "description":"The status of Resource Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "APPROVED",
                "UNDER_REVIEW",
                "IN_PLANNING",
                "UNDER_APPROVAL",
                "RETIRED",
                "SHARED",
                "PENDING_APPROVAL",
                "PENDING_SHARED",
                "PENDING_IN_PLANNING"
            ]
        },
        "planPeriod":{
            "type":"integer",
            "description":"The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid Input.

Back to Top