Nexosis Api

API change history

Datasets: Delete data

Removes data from a particular dataset

If a range is specified, using either date range for time series data, or key range for an orderable key, then only data in that date range is removed from the dataset. Otherwise, all data is removed from the dataset.

Try it

Request URL

Request parameters

string

Name of the dataset from which to remove data

(optional)
string

Format - date-time (as date-time in ISO8601). Limits data removed to those on or after the specified date for time series datasets

(optional)
string

Format - date-time (as date-time in ISO8601). Limits data removed to those on or before the specified date for time series datasets

(optional)
string

Limits data removed to those on or after the specified key, when using an orderable key

(optional)
string

Limits data removed to those on or before the specified key, when using an orderable key

(optional)
array

Limits data removed to rows that match the provided keys

(optional)
array

Options for cascading the delete.
When cascade=forecast, also deletes forecasts for the dataset.
When cascade=session, also deletes sessions associated with the dataset. If start and/or end date are supplied, sessions requested in that date range are deleted. When cascade=model, also deletes models associated with the dataset.

Request headers

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

Request body

Response 204

Response 400

One or more parameters are invalid

{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "startDate": [
      "Value for startDate must be a valid date"
    ]
  }
}
{
  "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": {
    "startDate": [
      "Value for startDate must be a valid date"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Response 404

Specified dataset was not found

{
  "statusCode": 404,
  "message": "Item of type dataSet with identifier Location-A was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "dataSet",
    "itemId": "Location-A"
  }
}
{
  "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 dataSet with identifier Location-A was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "dataSet",
    "itemId": "Location-A"
  }
}
{
  "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 DELETE "https://ml.nexosis.com/v1/data/{dataSetName}?startDate=01/01/2013 00:00:00&endDate=01/05/2013 00:00:00&startKey={string}&endKey={string}&keys={array}&cascade=forecast"
-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}");

            // Request parameters
            queryString["startDate"] = "01/01/2013 00:00:00";
            queryString["endDate"] = "01/05/2013 00:00:00";
            queryString["startKey"] = "{string}";
            queryString["endKey"] = "{string}";
            queryString["keys"] = "{array}";
            queryString["cascade"] = "forecast";
            var uri = "https://ml.nexosis.com/v1/data/{dataSetName}?" + queryString;

            var response = await client.DeleteAsync(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/data/{dataSetName}");

            builder.setParameter("startDate", "01/01/2013 00:00:00");
            builder.setParameter("endDate", "01/05/2013 00:00:00");
            builder.setParameter("startKey", "{string}");
            builder.setParameter("endKey", "{string}");
            builder.setParameter("keys", "{array}");
            builder.setParameter("cascade", "forecast");

            URI uri = builder.build();
            HttpDelete request = new HttpDelete(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
            "startDate": "01/01/2013 00:00:00",
            "endDate": "01/05/2013 00:00:00",
            "startKey": "{string}",
            "endKey": "{string}",
            "keys": "{array}",
            "cascade": "forecast",
        };
      
        $.ajax({
            url: "https://ml.nexosis.com/v1/data/{dataSetName}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("api-key","{subscription key}");
            },
            type: "DELETE",
            // 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/data/{dataSetName}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"startDate=01/01/2013 00:00:00",
                         @"endDate=01/05/2013 00:00:00",
                         @"startKey={string}",
                         @"endKey={string}",
                         @"keys={array}",
                         @"cascade=forecast",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"DELETE"];
    // 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/data/{dataSetName}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'startDate' => '01/01/2013 00:00:00',
    'endDate' => '01/05/2013 00:00:00',
    'startKey' => '{string}',
    'endKey' => '{string}',
    'keys' => '{array}',
    'cascade' => 'forecast',
);

$url->setQueryVariables($parameters);

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

// 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({
    # Request parameters
    'startDate': '01/01/2013 00:00:00',
    'endDate': '01/05/2013 00:00:00',
    'startKey': '{string}',
    'endKey': '{string}',
    'keys': '{array}',
    'cascade': 'forecast',
})

try:
    conn = httplib.HTTPSConnection('ml.nexosis.com')
    conn.request("DELETE", "/v1/data/{dataSetName}?%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({
    # Request parameters
    'startDate': '01/01/2013 00:00:00',
    'endDate': '01/05/2013 00:00:00',
    'startKey': '{string}',
    'endKey': '{string}',
    'keys': '{array}',
    'cascade': 'forecast',
})

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

query = URI.encode_www_form({
    # Request parameters
    'startDate' => '01/01/2013 00:00:00',
    'endDate' => '01/05/2013 00:00:00',
    'startKey' => '{string}',
    'endKey' => '{string}',
    'keys' => '{array}',
    'cascade' => 'forecast'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Delete.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