Update Scenario Fully
put
/essbase/rest/v1/scenarios/{id}
Updates full details about a scenario.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id(required): integer(int64)
Scenario ID.
Scenario details.
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" ]
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, or the scenario may already have been submitted for approval.
500 Response
Internal Server Error.