iWell

Methods (76)

• get_me

  read

  Get account information for the authenticated user.

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }

• get_users

  read

  List all company users.

• post_users

  unknown

  Create a new user.

• get_users_user_id

  read

  Get single user.

  Required paramsuser_id

• patch_users_user_id

  write

  Update user.

  Required paramsuser_id

• get_users_user_id_wells

  read

  List wells accessible by the user. since=UNIX epoch (30d lookback).

  Required paramsuser_id

• get_users_user_id_wells_well_id

  read

  Verify if the well can be accessed by the user.

  Required paramsuser_idwell_id

• post_users_user_id_wells_well_id

  unknown

  Grant well access to the user.

  Required paramsuser_idwell_id

• get_users_user_id_well_groups

  read

  List well groups accessible by the user. since=UNIX epoch (30d lookback).

  Required paramsuser_id

• get_users_user_id_well_groups_group_id

  read

  Verify if the well group can be accessed by the user.

  Required paramsuser_idgroup_id

• post_users_user_id_well_groups_group_id

  unknown

  Grant well group access to the user.

  Required paramsuser_idgroup_id

• get_wells

  read

  Get all company wells. Upstream iWell only supports `since`; `limit` and `offset` are applied client-side by the connector after fetching the list.

  Input schema

  {
    "type": "object",
    "properties": {
      "since": {
        "type": "integer",
        "description": "UNIX epoch seconds. iWell enforces a 30-day lookback."
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "description": "Client-side max rows to return after fetching the list."
      },
      "offset": {
        "type": "integer",
        "minimum": 0,
        "description": "Client-side row offset applied before limit."
      }
    },
    "additionalProperties": false
  }

  since=epoch (30d). limit/offset client-side. Group: get_well_groups_id_wells.

• post_wells

  unknown

  Create a new well.

• get_wells_well_id

  read

  Get a single well by `well_id`.

  Required paramswell_id
  Input schema

  {
    "type": "object",
    "properties": {
      "well_id": {
        "type": "integer",
        "description": "Well ID."
      }
    },
    "required": [
      "well_id"
    ],
    "additionalProperties": false
  }

• patch_wells_well_id

  write

  Update an existing well.

  Required paramswell_id

• get_wells_well_id_users

  read

  List users with access to this well. since=UNIX epoch (30d lookback).

  Required paramswell_id

• get_wells_well_id_users_user_id

  read

  Verify if the user have access to the well.

  Required paramswell_iduser_id

• post_wells_well_id_users_user_id

  unknown

  Grant well access to the user.

  Required paramswell_iduser_id

• get_wells_well_id_tanks

  read

  List tanks allocated to this well. since=UNIX epoch (30d lookback).

  Required paramswell_id

• get_wells_well_id_tanks_tank_id

  read

  Verify if the tank is allocated to the well.

  Required paramswell_idtank_id

• post_wells_well_id_tanks_tank_id

  unknown

  Allocate the tank to the well.

  Required paramswell_idtank_id

• get_tanks

  read

  Get all tanks. Date param: since is a UNIX epoch integer (30-day lookback max).

• post_tanks

  unknown

  Create new tank

• get_tanks_tank_id

  read

  Get a single tank

  Required paramstank_id

• patch_tanks_tank_id

  write

  Update tank

  Required paramstank_id

• get_tanks_tank_id_readings

  read

  List tank readings. start/end YYYY-MM-DD (30d window). hourly=true needs start===end.

  Required paramstank_id

  Do not pass epochs to start/end. updated_by → list_users_map.

• post_tanks_tank_id_readings

  unknown

  Create tank reading. The previous portion of the reading is optional.

  Required paramstank_id

• get_tanks_tank_id_readings_reading_id

  read

  Get single tank reading.

  Required paramstank_idreading_id

  updated_by → list_users_map. hourly=true needs start===end.

• patch_tanks_tank_id_readings_reading_id

  write

  Update tank reading. The previous portion of the reading is optional.

  Required paramstank_idreading_id

• get_tanks_tank_id_readings_reading_id_run_tickets

  read

  Get run tickets on a tank reading. since=UNIX epoch (30d).

  Required paramstank_idreading_id

  updated_by → list_users_map.

• post_tanks_tank_id_readings_reading_id_run_tickets

  unknown

  Create run ticket.

  Required paramstank_idreading_id

• get_tanks_tank_id_readings_reading_id_run_tickets_run_ticket_id

  read

  Get single run ticket.

  Required paramstank_idreading_idrun_ticket_id

  updated_by → list_users_map.

• patch_tanks_tank_id_readings_reading_id_run_tickets_run_ticket_id

  write

  Update run ticket.

  Required paramstank_idreading_idrun_ticket_id

• get_wells_well_id_meters

  read

  Get the meters for the well. Date param: since is a UNIX epoch integer (30-day lookback max).

  Required paramswell_id

• post_wells_well_id_meters

  unknown

  Create new meter.

  Required paramswell_id

• get_wells_well_id_meters_meter_id

  read

  Get single meter.

  Required paramswell_idmeter_id

• patch_wells_well_id_meters_meter_id

  write

  Update meter.

  Required paramswell_idmeter_id

• get_wells_well_id_meters_meter_id_readings

  read

  Get meter readings. start/end YYYY-MM-DD (30d window).

  Required paramswell_idmeter_id

  No epochs in start/end. updated_by → list_users_map.

