Update Scenario Partially
patch
/essbase/rest/v1/scenarios/{id}
Updates basic information about a scenario, including description, due date, priority, and owner.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id(required): integer(int64)
Scenario ID.
Scenario details. Set only those fields which need to be updated.
Root Schema : ScenarioEditBean
Type:
Show Source
object-
description:
string
-
dueDate:
integer(int64)
-
owner:
string
-
priority:
string
Allowed Values:
[ "LOW", "MEDIUM", "HIGH" ]
Response
Supported Media Types
- application/json
- application/xml
200 Response
OK
Scenario updated successfully.
Root Schema : Scenario
Type:
Show Source
object-
application:
string
-
appliedTime:
integer(int64)
-
approvers:
array approvers
-
commentsCount:
integer(int32)
-
createdTime:
integer(int64)
-
database:
string
-
description:
string
-
dueDate:
integer(int64)
-
id:
integer(int64)
-
links:
array links
-
name:
string
-
overdue:
boolean
-
owner:
string
-
participants:
array participants
-
priority:
string
Allowed Values:
[ "LOW", "MEDIUM", "HIGH" ] -
refreshedTime:
integer(int64)
-
sandbox:
string
-
scenarioUser:
boolean
-
scripts:
array scripts
-
state:
string
Allowed Values:
[ "NEW", "SUBMITTED", "APPROVED", "REJECTED", "APPLIED" ] -
submittedTime:
integer(int64)
-
useCalculatedValues:
boolean
Nested Schema : Script
Type:
Show Source
object-
content:
string
Script contents.
-
type:
string
Allowed Values:
[ "REFRESH", "CLEAR", "APPLY" ]
400 Response
Bad Request
Failed to update the scenario. Required fields such as scenario name or due date may be empty.
500 Response
Internal Server Error.