Skip to content
Cloud APIs
/
FDPlan
/
/Scenarios

Get all scenarios

Request

Returns all scenarios in the given study, each with its answered decisions and the choice selected for that scenario. A scenario represents one candidate development option evaluated against the study's workflow specification. Requires the studyId of the owning study.

Security
bearer and appkey
Query
studyIdstringrequired

The study which Scenarios/Decisions/Choices belongs to.

Headers
slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/studies/v1/scenarios?studyId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved scenarios successfully.

Bodyapplication/json
itemsArray of objects(Scenario)required
Example:
[
  {
    "id": "01CP3E6EJJ25J29YHZ0K4RDZH8",
    "displayID": "S1",
    "title": "Minimal investment",
    "description": "Minimal investment development option scenario.",
    "lastUpdated": { … },
    "created": { … },
    "isSelected": false,
    "colour": "#ff0000",
    "associatedDevelopmentConceptId": "01CP3E6EJJ25J29YHZ0K4ANIH8"
  },
  {
    "id": "01CP3E6EJJ25J29YHZ0K4RSDFI4",
    "displayID": "S2",
    "title": "Maximum investment",
    "description": "Maximum investment development option scenario.",
    "lastUpdated": { … },
    "created": { … },
    "isSelected": false,
    "colour": "#ff0000",
    "associatedDevelopmentConceptId": "01CP3E6EJJ25J29YHZ0K4ANIH8"
  }
]
Response
{
  "items": [
    { … },
    { … }
  ]
}