Jump to

• Request
• Response

Update a Schedule Scenario

put

/api/restapi/scheduleScenario

Send a request to this endpoint to update a schedule scenario.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityScheduleScenarioInput

Type: object

Title: ApiEntityScheduleScenarioInput

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

• scenarioId
• name,projectId
• name,projectCode,workspaceCode

Show Source

• description: string
  Minimum Length: 0

  Maximum Length: 4000

  A detailed summary for the baseline or snapshot.
• hidden: boolean
  Indicates if a scenario is hidden on the Activities page.
• name(required): string
  Maximum Length: 255

  Name for the baseline or snapshot.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.
• scenarioId: integer (int64)
  The system-generated unique identifier of the schedule scenario.
• sourceName: string
  Name of baseline or scenario.
• sourceType: string
  Allowed Values: [ "BASELINE", "SCENARIO", "CURRENT_SCHEDULE", "FROM_HISTORY" ]

  The source type of the schedule scenario. Default Value is CURRENT_SCHEDULE.
• time: string (date-time)
  The time at which the scenario was generated. Allowed format is "yyyy-MM-dd'T'HH:mm:ss.Z".
• type: string
  Allowed Values: [ "WHAT_IF", "RETIRED", "CLOSED" ]

  The type of the scenario. A scenario can have a type of What-if, Closed, or Retired.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the project's workspace.

{
    "title":"ApiEntityScheduleScenarioInput",
    "required":[
        "name",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "name":{
            "maxLength":255,
            "type":"string",
            "description":"Name for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"The type of the scenario. A scenario can have a type of What-if, Closed, or Retired.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "WHAT_IF",
                "RETIRED",
                "CLOSED"
            ]
        },
        "time":{
            "type":"string",
            "description":"The time at which the scenario was generated. Allowed format is \"yyyy-MM-dd'T'HH:mm:ss.Z\".",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the schedule scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hidden":{
            "type":"boolean",
            "description":"Indicates if a scenario is hidden on the Activities page.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"A detailed summary for the baseline or snapshot.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sourceType":{
            "type":"string",
            "description":"The source type of the schedule scenario. Default Value is CURRENT_SCHEDULE.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "BASELINE",
                "SCENARIO",
                "CURRENT_SCHEDULE",
                "FROM_HISTORY"
            ]
        },
        "sourceName":{
            "type":"string",
            "description":"Name of baseline or scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of the project's workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ScheduleScenario object, a unique ScheduleScenario object can be identified by the following combinations of the fields.<ul><li>scenarioId</li><li>name,projectId</li><li>name,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

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

Back to Top