Nexosis Api

API change history

Imports: Retrieve Import

Retrieve information about request to import data into Axon

Try it

Request URL

Request parameters

string

Format - uuid. The Id of the Import

Request headers

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

Request body

Response 200

Success

{
  "importId": "36f7109e-c417-4e8f-aea6-65891d21d7d9",
  "type": "s3",
  "status": "requested",
  "dataSetName": "Location-A",
  "parameters": {
    "bucket": "nexosis-sample-data",
    "path": "LocationA.csv"
  },
  "requestedDate": "2017-10-17T18:06:05.259039+00:00",
  "statusHistory": [],
  "messages": [],
  "columns": {},
  "links": []
}
{
  "type": "object",
  "properties": {
    "importId": {
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "enum": [
        "s3"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "requested",
        "started",
        "completed",
        "cancelled",
        "failed",
        "estimated"
      ],
      "type": "string"
    },
    "dataSetName": {
      "type": "string"
    },
    "parameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "requestedDate": {
      "format": "date-time",
      "type": "string"
    },
    "statusHistory": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "requested",
              "started",
              "completed",
              "cancelled",
              "failed",
              "estimated"
            ],
            "type": "string"
          }
        }
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "informational",
              "warning",
              "error",
              "debug"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "columns": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      },
      "readOnly": true
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}
{
  "importId": "36f7109e-c417-4e8f-aea6-65891d21d7d9",
  "type": "s3",
  "status": "requested",
  "dataSetName": "Location-A",
  "parameters": {
    "bucket": "nexosis-sample-data",
    "path": "LocationA.csv"
  },
  "requestedDate": "2017-10-17T18:06:05.259039+00:00",
  "statusHistory": [],
  "messages": [],
  "columns": {},
  "links": []
}
{
  "type": "object",
  "properties": {
    "importId": {
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "enum": [
        "s3"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "requested",
        "started",
        "completed",
        "cancelled",
        "failed",
        "estimated"
      ],
      "type": "string"
    },
    "dataSetName": {
      "type": "string"
    },
    "parameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "requestedDate": {
      "format": "date-time",
      "type": "string"
    },
    "statusHistory": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "requested",
              "started",
              "completed",
              "cancelled",
              "failed",
              "estimated"
            ],
            "type": "string"
          }
        }
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "informational",
              "warning",
              "error",
              "debug"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "columns": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      },
      "readOnly": true
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}

Response 400

badrequest

{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "importId": [
      "Value for importId must be a valid GUID"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "importId": [
      "Value for importId must be a valid GUID"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Response 404

notfound

{
  "statusCode": 404,
  "message": "Item of type import with identifier 36f7109e-c417-4e8f-aea6-65891d21d7d9 was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "import",
    "itemId": "36f7109e-c417-4e8f-aea6-65891d21d7d9"
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 404,
  "message": "Item of type import with identifier 36f7109e-c417-4e8f-aea6-65891d21d7d9 was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "import",
    "itemId": "36f7109e-c417-4e8f-aea6-65891d21d7d9"
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://ml.nexosis.com/v1/imports/{importId}"
-H "api-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("api-key", "{subscription key}");

            var uri = "https://ml.nexosis.com/v1/imports/{importId}?" + 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://ml.nexosis.com/v1/imports/{importId}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("api-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
        };
      
        $.ajax({
            url: "https://ml.nexosis.com/v1/imports/{importId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("api-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://ml.nexosis.com/v1/imports/{importId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    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:@"api-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://ml.nexosis.com/v1/imports/{importId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'api-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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
    'api-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('ml.nexosis.com')
    conn.request("GET", "/v1/imports/{importId}?%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
    'api-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('ml.nexosis.com')
    conn.request("GET", "/v1/imports/{importId}?%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://ml.nexosis.com/v1/imports/{importId}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['api-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