deleteBoardTimepoints
delete board data for a given time period.
/board/{id}/timepoints
Usage and SDK Samples
curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
-H "Authorization: Bearer [[accessToken]]" \
"https://localhost:16009/api/v1/board/{id}/timepoints?fromDate=56&endDate=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardDataApi;
import java.io.File;
import java.util.*;
public class BoardDataApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
// Configure Bearer (JWT) access token for authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
// Create an instance of the API class
BoardDataApi apiInstance = new BoardDataApi();
UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID |
Integer fromDate = 56; // Integer |
Integer endDate = 56; // Integer |
try {
apiInstance.deleteBoardTimepoints(id, fromDate, endDate);
} catch (ApiException e) {
System.err.println("Exception when calling BoardDataApi#deleteBoardTimepoints");
e.printStackTrace();
}
}
}
import org.openapitools.client.api.BoardDataApi;
public class BoardDataApiExample {
public static void main(String[] args) {
BoardDataApi apiInstance = new BoardDataApi();
UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID |
Integer fromDate = 56; // Integer |
Integer endDate = 56; // Integer |
try {
apiInstance.deleteBoardTimepoints(id, fromDate, endDate);
} catch (ApiException e) {
System.err.println("Exception when calling BoardDataApi#deleteBoardTimepoints");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];
// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Create an instance of the API class
BoardDataApi *apiInstance = [[BoardDataApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // (default to null)
Integer *fromDate = 56; // (optional) (default to null)
Integer *endDate = 56; // (optional) (default to null)
// delete board data for a given time period.
[apiInstance deleteBoardTimepointsWith:id
fromDate:fromDate
endDate:endDate
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";
// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardDataApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID}
var opts = {
'fromDate': 56, // {Integer}
'endDate': 56 // {Integer}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.deleteBoardTimepoints(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class deleteBoardTimepointsExample
{
public void main()
{
// Configure API key authorization: ApiKeyAuth
Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
// Configure Bearer (JWT) access token for authorization: bearerAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Create an instance of the API class
var apiInstance = new BoardDataApi();
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | (default to null)
var fromDate = 56; // Integer | (optional) (default to null)
var endDate = 56; // Integer | (optional) (default to null)
try {
// delete board data for a given time period.
apiInstance.deleteBoardTimepoints(id, fromDate, endDate);
} catch (Exception e) {
Debug.Print("Exception when calling BoardDataApi.deleteBoardTimepoints: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');
// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardDataApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID |
$fromDate = 56; // Integer |
$endDate = 56; // Integer |
try {
$api_instance->deleteBoardTimepoints($id, $fromDate, $endDate);
} catch (Exception $e) {
echo 'Exception when calling BoardDataApi->deleteBoardTimepoints: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardDataApi;
# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";
# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardDataApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID |
my $fromDate = 56; # Integer |
my $endDate = 56; # Integer |
eval {
$api_instance->deleteBoardTimepoints(id => $id, fromDate => $fromDate, endDate => $endDate);
};
if ($@) {
warn "Exception when calling BoardDataApi->deleteBoardTimepoints: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Create an instance of the API class
api_instance = openapi_client.BoardDataApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | (default to null)
fromDate = 56 # Integer | (optional) (default to null)
endDate = 56 # Integer | (optional) (default to null)
try:
# delete board data for a given time period.
api_instance.delete_board_timepoints(id, fromDate=fromDate, endDate=endDate)
except ApiException as e:
print("Exception when calling BoardDataApi->deleteBoardTimepoints: %s\n" % e)
extern crate BoardDataApi;
pub fn main() {
let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
let fromDate = 56; // Integer
let endDate = 56; // Integer
let mut context = BoardDataApi::Context::default();
let result = client.deleteBoardTimepoints(id, fromDate, endDate, &context).wait();
println!("{:?}", result);
}
Scopes
Parameters
Name | Description |
---|---|
id* |
UUID
(uuid)
Required
|
Name | Description |
---|---|
fromDate |
Integer
|
endDate |
Integer
|