wearTell

AnomalyDetection

createAnomalyDetection

Create new anomaly detection.


Path:

post 
/projects/{project}/anomaly_detections

Parameters:

Path parameters
Name Description
project*
String
The name of the project to create the anomaly detection for.
Body parameters
Name Description
createAnomalyDetection *

Responses:

200

404

409

500

deleteAnomalyDetection

Delete the anomaly detection with the specified id. Only waiting or inactive anomaly detections can be deleted.


Path:

delete 
/projects/{project}/anomaly_detections/{id}

Parameters:

Path parameters
Name Description
project*
String
The name of the project to delete the anomaly detection for.
id*
Integer
Anomaly detection id

Responses:

200

404

409

500

getAnomalies

Get all existing anomalies.


Path:

get 
/projects/{project}/anomalies

Parameters:

Path parameters
Name Description
project*
String
The name of the project to get the detected anomalies for.
Query parameters
Name Description
anomaly_detection_id*
Integer
The id of the anomaly detection to filter the detected anomalies for.

Responses:

200

404

500

getAnomalyDetectionTrainingCycles

Get the cycles used for training. If the anomaly detection is not yet trained, an appropriate error is returned.


Path:

get 
/projects/{project}/anomaly_detections/{id}/training_cycles

Parameters:

Path parameters
Name Description
project*
String
The name of the project the anomaly detection belongs to.
id*
Integer
The id of the anomaly detection in question.

Responses:

200

404

500

getAnomalyDetections

Get all existing anomaly detections.


Path:

get 
/projects/{project}/anomaly_detections

Parameters:

Path parameters
Name Description
project*
String
The name of the project to get the anomaly detections for.

Responses:

200

404

500

setAnomalyDetectionState

Update the state of the anomaly detection. This is used to activate or deactivate an anomaly detection. Possible state transitions are from active to inactive and back, as well as from active or inactive to training - this triggers a retraining of the anomaly detection.


Path:

post 
/projects/{project}/anomaly_detections/{id}/state

Parameters:

Path parameters
Name Description
project*
String
The name of the project the anomaly detection belongs to.
id*
Integer
The id of the anomaly detection in question.
Body parameters
Name Description
inlineObject1 *

Responses:

200

400

404

500

setAnomalyFeedbackState

Provide feedback on an anomaly state.


Path:

post 
/projects/{project}/anomalies/{id}/feedback_state

Parameters:

Path parameters
Name Description
project*
String
The name of the project the anomaly belongs to.
id*
Integer
The id of the anomaly in question.
Body parameters
Name Description
inlineObject2 *

Responses:

200

404

500

Measurement

getMeasurement

Get the current state of the measurement.


Path:

get 
/measurement

Responses:

200

startMeasurement

Start the measurement for a specified project.


Path:

post 
/measurement

Parameters:

Body parameters
Name Description
inlineObject *

Responses:

201

409

503

stopMeasurement

Stop the currently running measurement.


Path:

delete 
/measurement

Responses:

204

404

Project

exportProject

Export the data of a project as a ZIP file.

Phase information and energy levels can be exported as a CSV file.


Path:

post 
/export

Parameters:

Body parameters
Name Description
export *

Responses:

200

getAllEnergyLevelsRaw

Get all raw energy levels for a specified project.

By specifying the corresponding query parameters, it's either possible to get the raw energy levels for the last n cycles, or for a given range. In both cases the maximum number of cycles is 50,000. If the number of values is out of range or an invalid combination of query-parameters is used, 400 is returned.


Path:

get 
/projects/{project}/cycles/energy_levels/raw

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
Query parameters
Name Description
frequency_khz_from
Integer
The lower frequency bound for the energy levels in kilohertz, inclusive.
frequency_khz_to
Integer
The upper frequency bound for the energy levels in kilohertz, inclusive.
last_n_cycles
Integer
The number of cycles, starting from last, for which energy levels are returned.
from_cycle
Integer
The first cycle number to get the value for (inclusive). Only valid if until_cycle is specified and last_n_cycles is not specified.
until_cycle
Integer
The last cycle number to get the value for (inclusive). Only valid if from_cycle is specified and last_n_cycles is not specified.

