This document describes the REST API of the wearTell base system.
The REST API can be used do gather data from the system, as well as managing projects and starting or stopping measurements. This way, the wearTell base system can be easily integrated in various environments and workflows.
A description of the REST API is also available as an OpenAPI specification.
Please note that there is no authentication or the like, so anybody with access to the API can run any method.
If you have feedback or any other requests, do not hesitate to contact us.
Start the measurement for a specified project.
/measurement| Name | Description |
|---|---|
| inlineObject * |
Stop the currently running measurement.
/measurementExport the data of a project as a ZIP file.
Phase information and wT-values can be exported as a CSV file as well as images from selected spectrograms, wT and phase duration diagrams in JPEG format with a resolution of 1920 x 1080 pixels.
/export| Name | Description |
|---|---|
| export * |
Get all phase durations of a specified project. Only the values for the last 50,000 cycles are returned.
/projects/{project}/cycles/phase_durations| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
Get all wT-values for a specified project. Only the values for the last 50,000 cycles are returned.
/projects/{project}/cycles/wt| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
| 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.
|
Get information about occurences of the phases in the given cycle.
/projects/{project}/cycles/{cycle_number}/phases| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
| cycle_number* |
Integer
The number of the cycle to get the values for.
|
Get the number of the last completed cycle for a specified project.
/projects/{project}/last_cycle_number| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
Get the monitoring rules for a specified project.
The monitoring rules are used to monitor the individual phases of the project based on their wT-values. If necessary, the wT-values for different frequency ranges can be logically linked.
/projects/{project}/monitoring_rules| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
Get a list of all phases for the specified project.
/projects/{project}/phases| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
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.
/projects/{project}| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
Get a list of all project names.
/projectsGet a list of protocol entries.
The list contains energy monitoring and cycle screening events. The length of the list can be restricted by a maximum value.
/protocol| Name | Description |
|---|---|
| max |
Integer
The maximum number of entries to return. The newest entries will be returned.
|
Get the spectrogram as binary data.
/projects/{project}/cycles/{cycle_number}/spectrogram/{channel}| 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.
|
Get the wT-values of the given cycle.
/projects/{project}/cycles/{cycle_number}/wt| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
| cycle_number* |
Integer
The number of the cycle to get the values for.
|
| 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.
|
Create a new project.
/projects| Name | Description |
|---|---|
| createProject * |
Delete a specified project.
/projects/{project}| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
Update the monitoring rules for a specified project.
The monitoring rules are used to monitor the individual phases of the project based on their wT-values. If necessary, the wT-values for different frequency ranges can be logically linked.
/projects/{project}/monitoring_rules| Name | Description |
|---|---|
| project* |
String
The name of the project.
|
| Name | Description |
|---|---|
| monitoringRuleTemplates * |