VirtualScenarioResultsState

Cloud APIs

VirtualScenarioResultsState

The result state of a virtual scenario, including its per-realization states.

virtualScenarioIdstringrequired

The identifier of the virtual scenario.

Example:"01JY70N8TE9DG79NTQZDFMGEW3"

tagsArray of stringsrequired

List of tags associated with the virtual scenario.

Example:

[
  "StudyId:01JY6FMJMY0F6AJFV05V831SB4",
  "Iteration:Iteration1",
  "Case:case1",
  "EnsembleId:01JY70N8V117GD9G75EP3BP5GW"
]

realizationStatesobjectrequired

A list of realizations with their corresponding states.

Example:

{
  "items": [
    { … },
    { … }
  ]
}

dataSourceProcessingStatestring(RunState)required

Run state of a process.

Enum:"Unknown""InsufficientData""Running""CompletedSuccessfully""CompletedWithErrors""CompletedWithRetryableErrors""Stopping""Stopped"

Example:"CompletedWithErrors"

dataSourceProcessingErrorsArray of strings

A list of data source processing errors.

Example:

[
  "first error message"
]

dataSourceobject(VersionId)

An identifier and version pair.

Example:

{
  "id": "01JY70N7ZGAQ02RZF2BTHDKRN8",
  "version": 1
}

{
  "virtualScenarioId": "01JY70N8TE9DG79NTQZDFMGEW3",
  "dataSource": {
    "id": "01JY70ZMBEECJH58ZQ1K9K19DH",
    "version": 1
  },
  "dataSourceProcessingErrors": [
    "first error message"
  ],
  "dataSourceProcessingState": "CompletedWithErrors",
  "tags": [
    "StudyId:01JY6FMJMY0F6AJFV05V831SB4",
    "Iteration:Iteration1",
    "Case:case1",
    "EnsembleId:01JY70N8V117GD9G75EP3BP5GW"
  ],
  "realizationStates": {
    "items": [ … ]
  }
}