Count a plan's flagged wells by input and side
A plan's warnings counted per design and, on a plan made with scenarios, per scenario: how many wells were checked, flagged and given context, and which inputs flagged them on which side.
Count a plan's flagged wells by input and side
/plans/{id}/checksA plan's warnings counted per design and, on a plan made with scenarios, per scenario: how many wells were checked, flagged and given context, and which inputs flagged them on which side.
Counts
PlanChecksEntry describes each count; they match GET /plans/{id} totals, and wells includes per_well_errors failures. context flags nothing: it describes neighboring production outside training.
Rows
A row is a feature, side and model_num (missing by feature, unknown_formation by value), counting each well once, as PlanCheckRow describes it. Unavailable checks add nothing, and an empty list is [].
- Scenarios come in the plan's order, designs in index order within each.
- Lists sort by
wellsdescending, then feature or value by code point, then below before above, then model_num by code point. - For the full per-well list beyond
well_indexes, read GET /plans/{id}?include=wells&fields=checks&design=0, withdesignset to the entry's index.
While it runs
Only finished wells count, with Retry-After: 1 and no ETag. A done plan's answer carries an ETag; send If-None-Match for a 304. A failed plan answers 409.
Parameters
Path parameters
idstringRequiredFormat
uuidPlan id from POST /plans.
Query parameters
designintegerOptional≥ 0
A design index; absent: every design. Out of range is a 400.
scenariostringOptionalOn a plan made with scenarios: a scenario name; absent: one entry per scenario. A name the plan lacks is a 400 listing its scenarios.
model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches the base dataset; once the server retires it, a 400 naming the set answering instead.- An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in
details.allowed(published sets only oncedefaultis retired); a set that can't load, a 503 with the reason. - Plans and exports stay in their set: a call naming them (by path,
plan,ids,source.plan, a scenario'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Responses
200 OK
The checks rollup; an ETag when done, Retry-After: 1 while running.
plan_idstringRequiredFormat
uuidPlan id.
statusstringRequiredPlan status.
"running""done""error"checksarray of objectsRequiredOne entry per scenario and design.
ShowHide 11 child fields in each item
designintegerRequired≥ 0
The design, as its index in
designs.wellsintegerRequired≥ 0
All wells in scope, including failed wells.
wells_checkedintegerRequired≥ 0
Wells with available checks.
wells_flaggedinteger or nullRequired≥ 0
Checked wells with flagged; null when no well was checked, as in totals.
wells_uncheckedintegerRequired≥ 0
Wells with held forecasts but no available checks.
out_of_rangearray of objectsRequiredInputs outside training.
ShowHide 9 child fields in each item
featurestringRequiredInput name; labels come from GET /models inputs[].label.
sidestringRequiredBelow or above the training range p01..p99.
"below""above"wellsintegerRequired≥ 1
Distinct wells counted.
lownumberRequiredTraining p01 from the first counted item.
highnumberRequiredTraining p99 from the first counted item.
minnumberRequiredSmallest counted value.
maxnumberRequiredLargest counted value.
model_numstringRequiredModel supplying the training range.
well_indexesarray of integersRequiredup to 20 itemsItems ≥ 0
First 20 counted wells in plan order.
missingarray of objectsRequiredMissing inputs.
ShowHide 3 child fields in each item
featurestringRequiredMissing input name.
wellsintegerRequired≥ 1
Distinct wells counted.
well_indexesarray of integersRequiredup to 20 itemsItems ≥ 0
First 20 counted wells in plan order.
unknown_formationarray of objectsRequiredFormations absent from training.
ShowHide 3 child fields in each item
valuestringRequiredFormation absent from training.
wellsintegerRequired≥ 1
Distinct wells counted.
well_indexesarray of integersRequiredup to 20 itemsItems ≥ 0
First 20 counted wells in plan order.
contextarray of objectsRequiredNeighboring production outside training; flags nothing.
Same fields as PlanCheckRow.
scenariostringOptionalScenario name, only on scenario plans.
wells_contextintegerOptional≥ 1
Checked wells with context, absent when none, as in totals; context flags nothing.
304 Unchanged since the ETag in If-None-Match.Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
| 409 | The request conflicts with the state of the plan or resource it names, and |
Shared errors400401403500503What they mean