Skip to content
Cloud APIs
/
/
/
Update an ensemble

Update an ensemble

Request

Update an existing ensemble. The request body is a JSON Patch document, and only the replace operation is supported. Use it to change mutable fields, such as the realizations selected for evaluation.

Security
bearer and appkey
Path
idstringrequired

The identifier of the ensemble to update.

Headers
slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The patches to apply to the ensemble. Only the replace operation is supported.

Array [
opstringrequired

The operation to perform. Only the replace operation is supported.

Value:"replace"
Example:"replace"
pathstringrequired

A JSON Pointer to the field to update.

Example:"01K21TCP8YRHJP29K3WXACFPKP/realizations/01K21TRKZG07FYG68EW3Y45X7B/status"
valueany

The value to use within the operation.

Example:"Active"
]
curl -i -X PATCH \
  'https://api.delfi.slb.com/fdplan/uncertainty/v1/ensembles/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string' \
  -d '[
    {
      "op": "replace",
      "path": "01K21TCP8YRHJP29K3WXACFPKP/realizations/01K21TRKZG07FYG68EW3Y45X7B/status",
      "value": "Active"
    }
  ]'

Responses

The ensemble was updated successfully.

Bodyapplication/json
Idstringrequired

The identifier of the ensemble.

Example:"01J55M2WX7Z2NM9APBZ92NTNXY"
versioninteger, (int32)required

The version of the ensemble.

Example:3
workflowSpecIdobject(VersionId)required

An identifier and version pair used to reference a specific version of a resource, such as a workflow specification or a data type.

Example:
{
  "Id": "01E86SDT0780JMFFZHPBV3KVHV",
  "version": 1
}
realizationsArray of objects(Realization)required

The list of realizations associated with the ensemble.

Example:
[
  {
    "Id": "01J55K2V6T77MRHGT1EZ60KMJ2/realizations/01J55M7D63XFJM64GS1N2NNE5V",
    "status": "Active",
    "version": 7,
    "containers": [ … ]
  }
]
uncertaintyMethodstring

The methodology used to produce the realizations of the ensemble.

  • MonteCarlo - Realizations are created automatically by Monte Carlo sampling of the input data sources.
  • Deterministic - You provide the outcomes directly in the input data sources and choose which realizations to evaluate.
Default:"MonteCarlo"
Enum:"MonteCarlo""Deterministic"
Example:"Deterministic"
tagsArray of strings

The list of tags associated with the ensemble, such as StudyId and ScenarioId, that link it back to its scenario.

Example:
[
  "StudyId:01J55K2V6T77MRHGT1EZ60KMJ2",
  "ScenarioId:01J55M2W4BJA6CGBRCNCK412XZ"
]
casesArray of objects(Case)

The cases that the ensemble is associated with.

Example:
[]
Response
{
  "Id": "01J55M2WX7Z2NM9APBZ92NTNXY",
  "version": 3,
  "workflowSpecId": {
    "Id": "01E86SDT0780JMFFZHPBV3KVHV",
    "version": 1
  },
  "uncertaintyMethod": "Deterministic",
  "tags": [
    "StudyId:01J55K2V6T77MRHGT1EZ60KMJ2",
    "ScenarioId:01J55M2W4BJA6CGBRCNCK412XZ"
  ],
  "cases": [],
  "realizations": [
    { … }
  ]
}