Responses:

200

400

getAllEnergyLevelsTrend

Get the trend of all energy levels for a specified project.

By specifying the corresponding query parameters, it's either possible to get the trending energy levels for the last n cycles, or for a given range. In both cases the maximum number of cycles is 50,000. If the number of values is out of range or an invalid combination of query-parameters is used, 400 is returned.


Path:

get 
/projects/{project}/cycles/energy_levels/trend

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
Query parameters
Name Description
frequency_khz_from
Integer
The lower frequency bound for the energy levels in kilohertz, inclusive.
frequency_khz_to
Integer
The upper frequency bound for the energy levels in kilohertz, inclusive.
last_n_cycles
Integer
The number of cycles, starting from last, for which energy levels are returned.
from_cycle
Integer
The first cycle number to get the value for (inclusive). Only valid if until_cycle is specified and last_n_cycles is not specified.
until_cycle
Integer
The last cycle number to get the value for (inclusive). Only valid if from_cycle is specified and last_n_cycles is not specified.

Responses:

200

400

getAllPhaseDurations

Get all phase durations for a specified project.

By specifying the corresponding query parameters, it's either possible to get the durations for the last n cycles, or for a given range. In both cases the maximum number of cycles is 50,000. If the number of values is out of range or an invalid combination of query-parameters is used, 400 is returned.


Path:

get 
/projects/{project}/cycles/phase_durations

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
Query parameters
Name Description
last_n_cycles
Integer
The number of cycles, starting from last, for which phase durations are returned. Only valid if both from_cycle and until_cycle are not specified.
from_cycle
Integer
The first cycle number to get the value for (inclusive). Only valid if until_cycle is specified and last_n_cycles is not specified.
until_cycle
Integer
The last cycle number to get the value for (inclusive). Only valid if from_cycle is specified and last_n_cycles is not specified.

Responses:

200

400

getCyclePhases

Get information about occurrences of the phases in the given cycle.


Path:

get 
/projects/{project}/cycles/{cycle_number}/phases

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
cycle_number*
Integer
The number of the cycle to get the values for.

Responses:

200

404

getCycles

Get all cycles for a project. Further filters must be specified via the query-parameters. Currently, only filtering by tag-id is supported.


Path:

get 
/projects/{project}/cycles

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
Query parameters
Name Description
tag*
Integer
The id of a tag to filter the cycles for

Responses:

200

404

getEnergyLevelsRaw

Get the raw energy levels of the given cycle.


Path:

get 
/projects/{project}/cycles/{cycle_number}/energy_levels/raw

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
cycle_number*
Integer
The number of the cycle to get the values for.
Query parameters
Name Description
frequency_khz_from
Integer
The lower frequency bound for the energy levels in kilohertz, inclusive.
frequency_khz_to
Integer
The upper frequency bound for the energy levels in kilohertz, inclusive.

Responses:

200

404

getEnergyLevelsTrend

Get the trending energy levels of the given cycle.


Path:

get 
/projects/{project}/cycles/{cycle_number}/energy_levels/trend

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
cycle_number*
Integer
The number of the cycle to get the values for.
Query parameters
Name Description
frequency_khz_from
Integer
The lower frequency bound for the energy levels in kilohertz, inclusive.
frequency_khz_to
Integer
The upper frequency bound for the energy levels in kilohertz, inclusive.

Responses:

200

404

getLastCycleNumber

Get the number of the last completed cycle for a specified project.


Path:

get 
/projects/{project}/last_cycle_number

Parameters:

Path parameters
Name Description
project*
String
The name of the project.

Responses:

200

404

getMonitoringRules

Get the monitoring rules for a specified project.

The monitoring rules are used to monitor the individual phases of the project based on their energy levels.


Path:

get 
/projects/{project}/monitoring_rules

Parameters:

Path parameters
Name Description
project*
String
The name of the project.

Responses:

200

404

getNumberOfCyclesGroupedBy

Get the number of cycles grouped by a given time.


Path:

