Skip to content
Developers
Get an API token

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

GET/plans/{id}/checks

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.

Send a Novi API token as a bearer token on every request. Authentication
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 wells descending, 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, with design set 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

Query parameters

  • designintegerOptional

    ≥ 0

    A design index; absent: every design. Out of range is a 400.

  • scenariostringOptional

    On 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_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches 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 once default is 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's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; 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_idstringRequired

    Format uuid

    Plan id.

  • statusstringRequired

    Plan status.

    "running""done""error"
  • checksarray of objectsRequired

    One 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 objectsRequired

      Inputs outside training.

      ShowHide 9 child fields in each item
      • featurestringRequired

        Input name; labels come from GET /models inputs[].label.

      • sidestringRequired

        Below or above the training range p01..p99.

        "below""above"
      • wellsintegerRequired

        ≥ 1

        Distinct wells counted.

      • lownumberRequired

        Training p01 from the first counted item.

      • highnumberRequired

        Training p99 from the first counted item.

      • minnumberRequired

        Smallest counted value.

      • maxnumberRequired

        Largest counted value.

      • model_numstringRequired

        Model supplying the training range.

      • well_indexesarray of integersRequired

        up to 20 itemsItems ≥ 0

        First 20 counted wells in plan order.

    • missingarray of objectsRequired

      Missing inputs.

      ShowHide 3 child fields in each item
      • featurestringRequired

        Missing input name.

      • wellsintegerRequired

        ≥ 1

        Distinct wells counted.

      • well_indexesarray of integersRequired

        up to 20 itemsItems ≥ 0

        First 20 counted wells in plan order.

    • unknown_formationarray of objectsRequired

      Formations absent from training.

      ShowHide 3 child fields in each item
      • valuestringRequired

        Formation absent from training.

      • wellsintegerRequired

        ≥ 1

        Distinct wells counted.

      • well_indexesarray of integersRequired

        up to 20 itemsItems ≥ 0

        First 20 counted wells in plan order.

    • contextarray of objectsRequired

      Neighboring production outside training; flags nothing.

      Same fields as PlanCheckRow.

    • scenariostringOptional

      Scenario name, only on scenario plans.

    • wells_contextintegerOptional

      ≥ 1

      Checked wells with context, absent when none, as in totals; context flags nothing.

Conditional requests 304 Unchanged since the ETag in If-None-Match.

Errors

StatusWhen
404

No such well, grid, plan or route.

409

The request conflicts with the state of the plan or resource it names, and message says how: for example a plan still running or failed, a stale If-Match, an Idempotency-Key reused with another body, or a server without a state store.

Shared errors400401403500503What they mean