View on GitHub

amber-csharp-sdk

Boon Amber C# SDK

BoonAmber.Api.DefaultApi

All URIs are relative to http://amber.boonlogic.com/v1

Method HTTP request Description
DeleteSensor DELETE /sensor Delete a sensor instance
GetAmberSummary GET /__summary Get the JSON block of the amber image
GetConfig GET /config Get the current configuration of a sensor instance
GetPretrain GET /pretrain Get status of pretrain operation
GetRootCause GET /rootCause Get root cause analysis information from a sensor
GetSensor GET /sensor Get basic information about a sensor instance
GetSensors GET /sensors List all sensors for this user
GetStatus GET /status Get analytic information from a sensor
GetVersion GET /version Retrieves API version information
PostConfig POST /config Apply configuration to a sensor instance
PostOauth2 POST /oauth2 Request a bearer token using Amber account credentials
PostOutage POST /outage Informs the server of an outage
PostPretrain POST /pretrain Pretrain a sensor using historical data
PostSensor POST /sensor Create a new a sensor instance
PostStream POST /stream Stream data to a sensor
PutConfig PUT /config Update configuration for a sensor instance
PutSensor PUT /sensor Update label for a sensor instance
PutStream PUT /stream Stream data to a sensor fusion vector

DeleteSensor

Error DeleteSensor (string sensorId)

Delete a sensor instance