get 
/projects/{project}/cycles/count

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
Query parameters
Name Description
group_by
String
The duration to group the counts by.
from
Date (date-time)
The beginning of the time span. All cycles started at or after this point in time will be considered. If no value is given, the following defaults will be used: - If the request is grouped by hour, the beginning of the current day will be considered. - If the request is grouped by day, the beginning of the day six days ago will be considered. - If the request is grouped by week, the beginning of the week three weeks ago will be considered. - If the request is grouped by month, the beginning of the month eleven months ago will be considered. - If the request is grouped by year, all years since the first cycle will be considered.
until
Date (date-time)
The end of the time span. All cycles started before or at this point in time will be considered. If no value is given, the current moment will be used as default.

Responses:

200

404

getPhases

Get a list of all phases for the specified project.


Path:

get 
/projects/{project}/phases

Parameters:

Path parameters
Name Description
project*
String
The name of the project.

Responses:

200

404

getProject

Get the project's main infos.

In addition to the first and last recorded cycle and a list of all channels, this information also includes project-dependent information on phase detection.


Path:

get 
/projects/{project}

Parameters:

Path parameters
Name Description
project*
String
The name of the project.

Responses:

200

404

getProjectNames

Get a list of all project names.


Path:

get 
/projects

Responses:

200

getProtocol

Get a list of protocol entries for a given project.

The list contains energy monitoring and cycle screening events. The length of the list can be restricted by a maximum value.


Path:

get 
/protocol/{project}

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
Query parameters
Name Description
max
Integer
The maximum number of entries to return. The newest entries will be returned.

Responses:

200

404

getSpectrogram

Get the spectrogram as binary data.


Path:

get 
/projects/{project}/cycles/{cycle_number}/spectrogram/{channel}

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
cycle_number*
Integer
The number of the cycle to get the spectrogram for.
channel*
String
The channel name to get the spectrogram for.

Responses:

200

404

410

ProjectManagement

createProject

Create a new project.


Path:

post 
/projects

Parameters:

Body parameters
Name Description
createProject *

Responses:

201

409

400

deleteProject

Delete a specified project.


Path:

delete 
/projects/{project}

Parameters:

Path parameters
Name Description
project*
String
The name of the project.

Responses:

200

404

setMonitoringRules

Update the monitoring rules for a specified project.

The monitoring rules are used to monitor the individual phases of the project based on their energy levels.


Path:

post 
/projects/{project}/monitoring_rules

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
Body parameters
Name Description
monitoringRuleTemplates *

Responses:

200

404

Tagging

createTag

Create a new Tag


Path:

post 
/tags

Parameters:

Body parameters
Name Description
tagNames *

Responses:

200

400

409

500

deleteTag

Delete the tag with the specified id. Note that tags provided by default cannot be deleted.


Path:

patch 
/tags/{id}

Parameters:

Path parameters
Name Description
id*
Integer
Tag id

Responses:

200

400

404

409

getAllTags

List all available tags


Path:

get 
/tags

Responses:

200

getCycleTags

List all available tags for a specified cycle.


Path:

get 
/projects/{project}/cycles/{cycle_number}/tags

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
cycle_number*
Integer
The number of the cycle to get the values for.

Responses:

200

404

getTagById

Get information about the tag with the specified id


Path:

get 
/tags/{id}

Parameters:

Path parameters
Name Description
id*
Integer
Tag id

Responses:

200

400

404

setCycleTags

Update the tags for a specified project and cycle number.

Tag a specific cycle with new tags that have already been created, or delete tags of that cycle. The array sent with the request must contain at least one cycle tag and cycle tags that have no differences will not be changed. Existing cycle tags that are not included in the array are ignored for the time being.


Path:

post 
/projects/{project}/cycles/{cycle_number}/tags

Parameters:

Path parameters
Name Description
project*
String
The name of the project.
cycle_number*
Integer
The number of the cycle to get the values for.
Body parameters
Name Description
cycleTagTemplates *

Responses:

200

400

404

500

updateTag

Update the tag with the specified id

Update a tag with new values. At least one of the translations must not be an empty string. Note that tags provided by default cannot be updated.


Path:

put 
/tags/{id}

Parameters:

Path parameters
Name Description
id*
Integer
Tag id
Body parameters
Name Description
tagNames *

Responses:

200

400

404

409

500