Skip to content
Cloud APIs
/
FDPlan
/
/Schema Definitions

Ensemble

A collection of realizations produced for a single scenario or virtual scenario, scoped to a version of a workflow specification.

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:
[]
{
  "Id": "01J55M2WX7Z2NM9APBZ92NTNXY",
  "version": 3,
  "workflowSpecId": {
    "Id": "01E86SDT0780JMFFZHPBV3KVHV",
    "version": 1
  },
  "uncertaintyMethod": "Deterministic",
  "tags": [
    "StudyId:01J55K2V6T77MRHGT1EZ60KMJ2",
    "ScenarioId:01J55M2W4BJA6CGBRCNCK412XZ"
  ],
  "cases": [],
  "realizations": [
    { … }
  ]
}