Deletes the sensor instance with the specified sensorId.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class DeleteSensorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor

            try
            {
                // Delete a sensor instance
                Error result = apiInstance.DeleteSensor(sensorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.DeleteSensor: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteSensorWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete a sensor instance
    ApiResponse<Error> response = apiInstance.DeleteSensorWithHttpInfo(sensorId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.DeleteSensorWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  

Return type

Error

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAmberSummary

GetSummaryResponse GetAmberSummary (string sensorId)

Get the JSON block of the amber image

Returns the json block of the amber sensor

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class GetAmberSummaryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor

            try
            {
                // Get the JSON block of the amber image
                GetSummaryResponse result = apiInstance.GetAmberSummary(sensorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetAmberSummary: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetAmberSummaryWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get the JSON block of the amber image
    ApiResponse<GetSummaryResponse> response = apiInstance.GetAmberSummaryWithHttpInfo(sensorId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetAmberSummaryWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  

Return type

GetSummaryResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetConfig

GetConfigResponse GetConfig (string sensorId)

Get the current configuration of a sensor instance

Returns the current configuration of the sensor instance specified.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class GetConfigExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor

            try
            {
                // Get the current configuration of a sensor instance
                GetConfigResponse result = apiInstance.GetConfig(sensorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetConfig: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetConfigWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get the current configuration of a sensor instance
    ApiResponse<GetConfigResponse> response = apiInstance.GetConfigWithHttpInfo(sensorId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetConfigWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  

Return type

GetConfigResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPretrain

GetPretrainResponse GetPretrain (string sensorId)

Get status of pretrain operation

Get status of a sensor which is currently pretraining.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class GetPretrainExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor

            try
            {
                // Get status of pretrain operation
                GetPretrainResponse result = apiInstance.GetPretrain(sensorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetPretrain: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetPretrainWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get status of pretrain operation
    ApiResponse<GetPretrainResponse> response = apiInstance.GetPretrainWithHttpInfo(sensorId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetPretrainWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  

Return type

GetPretrainResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Sensor is not pretraining | - | | 202 | Sensor is currently pretraining | - | | 400 | Bad request | - | | 500 | Internal server error | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRootCause

GetRootCauseResponse GetRootCause (string sensorId, string? clusterID = null, string? pattern = null)

Get root cause analysis information from a sensor

Returns analytic information on the root cause for the clusters provided.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class GetRootCauseExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor
            var clusterID = "clusterID_example";  // string? | An array of cluster IDs (optional) 
            var pattern = "pattern_example";  // string? | Patterns to compare to the nano model for the root cause analysis (optional) 

            try
            {
                // Get root cause analysis information from a sensor
                GetRootCauseResponse result = apiInstance.GetRootCause(sensorId, clusterID, pattern);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetRootCause: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetRootCauseWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get root cause analysis information from a sensor
    ApiResponse<GetRootCauseResponse> response = apiInstance.GetRootCauseWithHttpInfo(sensorId, clusterID, pattern);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetRootCauseWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  
clusterID string? An array of cluster IDs [optional]
pattern string? Patterns to compare to the nano model for the root cause analysis [optional]

Return type

GetRootCauseResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 500 | Internal server error | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSensor

GetSensorResponse GetSensor (string sensorId)

Get basic information about a sensor instance

Returns basic information about an existing sensor instance.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class GetSensorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor

            try
            {
                // Get basic information about a sensor instance
                GetSensorResponse result = apiInstance.GetSensor(sensorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetSensor: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetSensorWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get basic information about a sensor instance
    ApiResponse<GetSensorResponse> response = apiInstance.GetSensorWithHttpInfo(sensorId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetSensorWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  

Return type

GetSensorResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSensors

GetSensorsResponse GetSensors ()

List all sensors for this user

Returns a list of all current sensor instances for this user.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class GetSensorsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);

            try
            {
                // List all sensors for this user
                GetSensorsResponse result = apiInstance.GetSensors();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetSensors: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetSensorsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List all sensors for this user
    ApiResponse<GetSensorsResponse> response = apiInstance.GetSensorsWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetSensorsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

GetSensorsResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStatus

GetStatusResponse GetStatus (string sensorId)

Get analytic information from a sensor

Returns analytic information derived from data processed by a sensor thus far.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class GetStatusExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor

            try
            {
                // Get analytic information from a sensor
                GetStatusResponse result = apiInstance.GetStatus(sensorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetStatus: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetStatusWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get analytic information from a sensor
    ApiResponse<GetStatusResponse> response = apiInstance.GetStatusWithHttpInfo(sensorId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetStatusWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  

Return type

GetStatusResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVersion

ModelVersion GetVersion ()

Retrieves API version information

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class GetVersionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);

            try
            {
                // Retrieves API version information
                ModelVersion result = apiInstance.GetVersion();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetVersion: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetVersionWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieves API version information
    ApiResponse<ModelVersion> response = apiInstance.GetVersionWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetVersionWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

ModelVersion

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Success, version information returned | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostConfig

PostConfigResponse PostConfig (string sensorId, PostConfigRequest postConfigRequest)

Apply configuration to a sensor instance

Applies the provided configuration to the sensor instance specified.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PostConfigExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor
            var postConfigRequest = new PostConfigRequest(); // PostConfigRequest | Sensor configuration to be applied

            try
            {
                // Apply configuration to a sensor instance
                PostConfigResponse result = apiInstance.PostConfig(sensorId, postConfigRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PostConfig: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PostConfigWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Apply configuration to a sensor instance
    ApiResponse<PostConfigResponse> response = apiInstance.PostConfigWithHttpInfo(sensorId, postConfigRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PostConfigWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  
postConfigRequest PostConfigRequest Sensor configuration to be applied  

Return type

PostConfigResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - | | 503 | Server busy | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostOauth2

PostAuth2Response PostOauth2 (PostAuth2Request postAuth2Request)

Request a bearer token using Amber account credentials

Requests a bearer token using Amber account credentials. The requested bearer token is returned as the "id-token" response attribute. This token is to be used for authenticating API requests throughout a usage session and expires after 60 minutes.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PostOauth2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            var apiInstance = new DefaultApi(config);
            var postAuth2Request = new PostAuth2Request(); // PostAuth2Request | Account credentials to be used for authentication

            try
            {
                // Request a bearer token using Amber account credentials
                PostAuth2Response result = apiInstance.PostOauth2(postAuth2Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PostOauth2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PostOauth2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Request a bearer token using Amber account credentials
    ApiResponse<PostAuth2Response> response = apiInstance.PostOauth2WithHttpInfo(postAuth2Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PostOauth2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
postAuth2Request PostAuth2Request Account credentials to be used for authentication  

Return type

PostAuth2Response

Authorization

No authorization required

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 401 | Unauthorized | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostOutage

PostOutageResponse PostOutage (string sensorId)

Informs the server of an outage

Clears the load buffer of streaming window and resets statistics. Returns stream status

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PostOutageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor

            try
            {
                // Informs the server of an outage
                PostOutageResponse result = apiInstance.PostOutage(sensorId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PostOutage: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PostOutageWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Informs the server of an outage
    ApiResponse<PostOutageResponse> response = apiInstance.PostOutageWithHttpInfo(sensorId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PostOutageWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  

Return type

PostOutageResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostPretrain

PostPretrainResponse PostPretrain (string sensorId, PostPretrainRequest postPretrainRequest, string? amberChunk = null, string? amberTransaction = null)

Pretrain a sensor using historical data

Pretrains a sensor. Ingoing data should be formatted as a simple string of comma-separated numbers with no spaces.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PostPretrainExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor
            var postPretrainRequest = new PostPretrainRequest(); // PostPretrainRequest | Data to be streamed to sensor. Should be formatted as a simple string of comma-separated numbers with no spaces (e.g. \"0,0.5,1,1.5,2\").
            var amberChunk = "amberChunk_example";  // string? | Specification of chunk, 1:3 2:3 3:3 for example (optional) 
            var amberTransaction = "amberTransaction_example";  // string? | Unique identifier for chunk transactions (optional) 

            try
            {
                // Pretrain a sensor using historical data
                PostPretrainResponse result = apiInstance.PostPretrain(sensorId, postPretrainRequest, amberChunk, amberTransaction);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PostPretrain: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PostPretrainWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Pretrain a sensor using historical data
    ApiResponse<PostPretrainResponse> response = apiInstance.PostPretrainWithHttpInfo(sensorId, postPretrainRequest, amberChunk, amberTransaction);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PostPretrainWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  
postPretrainRequest PostPretrainRequest Data to be streamed to sensor. Should be formatted as a simple string of comma-separated numbers with no spaces (e.g. \"0,0.5,1,1.5,2\").  
amberChunk string? Specification of chunk, 1:3 2:3 3:3 for example [optional]
amberTransaction string? Unique identifier for chunk transactions [optional]

Return type

PostPretrainResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 202 | Operation was accepted | * amberTransaction -
| | 400 | Bad request | - | | 500 | Internal server error | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 503 | Server is busy | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostSensor

PostSensorResponse PostSensor (PostSensorRequest postSensorRequest)

Create a new a sensor instance

Spawns a new sensor instance, returning its unique sensorId.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PostSensorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var postSensorRequest = new PostSensorRequest(); // PostSensorRequest | Label for new sensor instance to be created

            try
            {
                // Create a new a sensor instance
                PostSensorResponse result = apiInstance.PostSensor(postSensorRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PostSensor: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PostSensorWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create a new a sensor instance
    ApiResponse<PostSensorResponse> response = apiInstance.PostSensorWithHttpInfo(postSensorRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PostSensorWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
postSensorRequest PostSensorRequest Label for new sensor instance to be created  

Return type

PostSensorResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostStream

PostStreamResponse PostStream (string sensorId, PostStreamRequest postStreamRequest)

Stream data to a sensor

Sends data to a sensor. Ingoing data should be formatted as a simple string of comma-separated numbers with no spaces. The following analytic results are returned: - state : sensor state as of this call (one of: "Buffering", "Autotuning", "Learning", "Monitoring", "Error") - ID : array of cluster IDs. These correspond one-to-one with input samples, indicating the cluster to which each input pattern was assigned. - SI : array of smoothed anomaly index values. These values correspond one-to-one with the input samples and range between 0 and 1000. Values closer to 0 represent input patterns which are ordinary given the data seen so far on this sensor. Values closer to 1000 represent novel patterns which are anomalous with respect to data seen before. - AD : array of 0’s and 1’s as anomaly detection indicators. These correspond one-to-one with input samples and are produced by thresholding the smoothed anomaly index (SI). The threshold is determined automatically from the SI values. A value of 0 indicates that the SI has not exceeded the anomaly detection threshold. A value of 1 indicates it has, signaling an anomaly at the corresponding input sample. - AH : array of anomaly history values. These values are a moving-window sum of the AD, giving the number of anomaly detections (1’s) present in the AD signal over a "recent history" window whose length is the buffer size. - AM : array of Amber Metric values. These are floating-point values between 0.0 and 1.0 indicating the extent to which the AH contains an unusually high number of anomalies in recent history. The values are derived statistically from a Poisson model, with values close to 0.0 signaling a lower, and values close to 1.0 signaling a higher, frequency of anomalies than usual. - AW : array of Amber Warning Level values. This index is produced by thresholding the Amber Metric (AM) and takes on the values 0, 1 or 2 representing a discrete "warning level" for an asset based on the frequency of anomalies within recent history. 0 = normal, 1 = asset changing, 2 = asset critical. The default thresholds for the two warning levels are the standard statistical values of 0.95 (outlier, asset chaing) and 0.997 (extreme outlier, asset critical).

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PostStreamExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor
            var postStreamRequest = new PostStreamRequest(); // PostStreamRequest | Data to be streamed to sensor. Should be formatted as a simple string of comma-separated numbers with no spaces (e.g. \"0,0.5,1,1.5,2\").

            try
            {
                // Stream data to a sensor
                PostStreamResponse result = apiInstance.PostStream(sensorId, postStreamRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PostStream: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PostStreamWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Stream data to a sensor
    ApiResponse<PostStreamResponse> response = apiInstance.PostStreamWithHttpInfo(sensorId, postStreamRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PostStreamWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  
postStreamRequest PostStreamRequest Data to be streamed to sensor. Should be formatted as a simple string of comma-separated numbers with no spaces (e.g. \"0,0.5,1,1.5,2\").  

Return type

PostStreamResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - | | 503 | Server busy | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutConfig

PutConfigResponse PutConfig (string sensorId, PutConfigRequest putConfigRequest)

Update configuration for a sensor instance

Updates the configuration for the sensor instance specified.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PutConfigExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor
            var putConfigRequest = new PutConfigRequest(); // PutConfigRequest | Updates to sensor configuration

            try
            {
                // Update configuration for a sensor instance
                PutConfigResponse result = apiInstance.PutConfig(sensorId, putConfigRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PutConfig: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PutConfigWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Update configuration for a sensor instance
    ApiResponse<PutConfigResponse> response = apiInstance.PutConfigWithHttpInfo(sensorId, putConfigRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PutConfigWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  
putConfigRequest PutConfigRequest Updates to sensor configuration  

Return type

PutConfigResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - | | 503 | Server busy | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutSensor

PutSensorResponse PutSensor (string sensorId, PutSensorRequest putSensorRequest)

Update label for a sensor instance

Changes the label of an existing sensor instance to the new label specified.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PutSensorExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor
            var putSensorRequest = new PutSensorRequest(); // PutSensorRequest | New label to apply to sensor instance

            try
            {
                // Update label for a sensor instance
                PutSensorResponse result = apiInstance.PutSensor(sensorId, putSensorRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PutSensor: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PutSensorWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Update label for a sensor instance
    ApiResponse<PutSensorResponse> response = apiInstance.PutSensorWithHttpInfo(sensorId, putSensorRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PutSensorWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  
putSensorRequest PutSensorRequest New label to apply to sensor instance  

Return type

PutSensorResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Operation was successful | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutStream

PutStreamResponse PutStream (string sensorId, PutStreamRequest putStreamRequest)

Stream data to a sensor fusion vector

Update fusion vector with new values for the given features, and optionally submit to Amber. Analytic results returned are the same as POST /stream.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BoonAmber.Api;
using BoonAmber.Client;
using BoonAmber.Model;

namespace Example
{
    public class PutStreamExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://amber.boonlogic.com/v1";
            // Configure API key authorization: authorize-amber-pool
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new DefaultApi(config);
            var sensorId = "sensorId_example";  // string | Unique identifier for sensor
            var putStreamRequest = new PutStreamRequest(); // PutStreamRequest | New values for sensor fusion vector.

            try
            {
                // Stream data to a sensor fusion vector
                PutStreamResponse result = apiInstance.PutStream(sensorId, putStreamRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.PutStream: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PutStreamWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Stream data to a sensor fusion vector
    ApiResponse<PutStreamResponse> response = apiInstance.PutStreamWithHttpInfo(sensorId, putStreamRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PutStreamWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sensorId string Unique identifier for sensor  
putStreamRequest PutStreamRequest New values for sensor fusion vector.  

Return type

PutStreamResponse

Authorization

authorize-amber-pool

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Vector has been updated and analytics were run. | - | | 202 | Vector has been updated but no analytics were run. | - | | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | The specified resource was not found | - | | 500 | Internal server error | - | | 503 | Server busy | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]