Skip to content
Cloud APIs
/
/
/
Create a new scenario

Create a new scenario

Request

Creates a new scenario in the given study as a candidate development option. An ensemble to hold the scenario's realizations is provisioned automatically; only the scenario title is required.

Security
bearer and appkey
Query
studyIdstringrequired

The study in which scenario will be created.

Headers
slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The scenario that needs to be created.

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"
]
curl -i -X POST \
  'https://api.delfi.slb.com/fdplan/studies/v1/scenarios?studyId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string' \
  -d '{
    "title": "Minimal investment",
    "colour": "#ff0000",
    "description": "Minimal investment development option scenario.",
    "isSelected": false,
    "associatedOpportunityIDs": [
      "01CP3E6EJJ25J29YHZ0K4ANABC",
      "01CP3E6EJJ25J29YHZ0K4ANDEF"
    ]
  }'

Responses

Scenario created successfully.

Headers
Locationstring

The URL of the scenario.

Bodyapplication/json
idstring

A scenario's unique identifier.

Example:"01CP3E6EJJ25J29YHZ0K4RDZH8"
displayIDstring

The user-friendly ID of this scenario.

Example:"S1"
ensembleIDstring

The ID of the ensemble that manages all the realizations associated with the scenario.

titlestring

A scenario's title.

Example:"Minimal investment"
descriptionstring

The description of this scenario.

Example:"Minimal investment development option scenario."
lastUpdatedobject(LastUpdated)

Details of the last update to a resource.

Example:
{
  "atDate": "2020-09-08T09:53:36.000Z",
  "byEvent": "01EHPJ54HEA77K95T5KPH5JSW9",
  "byUser": "user@slb.com"
}
createdobject(Created)

Details about the creation of a resource.

Example:
{
  "atDate": "2020-09-08T09:53:36.000Z",
  "byEvent": "01EHPJ54HEA77K95T5KPH5JSW9",
  "byUser": "user@slb.com"
}
isSelectedboolean or null

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

Example:true
decisionsArray of objects(Decision)

The collection of the scenario's decisions.

Example:
[
  {
    "id": "01CP3E6EJJ25J29YHZ0K4RDZH8",
    "title": "A development decision"
  }
]
colourstring

The colour of this scenario represented as a HTML hex value (e.g. "#ffa71a").

Example:"#ff0000"
versioninteger or null, (int32)

The version of the described scenario.

Example:2
associatedDevelopmentConceptIdstring or null

The development concept id which is associated with this scenario.

Example:"01CP3E6EJJ25J29YHZ0K4ANIH8"
associatedOpportunityIDsArray of strings or null
Example:
[
  "01CP3E6EJJ25J29YHZ0K4ANABC",
  "01CP3E6EJJ25J29YHZ0K4ANDEF"
]
Response
{
  "id": "01CP3E6EJJ25J29YHZ0K4RDZH8",
  "displayID": "S1",
  "title": "Minimal investment",
  "description": "Minimal investment development option scenario.",
  "lastUpdated": {
    "atDate": "2020-09-08T09:53:36.000Z",
    "byEvent": "01EHPJ54HEA77K95T5KPH5JSW9",
    "byUser": "user@slb.com"
  },
  "created": {
    "atDate": "2020-09-08T09:53:36.000Z",
    "byEvent": "01EHPJ54HEA77K95T5KPH5JSW9",
    "byUser": "user@slb.com"
  },
  "isSelected": false,
  "colour": "#ff0000",
  "version": 2,
  "associatedDevelopmentConceptId": "01CP3E6EJJ25J29YHZ0K4ANIH8",
  "associatedOpportunityIDs": [
    "01CP3E6EJJ25J29YHZ0K4ANABC",
    "01CP3E6EJJ25J29YHZ0K4ANDEF"
  ]
}