• post_wells_well_id_meters_meter_id_readings

  unknown

  Create meter reading.

  Required paramswell_idmeter_id

• get_wells_well_id_meters_meter_id_readings_reading_id

  read

  Get single meter reading.

  Required paramswell_idmeter_idreading_id

  updated_by → list_users_map.

• patch_wells_well_id_meters_meter_id_readings_reading_id

  write

  Update reading.

  Required paramswell_idmeter_idreading_id

• get_wells_well_id_production

  read

  Get production data for a well. start/end YYYY-MM-DD (30d window).

  Required paramswell_id

  No epochs in start/end. updated_by → list_users_map.

• post_wells_well_id_production

  unknown

  Create new production data

  Required paramswell_id

• get_wells_well_id_production_production_id

  read

  Get a single production record.

  Required paramswell_idproduction_id

  updated_by → list_users_map.

• patch_wells_well_id_production_production_id

  write

  Update production.

  Required paramswell_idproduction_id

• get_well_groups

  read

  List all company well groups. Date param: since is a UNIX epoch integer (30-day lookback max).

• post_well_groups

  unknown

  Create a new group.

• get_well_groups_group_id

  read

  Get single group.

  Required paramsgroup_id

• patch_well_groups_group_id

  write

  Update well group.

  Required paramsgroup_id

• get_well_groups_group_id_wells

  read

  Retrieve list of wells in well group.

  Required paramsgroup_id

• get_well_groups_group_id_wells_well_id

  read

  Verify if the well is part of the well group.

  Required paramsgroup_idwell_id

• post_well_groups_group_id_wells_well_id

  unknown

  Add well to well group.

  Required paramsgroup_idwell_id

• get_well_groups_group_id_users

  read

  List users with access to the well group. since=UNIX epoch (30d).

  Required paramsgroup_id

• get_well_groups_group_id_users_user_id

  read

  Verify if the user have access to the well group.

  Required paramsgroup_iduser_id

• post_well_groups_group_id_users_user_id

  unknown

  Grant well group access to the user.

  Required paramsgroup_iduser_id

• get_fields

  read

  Get all custom fields. Date param: since is a UNIX epoch integer (30-day lookback max).

• post_fields

  unknown

  Create field.

• get_fields_field_id

  read

  Get single field.

  Required paramsfield_id

• patch_fields_field_id

  write

  Update field.

  Required paramsfield_id

• get_wells_well_id_fields

  read

  Get all fields assigned for this well.

  Required paramswell_id

• get_wells_well_id_fields_field_id_values

  read

  Get field values for a well. start/end YYYY-MM-DD (30d window).

  Required paramswell_idfield_id

  No epochs in start/end.

• post_wells_well_id_fields_field_id_values

  unknown

  Create a field value for a specific well.

  Required paramswell_idfield_id

• get_wells_well_id_fields_field_id_values_value_id

  read

  Get field value for a specific well.

  Required paramswell_idfield_idvalue_id

• patch_wells_well_id_fields_field_id_values_value_id

  write

  Update field value for a specific well.

  Required paramswell_idfield_idvalue_id

• get_wells_well_id_validation_rules

  read

  Get validation rules for well. Date param: since is a UNIX epoch integer (30-day lookback max).

  Required paramswell_id

• post_wells_well_id_validation_rules

  unknown

  Create a new validation rule for well.

  Required paramswell_id

• get_wells_well_id_validation_rules_rule_id

  read

  Get single validation rule.

  Required paramswell_idrule_id

• patch_wells_well_id_validation_rules_rule_id

  write

  Update validation rule.

  Required paramswell_idrule_id

• get_wells_well_id_notes

  read

  Get notes on the well. since=UNIX epoch (30d).

  Required paramswell_id

  author → list_users_map.

• post_wells_well_id_notes

  unknown

  Create a new note.

  Required paramswell_id

• get_wells_well_id_notes_note_id

  read

  Get single note.

  Required paramswell_idnote_id

  author → list_users_map.

• patch_wells_well_id_notes_note_id

  write

  Update note.

  Required paramswell_idnote_id

• get_wells_well_id_well_tests

  read

  List well tests for a well. start/end YYYY-MM-DD (30d window).

  Required paramswell_id

  No epochs in start/end.

• get_wells_well_id_well_tests_well_test_id

  read

  Get a single well test.

  Required paramswell_idwell_test_id

• find_wells_by_name

  read

  Client-side name/alias substring filter over the company wells list. Use this instead of guessing unsupported server-side filters on `get_wells`.

  Required paramsquery
  Input schema

  {
    "type": "object",
    "properties": {
      "query": {
        "type": "string",
        "description": "Case-insensitive substring matched against `name` and `alias`."
      },
      "type": {
        "type": "string",
        "description": "Optional well type filter, for example `OIL` or `WATER`."
      },
      "is_active": {
        "type": "boolean",
        "description": "Optional active/inactive filter."
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "description": "Client-side max rows to return after filtering."
      },
      "offset": {
        "type": "integer",
        "minimum": 0,
        "description": "Client-side row offset applied before limit."
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }

  Filters: type ("OIL"/"WATER"), is_active. One get_wells call.

• list_users_map

  read

  Return a compact `{id: name}` map of company users for humanizing numeric `updated_by` and `author` fields.

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }