Create Scenario
post
/essbase/rest/v1/scenarios
Creates a new scenario. A scenario is a private work area in which you can model different assumptions within the data without affecting the existing data.
Request
Supported Media Types
- application/json
- application/xml
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 created 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 create the scenario. Required fields such as scenario name or due date may be empty.
500 Response
Internal Server Error.