Skip to main content
Skip table of contents

What API do I use to create/update a Well?

Well API

Example 1 - with minimum properties

CODE
{
  "name": "Well 1",
  "xid": "Well 1",
  "stop": {
    "id": 1234
  }
}

Example 2 - with names and effective values

CODE
{
  "code": "well 1",
  "name": "Well 1",
  "description": "description of well",
  "isactive": true,
  "producingmethod": [
    {
      "value": {
        "name": "Beam Rod"
      },
      "effectivefrom": "2024-02-29",
      "effectiveto": "2024-03-29"
    },
    {
      "value": {
        "name": "Flowing"
      },
      "effectivefrom": "2024-03-30",
      "effectiveto": null
    }
  ],
  "producingstatus": [
    {
      "value": {
        "name": "Drilling"
      },
      "effectivefrom": "2024-02-29",
      "effectiveto": "2024-03-29"
    },
    {
      "value": {
        "name": "Dry Hole"
      },
      "effectivefrom": "2024-03-30",
      "effectiveto": null
    }
  ],
  "producttype": [
    {
      "value": {
        "name": "Crude Oil"
      },
      "effectivefrom": "2024-02-29",
      "effectiveto": null
    }
  ],
  "welltestrecurrence": 2,
  "latitude": 123.12356,
  "longitude": 123.123456,
  "stop": {
    "id": 1234
  },
  "welltype": [
    {
      "value": {
        "name": "Drilling Oil Well"
      }
    }
  ],
  "deliveryconfiguration": [
    {
      "value": {
        "name": "Test"
      }
    }
  ],
  "seqnum": 1,
  "dailyreset": false,
  "primarypurchaser": [
    {
      "value": {
        "name": "Purchaser1"
      },
      "effectivefrom": "2024-02-29",
      "effectiveto": "2024-03-29"
    },
    {
      "value": {
        "name": "Purchaser2"
      },
      "effectivefrom": "2024-03-30",
      "effectiveto": null
    }
  ],
  "secondarypurchaser": [
    {
      "value": {
        "name": "Purchaser3"
      },
      "effectivefrom": "2024-02-29",
      "effectiveto": "2024-03-29"
    },
    {
      "value": {
        "name": "Purchaser4"
      },
      "effectivefrom": "2024-03-30",
      "effectiveto": null
    }
  ],
  "primarytransporter": [
    {
      "value": {
        "name": "Transporter1"
      },
      "effectivefrom": "2024-02-29",
      "effectiveto": "2024-03-29"
    },
    {
      "value": {
        "name": "Transporter2"
      },
      "effectivefrom": "2024-03-30",
      "effectiveto": null
    }
  ],
  "secondarytransporter": [
    {
      "value": {
        "name": "Transporter3"
      },
      "effectivefrom": "2024-02-29",
      "effectiveto": "2024-03-29"
    },
    {
      "value": {
        "name": "Transporter4"
      },
      "effectivefrom": "2024-03-30",
      "effectiveto": null
    }
  ],
  "userfieldvalues": {
    "Division": 2964,
    "Prospect": 2962,
    "BatteryName": 294,
    "AnyPicklist": [
      {
        "value": {
          "name": "name1"
        }
      }
    ],
    "AnyPicklistWithEffectiveDate": [
      {
        "value": {
          "name": "name1"
        },
        "effectivefrom": "2024-02-29",
        "effectiveto": null
      }
    ]
  },
  "xid": "17987"
}

Example 3 - with IDs and default effective values

CODE
{
  "code": "Well 1",
  "name": "Well 1",
  "description": "description of well",
  "isactive": true,
  "producingmethod": [
    {
      "value": {
        "id": 123
      }
    }
  ],
  "producingstatus": [
    {
      "value": {
        "id": 44345
      }
    }
  ],
  "producttype": [
    {
      "value": {
        "id": 4563
      }
    }
  ],
  "welltestrecurrence": 2,
  "latitude": 123.12356,
  "longitude": 123.123456,
  "stop": {
    "id": 1234
  },
  "welltype": [
    {
      "value": {
        "id": 5656
      }
    }
  ],
  "deliveryconfiguration": [
    {
      "value": {
        "id": 5656
      }
    }
  ],
  "seqnum": 1,
  "dailyreset": false,
  "primarypurchaser": [
    {
      "value": {
        "id": 5656
      }
    }
  ],
  "secondarypurchaser": [
    {
      "value": {
        "id": 5656
      }
    }
  ],
  "primarytransporter": [
    {
      "value": {
        "id": 5656
      }
    }
  ],
  "secondarytransporter": [
    {
      "value": {
        "id": 5656
      }
    }
  ],
  "userfieldvalues": {
    "Division": 2964,
    "Prospect": 2962,
    "BatteryName": 294,
    "AnyPicklist": [
      {
        "value": {
          "id": 1234
        }
      }
    ],
    "AnyPicklistWithEffectiveDate": [
      {
        "value": {
          "id": 1234
        }
      }
    ]
  },
  "xid": "17987"
}

Example 4 - with null values

CODE
{
  "id": 0,
  "code": null,
  "name": "Well 1",
  "description": null,
  "isactive": true,
  "welltype": null,
  "deliveryconfiguration": null,
  "dailyreset": false,
  "primarypurchaser": null,
  "secondarypurchaser": null,
  "primarytransporter": null,
  "secondarytransporter": null,
  "userfieldvalues": null,
  "xid": null,
  "userstring1": null,
  "userstring2": null,
  "userstring3": null,
  "userstring4": null,
  "userstring5": null,
  "userinteger1": null,
  "userinteger2": null,
  "userinteger3": null,
  "userinteger4": null,
  "userinteger5": null,
  "userdecimal1": null,
  "userdecimal2": null,
  "userdecimal3": null,
  "userdecimal4": null,
  "userdecimal5": null,
  "userdatetime1": null,
  "userdatetime2": null,
  "userdatetime3": null,
  "userdatetime4": null,
  "userdatetime5": null
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.