Skip to content
Developers
Get an API token

Rename, share, link or pair a source

Change a forecast source's name, visibility, plan_id or pairs (at least one).

Rename, share, link or pair a source

PATCH/forecast-sources/{id}

Change a forecast source's name, visibility, plan_id or pairs (at least one). A refused request changes nothing, the plan to link included; only the creator, signed in, can make a source private.

Send a Novi API token as a bearer token on every request. Authentication
Conflicts

If-Match with the ETag changes only the version you read; a stale one is a 409 with details.etag. Without it, a change made between the server's read and its write is a 409 too.

Errors

Unknown fields are a 400 listing the allowed ones. A server without a state store answers 409 "Forecast sources need a state store; this server keeps plans in memory".

Parameters

Path parameters

Header parameters

  • If-MatchstringOptional

    The source's ETag, including quotes.

Request bodyRequired

application/json

The fields to change.

  • namestringOptional

    1 to 100 characters

    The new name.

  • visibilitystringOptional

    private (its signed-in creator only) or tenant.

    "private""tenant"
  • plan_idstring or nullOptional

    Format uuid

    A done plan to link, which linking saves; null unlinks.

  • pairsobject or nullOptional

    Source Well IDs to the linked plan's well indexes, as {"W-1": 0}; null clears them.

Responses

200 OK

The updated source and its ETag.

  • idstringRequired

    Format uuid

    Source id.

  • namestringRequired

    Name.

  • formatstringRequired

    The file's format.

    "valnav_decline""valnav_constants""novi_arps""combocurve_parameters""mosaic_decline""aries"
  • unitsstringRequired

    The file's unit system; curves are stored in bbl/d and mcf/d.

    "imperial""metric"
  • conventionsstringRequired

    The decline conventions its curves run under.

    "valnav""mosaic""combocurve""novi""aries"
  • gas_basisstringRequired

    raw or sales gas.

    "raw""sales"
  • curve_countintegerRequired

    ≥ 0

    Curves.

  • well_countintegerRequired

    ≥ 0

    Distinct Well IDs.

  • fileobjectRequired

    The file read; the file itself isn't kept.

    ShowHide 3 child fields
    • namestring or nullRequired

      The uploaded file's name, or JSON file_name; null without one.

    • bytesintegerRequired

      ≥ 0

      Its size.

    • sha256stringRequired

      Its SHA-256, hex.

  • visibilitystringRequired

    private answers only its creator; tenant every user of the tenant.

    "private""tenant"
  • created_bystring or nullRequired

    The signed-in creator's email; null for a server's configured user.

  • created_atstringRequired

    Format date-time

    Creation time.

Show all 20 fields
  • updated_atstringRequired

    Format date-time

    Last change.

  • plan_idstring or nullRequired

    Format uuid

    The linked plan, or null when none is linked. A plan that is gone or that the caller can't read stays here with plan_linked: false.

  • plan_linkedbooleanRequired

    Whether plan_id names a plan the caller can read: false with a plan_id when that plan is gone or hidden from the caller.

  • etagstringRequired

    Current ETag including quotes; send as If-Match.

  • reserves_categoriesarray of objectsRequired

    Its reserves categories.

    ShowHide 2 child fields in each item
    • valuestringRequired

      As the file has it.

    • curvesintegerRequired

      ≥ 0

      Curves.

  • pairsobject or nullRequired

    Source Well IDs to the linked plan's well indexes; null without pairs. A gone link (plan_linked: false) keeps them, a start for pairing with another plan: PATCH with plan_id and pairs.

  • read_reportobjectRequired

    What the read left out.

    ShowHide 1 child field
    • rowsarray of objectsRequired

      The rows with an issue.

      ShowHide 3 child fields in each item
      • filestringRequired

        The part or field the row is in: file, constants, csv or constants_csv.

      • idintegerRequired

        ≥ 0

        Its data row in that file, from 0.

      • issuesarray of stringsRequired

        What was wrong.

  • curvesarray of objectsOptional

    Only with include=volumes: the stored curves, in file order.

    ShowHide 11 child fields in each item
    • well_idstringRequired

      The Well ID, as the file has it.

    • reserves_categorystringRequired

      Its reserves category (a Novi P-level reads as P50 or its options.p_levels category).

    • designstring or nullRequired

      Its completion design (Novi arps.csv), or null.

    • streamstringRequired

      The stream it forecasts.

      "oil""gas""water"
    • productstringRequired

      The file's product it came from.

    • ratiostring or nullRequired

      The ratio it is, its stream from its parent's, or null.

      "gor""ogr""cgr""wor""wgr"
    • profilestringRequired

      The decline conventions it runs under (GET /conventions include=decline_profiles).

      "valnav""mosaic""combocurve""novi""aries"
    • start_datestring or nullRequired

      The date of day 0, or null when the file counts ip days.

    • templatestring or nullRequired

      The Val Nav template it matched, ComboCurve's Segment Types in order, or null.

    • segmentsarray of objectsRequired

      Its segments in order, each starting where the one before ends.

      ShowHide 9 child fields in each item
      • startnumberRequired

        The day it starts, from day 0.

      • qinumberRequired

        Rate at start: bbl/d for oil and water, mcf/d for gas; for a ratio, the ratio (GOR scf/bbl, OGR, CGR and WGR bbl/MMcf, WOR bbl/bbl).

      • dinumberRequired

        Nominal decline per year at start; below 0 for an incline.

      • bnumberRequired

        Arps b: 0 exponential, 1 harmonic, -1 a straight line.

      • endnumber or nullOptional

        The day it ends; absent or null runs to qf, df or the curve's end.

      • qfnumber or nullOptional

        The rate it ends at.

      • dfnumber or nullOptional

        The nominal decline it ends at.

      • max_ratenumber or nullOptional

        A cap on the rate.

      • slopestringOptional

        What a ratio declines with: time or the parent stream's cumulative volume.

        "time""volume"
    • volumesobjectRequired

      Volumes from Novi's Arps decline calculation.

      ShowHide 5 child fields
      • unitstringRequired

        bbl for oil and water, mcf for gas.

        "bbl""mcf"
      • ip_daysarray of integersRequired

        The days asked, ascending.

      • valuesarray of numbers or nullRequired

        Cumulative volume at each ip_day, rounded to 0.1; null when the engine can't run the curve.

      • eurnumber or nullRequired

        Volume to the curve's end, rounded to 0.1.

      • errorstringOptional

        Why the engine can't run it.

Errors

StatusWhen
404

No such well, grid, plan or route.

409

A stale If-Match, or without one a change made while the request ran (details.etag is the current one); or the plan to link is running or failed. A server without a state store answers 409 "Forecast sources need a state store; this server keeps plans in memory".

413

The request body is over 10 MB.

Shared errors400401403500What they mean