Skip to content

CreateScenarioRequest

titlestring, <= 100 charactersrequired

The title of this scenario.

Example:"Minimal investment"
colourstring^#([A-Fa-f0-9]{6})$|^$

AA-friendly colour for scenario. Specified as hex, e.g '#FFA71A'.

Example:"#ff0000"
descriptionstring, <= 500 characters

The description of this scenario.

Example:"Minimal investment development option scenario."
isSelectedboolean

A scenario is marked as selected when it has been featured above other scenarios in the same study by a user.

Example:false
associatedOpportunityIDsArray of strings or null
Example:
[ "01CP3E6EJJ25J29YHZ0K4ANABC", "01CP3E6EJJ25J29YHZ0K4ANDEF" ]
{ "title": "Minimal investment", "colour": "#ff0000", "description": "Minimal investment development option scenario.", "isSelected": false, "associatedOpportunityIDs": [ "01CP3E6EJJ25J29YHZ0K4ANABC", "01CP3E6EJJ25J29YHZ0K4ANDEF" ] }