eLynx API

API change history

Public eLynx API

QueryWells

Queries for wells.

You may specify one or more wells by using the wellIds parameter, or you may filter the well results by using the apiNumber, name, and/or organizationId parameters. Only wells matching all filter parameters will be returned.

Additionally, you may request related object information using the include parameter.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    When specified, limits results to only wells with a matching API Number.

  • (optional)
    string

    Only meaningful when the attributes include is used. This is a comma separated list of attributes schema ids. When specified, this limits the attributes that will be returned.

  • (optional)
    string

    Only meaningful when the tags include is used. This is a comma separated list of data classification codes. When specified, this limits the tags that are returned. If not specified, all tags will be returned.

  • (optional)
    string

    A comma separated list of related objects to return. Currently supports: attributes, geo, liftType, and tags.

  • (optional)
    string

    When specified, limits the results to only wells with a matching name.

  • (optional)
    string

    When specified, limits the results to only wells for the given organization.

  • (optional)
    number

    The page of results to return. Defaults to 1.

  • (optional)
    number

    The number of wells to include on each page.

  • (optional)
    string

    The type of text matching to perform when supplying a deviceIdentifier, deviceName, or externalId. Available options are Exact, Contains, StartsWith, EndsWith, DoesNotContain, and DoesNotMatch. If no value is supplied Exact is used.

  • (optional)
    string

    A comma separated list of well ids to return. When specified, other filter parameters are ignored.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Success

Code samples

@ECHO OFF

curl -v -X GET "https://api-dev.elynxtech.com/v1/query-wells?apiNumber={string}&attributeSchemaIds={string}&dataClassificationCodes={string}&include={string}&name={string}&organizationId={string}&pageNumber={number}&pageSize={number}&textMatchStyle={string}&wellIds={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["apiNumber"] = "{string}";
            queryString["attributeSchemaIds"] = "{string}";
            queryString["dataClassificationCodes"] = "{string}";
            queryString["include"] = "{string}";
            queryString["name"] = "{string}";
            queryString["organizationId"] = "{string}";
            queryString["pageNumber"] = "{number}";
            queryString["pageSize"] = "{number}";
            queryString["textMatchStyle"] = "{string}";
            queryString["wellIds"] = "{string}";
            var uri = "https://api-dev.elynxtech.com/v1/query-wells?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api-dev.elynxtech.com/v1/query-wells");

            builder.setParameter("apiNumber", "{string}");
            builder.setParameter("attributeSchemaIds", "{string}");
            builder.setParameter("dataClassificationCodes", "{string}");
            builder.setParameter("include", "{string}");
            builder.setParameter("name", "{string}");
            builder.setParameter("organizationId", "{string}");
            builder.setParameter("pageNumber", "{number}");
            builder.setParameter("pageSize", "{number}");
            builder.setParameter("textMatchStyle", "{string}");
            builder.setParameter("wellIds", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "apiNumber": "{string}",
            "attributeSchemaIds": "{string}",
            "dataClassificationCodes": "{string}",
            "include": "{string}",
            "name": "{string}",
            "organizationId": "{string}",
            "pageNumber": "{number}",
            "pageSize": "{number}",
            "textMatchStyle": "{string}",
            "wellIds": "{string}",
        };
      
        $.ajax({
            url: "https://api-dev.elynxtech.com/v1/query-wells?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api-dev.elynxtech.com/v1/query-wells";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"apiNumber={string}",
                         @"attributeSchemaIds={string}",
                         @"dataClassificationCodes={string}",
                         @"include={string}",
                         @"name={string}",
                         @"organizationId={string}",
                         @"pageNumber={number}",
                         @"pageSize={number}",
                         @"textMatchStyle={string}",
                         @"wellIds={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api-dev.elynxtech.com/v1/query-wells');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'apiNumber' => '{string}',
    'attributeSchemaIds' => '{string}',
    'dataClassificationCodes' => '{string}',
    'include' => '{string}',
    'name' => '{string}',
    'organizationId' => '{string}',
    'pageNumber' => '{number}',
    'pageSize' => '{number}',
    'textMatchStyle' => '{string}',
    'wellIds' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'apiNumber': '{string}',
    'attributeSchemaIds': '{string}',
    'dataClassificationCodes': '{string}',
    'include': '{string}',
    'name': '{string}',
    'organizationId': '{string}',
    'pageNumber': '{number}',
    'pageSize': '{number}',
    'textMatchStyle': '{string}',
    'wellIds': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api-dev.elynxtech.com')
    conn.request("GET", "/v1/query-wells?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'apiNumber': '{string}',
    'attributeSchemaIds': '{string}',
    'dataClassificationCodes': '{string}',
    'include': '{string}',
    'name': '{string}',
    'organizationId': '{string}',
    'pageNumber': '{number}',
    'pageSize': '{number}',
    'textMatchStyle': '{string}',
    'wellIds': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api-dev.elynxtech.com')
    conn.request("GET", "/v1/query-wells?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api-dev.elynxtech.com/v1/query-wells')

query = URI.encode_www_form({
    # Request parameters
    'apiNumber' => '{string}',
    'attributeSchemaIds' => '{string}',
    'dataClassificationCodes' => '{string}',
    'include' => '{string}',
    'name' => '{string}',
    'organizationId' => '{string}',
    'pageNumber' => '{number}',
    'pageSize' => '{number}',
    'textMatchStyle' => '{string}',
    'wellIds' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body