combocurve-client-csharp
C# client for the ComboCurve REST API
View the Project on GitHub insidepetroleum/combocurve-client-csharp
ComboCurve.Api.Model.ScenarioRunRequest
Request body for POST .../scenarios/{scenarioId}/run. All fields are optional. Omitting setting ids uses UI dialog defaults (Mode A). Supplying setting ids loads those saved settings (Mode B). Only economics runs are supported.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| WellIds | List<string> | Well IDs to run. Each resolves to the base scenario-well-assignment; incrementals are included only with `incrementalIndex`. Omit to run every well in the scenario. | [optional] |
| IncrementalIndex | int? | Set to 1 to also run each well's incremental 1, next to its base row. Results for an incremental are the difference against its base row. Every well listed in `wellIds` must have an incremental 1; when `wellIds` is omitted, wells without one run their base row only. A well with duplicate incremental 1 rows is rejected. Economics evaluates no other incremental, so any other value except 0 is rejected with `IncrementalIndexNotSupportedError`. List a scenario's incrementals with `…/well-assignments/incrementals`. | [optional] |
| EconSettingId | string | ID of a company-wide econ setting (`GET /v1/econ-settings/{id}`). | [optional] |
| EconReportSettingId | string | ID of a company-wide econ report setting (`GET /v1/econ-report-settings/{id}`). | [optional] |
| ComboSettingId | string | `id` of an `econ-combo-settings` document scoped to this project and scenario. | [optional] |
| RunModels | string | Defaults to `economics_only`, the only supported value. | [optional] |
| RunMode | string | Defaults to `full`. | [optional] |
| SuggestedHeaders | bool? | Defaults to `false`. | [optional] |
| ProdAnalyticsType | string | Defaults to `calendar`. | [optional] |
| TimeZone | string | IANA time zone used for monthly date bucketing (e.g. `America/Toronto`). Defaults to `UTC`. | [optional] |