--- title: Get Multiple Wells slug: get-multiple-wells docTags: createdAt: 2023-05-03T20:15:30.000Z --- { "id": "CHukFlO8Afhq3HMiJIISl", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://data.onxecta.com/api/production/wells", "servers": [ { "url": "https://data.onxecta.com/api/production/wells", "description": "AWS Cloud API Endpoint" }, { "url": "http://localhost/api/production/wells", "description": "Local Testing API Endpoint" } ], "name": "Get Multiple Wells", "description": "This operation offers an optional paging facility if desired.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "offset", "type": "integer", "description": "", "format": "int32" }, { "kind": "optional", "name": "limit", "type": "integer", "description": "", "format": "int32" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "bearerAuth", "name": "bearerAuth", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "Well[]", "schema": [ { "name": "xid", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "sourceId", "kind": "required", "type": "string", "description": "" }, { "name": "uwi", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "group1", "kind": "optional", "type": "string", "nullable": true, "description": "

Group 1 - used for primary group navigation in the application

" }, { "name": "group2", "kind": "optional", "type": "string", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n

Group 2 - used for secondary sorting in the well tree and grouping in the application\nNOTE: This field has been deprecated and will be removed in January 2026.\nPlease use area, centralFacility, tankBattery, route, pad, platform to organize the well.

" }, { "name": "group3", "kind": "optional", "type": "string", "deprecated": true, "nullable": true, "description": "Warning: Deprecated\n

Group 3 - used for secondary sorting in the well tree and grouping in the application\nNOTE: This field has been deprecated and will be removed in January 2026.\nPlease use area, centralFacility, tankBattery, route, pad, platform to organize the well.

" }, { "name": "area", "kind": "optional", "type": "string", "nullable": true, "description": "

Sub-area of a field/asset defined by group1

" }, { "name": "centralFacility", "kind": "optional", "type": "string", "nullable": true, "description": "Central facility into which the well flows" }, { "name": "tankBattery", "kind": "optional", "type": "string", "nullable": true, "description": "Tank battery into which the well flows" }, { "name": "route", "kind": "optional", "type": "string", "nullable": true, "description": "Route on which the well is located" }, { "name": "pad", "kind": "optional", "type": "string", "nullable": true, "description": "

Pad (if applicable) on which the well is located

" }, { "name": "platform", "kind": "optional", "type": "string", "nullable": true, "description": "

Platform (if applicable) to which the well flows

" }, { "name": "heritage", "kind": "optional", "type": "string", "nullable": true, "description": "Heritage of the well" }, { "name": "responsibleEngineer", "kind": "optional", "type": "string", "nullable": true, "description": "Engineer responsible for the well" }, { "name": "type", "kind": "optional", "type": "string", "description": "

Well type: PRODUCER, INJECTOR

", "default": "PRODUCER", "modelRef": "#/components/schemas/WellType", "customType": "WellType", "schema": [] }, { "name": "fluid", "kind": "optional", "type": "string", "description": "", "default": "OIL", "modelRef": "#/components/schemas/FluidType", "customType": "FluidType", "schema": [] }, { "name": "liftType", "kind": "optional", "type": "string", "description": "

Current lift type of the well: NATURAL_FLOW, GAS_LIFT, ROD_PUMP, ESP, PLUNGER_LIFT, PLUNGER_ASSISTED_GAS_LIFT, GAS_ASSISTED_PLUNGER_LIFT, ANNULAR_NATURAL_FLOW, ANNULAR_GAS_LIFT, PCP, DUAL_NATURAL_FLOW

", "default": "NATURAL_FLOW", "modelRef": "#/components/schemas/LiftType", "customType": "LiftType", "schema": [] }, { "name": "lat", "kind": "required", "type": "number", "description": "", "format": "double" }, { "name": "lon", "kind": "required", "type": "number", "description": "", "format": "double" }, { "name": "mudLine", "kind": "optional", "type": "number", "nullable": true, "description": "", "format": "double" }, { "name": "middleLat", "kind": "optional", "type": "number", "nullable": true, "description": "

Optional middle coordinate (for maps). Frequently the lateral heel coordinates.

", "format": "double" }, { "name": "middleLon", "kind": "optional", "type": "number", "nullable": true, "description": "

Optional middle coordinate (for maps). Frequently the lateral heel coordinates.

", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "", "modelRef": "#/components/schemas/WellStatus", "customType": "WellStatus", "schema": [] }, { "name": "timezone", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "bottomholeLat", "kind": "optional", "type": "number", "nullable": true, "description": "", "format": "double" }, { "name": "bottomholeLon", "kind": "optional", "type": "number", "nullable": true, "description": "", "format": "double" } ], "modelRef": "#/components/schemas/Well", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "MPelZxAUPt-Ti4lQjP1bP", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://data.onxecta.com/api/production/wells \\\n --header 'accept: application/json'" }, { "id": "q9z-omcRxWQh6H7-TV58z", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://data.onxecta.com/api/production/wells\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "I7PobwORLfJvcM3bB7wlF", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://data.onxecta.com/api/production/wells\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "M7OSfq0kXt1jXPm0_LJh9", "language": "csharp", "label": "C#", "code": "var options = new RestClientOptions(\"https://data.onxecta.com\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"/api/production/wells\", Method.Get);\nrequest.AddHeader(\"accept\", \"application/json\");\nrequest.AddHeader(\"content-type\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" }, { "id": "W95iBhGA018uF3ZeGfJvQ", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://data.onxecta.com/api/production/wells\")\n .method(\"GET\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" } ], "selectedLanguageId": "MPelZxAUPt-Ti4lQjP1bP" }, "results": { "languages": [ { "id": "vyRwBT-wZHKmO0LQoat9T", "language": "200", "code": "// OK\n[\n {\n \"xid\": \"\",\n \"sourceId\": \"\",\n \"uwi\": \"\",\n \"name\": \"\",\n \"group1\": \"\",\n \"group2\": \"\",\n \"group3\": \"\",\n \"area\": \"\",\n \"centralFacility\": \"\",\n \"tankBattery\": \"\",\n \"route\": \"\",\n \"pad\": \"\",\n \"platform\": \"\",\n \"heritage\": \"\",\n \"responsibleEngineer\": \"\",\n \"type\": \"\",\n \"fluid\": \"\",\n \"liftType\": \"\",\n \"lat\": \"\",\n \"lon\": \"\",\n \"mudLine\": \"\",\n \"middleLat\": \"\",\n \"middleLon\": \"\",\n \"status\": \"\",\n \"timezone\": \"\",\n \"bottomholeLat\": \"\",\n \"bottomholeLon\": \"\"\n }\n]" } ], "selectedLanguageId": "vyRwBT-wZHKmO0LQoat9T" } }, "children": [ { "text": "" } ] }