Get scenario results state

Request

Returns the computed run state of a scenario - the data source processing and results publishing status of its ensemble, broken down per realization. Use this to track evaluation progress for the given studyId and scenarioId.

Security

bearer and appkey

Query

studyIdstringrequired

The study from which to get the results state.

scenarioIdstringrequired

The scenario from which to get the results state.

slb-partition-idstringrequired

Data partition id.

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

Responses

Success.

Bodyapplication/json

dataSourceobject(VersionId)

A versioned resource identifier.

Example:

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

dataSourceProcessingErrorsArray of strings

A list of data source processing errors.

Example:

[
  "first error",
  "second error"
]

dataSourceProcessingStatestringrequired

The data source processing state.

Enum:"Unknown""InsufficientData""Running""CompletedSuccessfully""CompletedWithErrors"

Example:"CompletedWithErrors"

lastUpdatedstring or null, (date-time)

The time when the scenario result state was last updated.

Example:"2020-09-08T09:53:36.000Z"

realizationStatesArray of objects(RealizationState)required

A list of realizations with corresponding states.

Example:

[
  {
    "uri": "01HGWMW4HWETWWFZCA1Z0C453Z/realizations/01HGWQMY95XHSCDKSBYRZ8P67M",
    "computationStates": [ … ],
    "lastUpdatedAt": "2021-02-09T20:53:55.000Z",
    "resultsErrors": [],
    "state": "CompletedSuccessfully",
    "version": 11
  }
]

resultsPublishingErrorsArray of strings

A list of results publishing errors.

Example:

[
  "a publishing error"
]

resultsPublishingStatestringrequired

The results state for the scenario.

Enum:"Unknown""InsufficientData""Running""CompletedSuccessfully""CompletedWithErrors"

Example:"CompletedWithErrors"

Response

{
  "dataSource": {
    "id": "01EY46YV3JXND9NM0T70HABRXF",
    "version": 1
  },
  "dataSourceProcessingErrors": [],
  "dataSourceProcessingState": "CompletedSuccessfully",
  "lastUpdated": "2021-02-09T20:56:46.000Z",
  "realizationStates": [
    { … }
  ],
  "resultsPublishingErrors": [],
  "resultsPublishingState": "CompletedSuccessfully"
}