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

Create a new study

Request

Creates a new study for an investment opportunity, specifying the evaluation workflow specification and the access control groups that govern it. The returned study ID becomes the correlation key that ties every downstream scenario, deliverable, and result back to this study.

Security
bearer and appkey
Headers
slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The study that needs to be created.

titlestringrequired

The title of this study.

Example:"Robin Field Development"
descriptionstring

The description of this study.

Example:"New development opportunity."
workflowSpecIdstringrequired

The identifier for the evaluation workflow specification to be used in the study.

Example:"01CP3E6EJJ25J29YHZ0K4RDZH8"
workflowSpecVersioninteger, (int32), >= 1required

The identifier for the evaluation workflow specification version to be used in the study.

Example:1
legalTagsArray of strings

Names of the Legal Tag(s) that are assigned to the Study.

Example:
[
  "legal-tag"
]
aclobject(Access Control List)required

The access control list.

Example:
{
  "owners": [
    "data.default.owners@data-partition-id.enterprisedata.slb.com"
  ],
  "viewers": [
    "data.default.viewers@data-partition-id.enterprisedata.slb.com"
  ]
}
evaluationConfigurationobject(EvaluationConfiguration)
curl -i -X POST \
  https://api.delfi.slb.com/fdplan/studies/v1/studies \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string' \
  -d '{
    "title": "Robin Field Development",
    "description": "New development opportunity.",
    "workflowSpecId": "01CP3E6EJJ25J29YHZ0K4RDZH8",
    "workflowSpecVersion": 1,
    "legalTags": [
      "legal-tag"
    ],
    "acl": {
      "owners": [
        "data.default.owners@data-partition-id.enterprisedata.slb.com",
        "data.team.owners@data-partition-id.enterprisedata.slb.com"
      ],
      "viewers": [
        "data.default.viewers@data-partition-id.enterprisedata.slb.com",
        "data.team.viewers@data-partition-id.enterprisedata.slb.com"
      ]
    }
  }'

Responses

Study created successfully.

Headers
Locationstring

The URL of the created study.

Bodyapplication/json
idstringrequired

The ID of this study. This field is immutable.

Example:"01CP3E6EJJ25J29YHZ0K4RDZH8"
titlestringrequired

The title of this study.

Example:"Robin Field Development"
descriptionstringrequired

Description of the study.

Example:"New development opportunity."
countrystringrequired

The country code of this study.

Example:"US"
isArchivedbooleanrequired

Archived status of this study.

Example:false
noOfRealizationsinteger, (int32)

The number of realizations for each study scenario.

Example:10
uncertaintyMethodstring

Methodology selected for uncertainty

Default:"MonteCarlo"
Enum:"Unset""MonteCarlo""Deterministic"
Example:"MonteCarlo"
workflowSpecobject(VersionId)

A versioned resource identifier.

Example:
{
  "id": "01CP3E6EJJ25J29YHZ0K4RDZH8",
  "version": 1
}
aclobject(Access Control List)

The access control list.

Example:
{
  "owners": [
    "data.default.owners@data-partition-id.enterprisedata.slb.com"
  ],
  "viewers": [
    "data.default.viewers@data-partition-id.enterprisedata.slb.com"
  ]
}
evaluationConfigurationobject(EvaluationConfiguration)
Response
{
  "id": "01CP3E6EJJ25J29YHZ0K4RDZH8",
  "title": "Robin Field Development",
  "description": "New development opportunity.",
  "country": "US",
  "isArchived": false,
  "noOfRealizations": 10,
  "uncertaintyMethod": "MonteCarlo",
  "workflowSpec": {
    "id": "01FDYW0CS3ZZB1FS2NCK01WVDX",
    "version": 1
  },
  "acl": {
    "owners": [ … ],
    "viewers": [ … ]
  }
}