NSW API Docs
ad_converter_types
list
Lists AD Converter Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "ad_converter_type0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates AD Converter Type.
Example request:
{ "codename": "ad_converter_type0" }
Example response:
{ "id": 126375846344, "codename": "ad_converter_type0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the AD Converter Type (not null, not blank, unique) |
read
Returns AD Converter Type by ID.
Example response:
{ "id": 126375846344, "codename": "ad_converter_type0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this AD Converter Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates AD Converter Type.
Example request:
{ "codename": "ad_converter_type0" }
Example response:
{ "id": 126375846344, "codename": "ad_converter_type0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this AD Converter Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the AD Converter Type (not null, not blank, unique) |
partial_update
Partially updates AD Converter Type.
Example request:
{ "codename": "ad_converter_type0" }
Example response:
{ "id": 126375846344, "codename": "ad_converter_type0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this AD Converter Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | Codename of the AD Converter Type (not null, not blank, unique) |
delete
Deletes AD Converter Type.
Example response:
{ "id": 126375846344, "codename": "ad_converter_type0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this AD Converter Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
alert_severities
list
Lists Alert Severities.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "eventtype0", "name": "EventType 0", "value": 0.0 } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Alert Severity.
Example request:
{ "codename": "eventtype0", "name": "EventType 0", "value": 0.0 }
Example response:
{ "id": 126375846344, "codename": "eventtype0", "name": "EventType 0", "value": 0.0 }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of Alert Severity |
name required | Name of Alert Severity |
value | Value of Alert Severity |
read
Returns Alert Severity by ID.
Example response:
{ "id": 126375846344, "codename": "eventtype0", "name": "EventType 0", "value": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Alert Severity. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Alert Severity.
Example request:
{ "codename": "eventtype0", "name": "EventType 0", "value": 0.0 }
Example response:
{ "id": 126375846344, "codename": "eventtype0", "name": "EventType 0", "value": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Alert Severity. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of Alert Severity |
name required | Name of Alert Severity |
value | Value of Alert Severity |
partial_update
Partially updates Alert Severity.
Example request:
{ "codename": "eventtype0", "name": "EventType 0", "value": 0.0 }
Example response:
{ "id": 126375846344, "codename": "eventtype0", "name": "EventType 0", "value": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Alert Severity. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | Codename of Alert Severity |
name | Name of Alert Severity |
value | Value of Alert Severity |
delete
Deletes Alert Severity.
Example response:
{ "id": 126375846344, "codename": "eventtype0", "name": "EventType 0", "value": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Alert Severity. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
api-token-auth
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
username required | Valid username for authentication |
password required | Valid password for authentication |
audio_chunk_types
list
Lists Audio Chunk Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "channel_type": "channel_type0", "codename": "audio_chunk_type0", "unit": "unit0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Audio Chunk Type.
Example request:
{ "codename": "audio_chunk_type0", "channel_type": "channel_type0" }
Example response:
{ "id": 126375846344, "channel_type": "channel_type0", "codename": "audio_chunk_type0", "unit": "unit0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
channel_type required | Type of Channel that can record Audio Chunks of this Type (not null, not blank) |
codename required | Codename of the Audio Chunk Type (not null, not blank, unique) |
unit | Unit for values in the Audio Chunk of this Type (not null, not blank) |
read
Returns Audio Chunk Type by ID.
Example response:
{ "id": 126375846344, "channel_type": "channel_type0", "codename": "audio_chunk_type0", "unit": "unit0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Audio Chunk Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Audio Chunk Type.
Example request:
{ "codename": "audio_chunk_type0", "channel_type": "channel_type0" }
Example response:
{ "id": 126375846344, "channel_type": "channel_type0", "codename": "audio_chunk_type0", "unit": "unit0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Audio Chunk Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
channel_type required | Type of Channel that can record Audio Chunks of this Type (not null, not blank) |
codename required | Codename of the Audio Chunk Type (not null, not blank, unique) |
unit | Unit for values in the Audio Chunk of this Type (not null, not blank) |
partial_update
Partially updates Audio Chunk Type.
Example request:
{ "codename": "audio_chunk_type0", "channel_type": "channel_type0" }
Example response:
{ "id": 126375846344, "channel_type": "channel_type0", "codename": "audio_chunk_type0", "unit": "unit0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Audio Chunk Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
channel_type | Type of Channel that can record Audio Chunks of this Type (not null, not blank) |
codename | Codename of the Audio Chunk Type (not null, not blank, unique) |
unit | Unit for values in the Audio Chunk of this Type (not null, not blank) |
delete
Deletes Audio Chunk Type.
Example response:
{ "id": 126375846344, "channel_type": "channel_type0", "codename": "audio_chunk_type0", "unit": "unit0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Audio Chunk Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
audio_chunks
list
Lists Audio Chunks.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "placement": null, "channel": null, "end_datetime": "2024-03-29T00:38:23.693260Z", "number_of_samples": 44, "max_amplitude": 0.8, "mime_type": "audio/flac", "hash": "e2d1a4e15f01e551492230c56063c4386f8ed601", "running_threshold": 0.0, "placement_enabled": true, "gain": 30, "sensor_type": null, "type": "audio_chunk_type2", "file": "test.flac", "start_datetime": "2024-03-29T00:38:23.692262Z", "meta": { "test0": "Test 0" } } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
channel | Filters Audio Chunks by Channel IDs (list) |
deduplicate | When set to true, deduplicates Audio Chunks by Placement ID and start datetime (single value) |
device | Filters Audio Chunks by Device IDs (list) |
from | Filters Audio Chunks by start_datetime from (single value) |
id | Filters entities by IDs (list) |
machine | Filters Audio Chunks by Machine IDs (list) |
not_channel | Filters Audio Chunks by Channel IDs (list) (inverse) |
not_deduplicate | When set to true, deduplicates Audio Chunks by Placement ID and start datetime (single value) (inverse) |
not_device | Filters Audio Chunks by Device IDs (list) (inverse) |
not_from | Filters Audio Chunks by start_datetime from (single value) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Audio Chunks by Machine IDs (list) (inverse) |
not_placement | Filters Audio Chunks by Placement IDs (list) (inverse) |
not_placement_type | Filters Audio Chunks by Placement Type IDs (list) (inverse) |
not_project | Filters Audio Chunks by Project IDs (list) (inverse) |
not_to | Filters Audio Chunks by start_datetime to (single value) (inverse) |
placement | Filters Audio Chunks by Placement IDs (list) |
placement_type | Filters Audio Chunks by Placement Type IDs (list) |
project | Filters Audio Chunks by Project IDs (list) |
to | Filters Audio Chunks by start_datetime to (single value) |
info
Returns info about audio file
Example request:
{ "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" }
Example response:
{ "mimetype": "audio/flac", "channels": 1 }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
data required | Base64 data (at least 4096 bytes) to upload |
post_upload
Stores chunk metadata to DB after direct upload of data to Google Storage
Example request:
{ "start_datetime": "2019-01-25 13:01:43.034110", "meta": { "test": "Some metadata" }, "configuration": { "channels": [ { "placement": 12345, "channel": 54321, "running_threshold": 0.5, "gain": 20, "placement_enabled": true, "sensor_type": "bosch:iepe", "type": "audio", "mime_type": "audio/flac", "hash": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340", "max_amplitude": 0.736, "number_of_samples": 44100 }, { "placement": 12346, "channel": 54322, "running_threshold": 0.5, "gain": 20, "placement_enabled": true, "sensor_type": "bosch:iepe", "type": "audio", "mime_type": "audio/flac", "hash": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340", "max_amplitude": 0.736, "number_of_samples": 44100 } ] } }
Example response:
{}
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
start_datetime required | Start datetime of audio |
end_datetime required | End datetime of audio |
meta | Audio metadata (any JSON) |
configuration required | Placement/Channel configurations |
pre_upload
Prepares signed link for direct upload to Google Storage
Example request:
{ "start_datetime": "2019-01-25 13:01:43.034110", "meta": { "test": "Some metadata" }, "configuration": { "channels": [ { "placement": 12345, "channel": 54321, "running_threshold": 0.5, "gain": 20, "placement_enabled": true, "sensor_type": "bosch:iepe", "type": "audio", "mime_type": "audio/flac", "hash": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340", "max_amplitude": 0.736, "number_of_samples": 44100 }, { "placement": 12346, "channel": 54322, "running_threshold": 0.5, "gain": 20, "placement_enabled": true, "sensor_type": "bosch:iepe", "type": "audio", "mime_type": "audio/flac", "hash": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340", "max_amplitude": 0.736, "number_of_samples": 44100 } ] } }
Example response:
{ "links": [ "https://somelink.to/upload/file/to/gstorage1", "https://somelink.to/upload/file/to/gstorage2" ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
start_datetime required | Start datetime of audio |
end_datetime required | End datetime of audio |
meta | Audio metadata (any JSON) |
configuration required | Placement/Channel configurations |
subsample
Returns list of Audio Chunks between start and end datetime subsampled to given count of chunks, uniformly distributed
Example query string:
?placement=2289&from=2022-01-01T00:00:00&to=2022-07-01T00:00:00&count=3&tz=UTC
Example response:
{ "results": [ { "datetime": "2021-12-31T23:59:02.383051Z", "id": 12345, "url": "https://..." }, { "datetime": "2022-04-01T11:59:46.3100000Z", "id": 23456, "url": "https://..." }, { "datetime": "2022-07-01T00:00:00.000000Z", "id": null, "url": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
placement required | Placement ID |
from required | Start datetime |
to required | End datetime |
count required | Count of chunks to get |
upload
Splits audio data into Channels and stores them as individual Chunks; for authenticated Device, if empty JSON object is received by the server, it only updates last_seen_datetime on connected Machines. If multiple files are received, all of them must have only 1 Channel and must have same sample rate and length.
Example request:
{ "placements": [ 148 ], "file": { "name": "test.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" }, "start_datetime": "2019-01-25 13:01:43.034110", "meta": { "test": "Some metadata" } }or
{ "channel_numbers": [ 1 ], "file": { "name": "test.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" }, "start_datetime": "2019-01-25 13:01:43.034110", "meta": { "test": "Some metadata" } }or
{ "first_channel_no": 1, "file": { "name": "test.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" }, "start_datetime": "2019-01-25 13:01:43.034110", "meta": { "test": "Some metadata" } }or
{ "placements": [ 148, 149 ], "files": [ { "name": "test1.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" }, { "name": "test2.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" } ], "start_datetime": "2019-01-25 13:01:43.034110", "meta": { "test": "Some metadata" } }or
{ "channel_numbers": [ 1, 2 ], "files": [ { "name": "test1.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" }, { "name": "test2.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" } ], "start_datetime": "2019-01-25 13:01:43.034110", "meta": { "test": "Some metadata" } }or
{ "first_channel_no": 1, "files": [ { "name": "test1.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" }, { "name": "test2.flac", "data": "ZkxhQwAAACIQABAAAAAnAAAnCsRA8AAAACxkpiD0US3vvg7i/90G/nSShAAAKCAAAAByZWZlcmVuY2UgbGliRkxBQyAxLjMuMiAyMDE3MDEwMQAAAAD/+GkIACvMGAAACkQUch5yAIn2IpuMpGjE5mrEUTkqclsmWyPAK8o=" } ], "start_datetime": "2019-01-25 13:01:43.034110", "meta": { "test": "Some metadata" } }or
{}
Example response:
[ { "id": 92134, "placement": 148, "channel": 1960, "end_datetime": "2019-01-25T13:01:43.035108Z", "number_of_samples": 44, "max_amplitude": 0.871612548828125, "file": "2019-01-25/148_1960_20190125_130143034110.flac", "start_datetime": "2019-01-25T13:01:43.034110Z", "meta": { "test": "Some metadata" }, "labels": [ 85811 ] } ]
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file | File to upload |
files | Multiple single-channel files to upload; if not supplied, "file" field is required |
placements required | List of Placement IDs; only required and used when User uploads audio |
channel_numbers | List of Channel numbers; only required and used when Device uploads audio, first_channel_no can be used instead |
first_channel_no | Number of first Channel, the rest is generated automatically from number of Channels in audio data; only required and used when Device uploads audio, channel_numbers can be used instead |
start_datetime required | Start datetime of audio |
meta | Audio metadata (any JSON) |
read
Returns Audio Chunk by ID.
Example response:
{ "id": 126375846344, "placement": null, "channel": null, "end_datetime": "2024-03-29T00:38:23.693260Z", "number_of_samples": 44, "max_amplitude": 0.8, "mime_type": "audio/flac", "hash": "e2d1a4e15f01e551492230c56063c4386f8ed601", "running_threshold": 0.0, "placement_enabled": true, "gain": 30, "sensor_type": null, "type": "audio_chunk_type2", "file": "test.flac", "start_datetime": "2024-03-29T00:38:23.692262Z", "meta": { "test0": "Test 0" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Audio Chunk. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
delete
Deletes Audio Chunk.
Example response:
{ "id": 126375846344, "placement": null, "channel": null, "end_datetime": "2024-03-29T00:38:23.693260Z", "number_of_samples": 44, "max_amplitude": 0.8, "mime_type": "audio/flac", "hash": "e2d1a4e15f01e551492230c56063c4386f8ed601", "running_threshold": 0.0, "placement_enabled": true, "gain": 30, "sensor_type": null, "type": "audio_chunk_type2", "file": "test.flac", "start_datetime": "2024-03-29T00:38:23.692262Z", "meta": { "test0": "Test 0" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Audio Chunk. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
file
Returns Audio Chunk data.
Example response:
{ "placement": 1, "channel": 2, "start_datetime": "2015-03-08T01:00:00-0400", "end_datetime": "2015-03-08T12:00:00-0400", "number_of_samples": 144000, "max_amplitude": 2302.04443359375, "mime_type": "audio/x-flac", "hash": "3ae7c99dc7ad9d538c30c31e5ddf029cbc3905088c08c187e5098b71d0a553e0", "running_threshold": 0.5, "placement_enabled": false, "gain": 20, "file": "2018-08-28/26_2113_20180828_184233978959.flac", "type": "audio" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Audio Chunk. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
channel_states
list
Lists Channel States.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Sensor State #0", "description": "Description for Sensor State #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Channel State.
Example request:
{ "name": "Sensor State #0", "description": "Description for Sensor State #0" }
Example response:
{ "id": 126375846344, "name": "Sensor State #0", "description": "Description for Sensor State #0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Channel State (not null, not blank, unique) |
description | Description of the Channel State (null, blank) |
read
Returns Channel State by ID.
Example response:
{ "id": 126375846344, "name": "Sensor State #0", "description": "Description for Sensor State #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel State. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Channel State.
Example request:
{ "name": "Sensor State #0", "description": "Description for Sensor State #0" }
Example response:
{ "id": 126375846344, "name": "Sensor State #0", "description": "Description for Sensor State #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel State. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Channel State (not null, not blank, unique) |
description | Description of the Channel State (null, blank) |
partial_update
Partially updates Channel State.
Example request:
{ "name": "Sensor State #0", "description": "Description for Sensor State #0" }
Example response:
{ "id": 126375846344, "name": "Sensor State #0", "description": "Description for Sensor State #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel State. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Channel State (not null, not blank, unique) |
description | Description of the Channel State (null, blank) |
delete
Deletes Channel State.
Example response:
{ "id": 126375846344, "name": "Sensor State #0", "description": "Description for Sensor State #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel State. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
channel_types
list
Lists Channel Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "channel_type3" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Channel Type.
Example request:
{ "codename": "channel_type3" }
Example response:
{ "id": 126375846344, "codename": "channel_type3" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the Channel Type (not null, not blank, unique) |
read
Returns Channel Type by ID.
Example response:
{ "id": 126375846344, "codename": "channel_type3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Channel Type.
Example request:
{ "codename": "channel_type3" }
Example response:
{ "id": 126375846344, "codename": "channel_type3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the Channel Type (not null, not blank, unique) |
partial_update
Partially updates Channel Type.
Example request:
{ "codename": "channel_type3" }
Example response:
{ "id": 126375846344, "codename": "channel_type3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | Codename of the Channel Type (not null, not blank, unique) |
delete
Deletes Channel Type.
Example response:
{ "id": 126375846344, "codename": "channel_type3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
channels
list
Lists Channels.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "device": 126375846344, "state": 126375846344, "placement": null, "type": "channel_type5", "ad_converter_type": null, "number": 1, "note": "Note for channel #0", "gain": 30 } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
device | Filters Channels by Device IDs (list) |
id | Filters entities by IDs (list) |
machine | Filters Channels by Machine ID (list) |
not_device | Filters Channels by Device IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Channels by Machine ID (list) (inverse) |
not_number | Filters Channels by numbers (list) (inverse) |
not_number_gte | Filters Channels by numbers (greater than or equal; single value) (inverse) |
not_number_lte | Filters Channels by numbers (lower than or equal; single value) (inverse) |
not_placement | Filters Channels by Placement ID (list) (inverse) |
not_sensor_type | Filters Channels by Sensor Type ID (list) (inverse) |
not_state | Filters Channels by State ID (list) (inverse) |
number | Filters Channels by numbers (list) |
number_gte | Filters Channels by numbers (greater than or equal; single value) |
number_lte | Filters Channels by numbers (lower than or equal; single value) |
placement | Filters Channels by Placement ID (list) |
sensor_type | Filters Channels by Sensor Type ID (list) |
state | Filters Channels by State ID (list) |
create
Creates Channel.
Example request:
{ "number": 1, "state": 126375846344, "note": "Note for channel #0", "device": 126375846344, "gain": 30, "type": "channel_type5" }
Example response:
{ "id": 126375846344, "device": 126375846344, "state": 126375846344, "placement": null, "type": "channel_type5", "ad_converter_type": null, "number": 1, "note": "Note for channel #0", "gain": 30 }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
device required | Device for the Channel (not null) |
state | State of the Channel (null) |
placement | Placement where the Channel is connected (null) |
type | Type of this Channel (audio/general; not null, not blank) |
ad_converter_type | AD Converter Type on this Channel (null, blank) |
number required | Number of the Channel (not null) |
note | Note for the Channel (null, blank) |
gain | Gain of the Channel (not null, not blank) |
read
Returns Channel by ID.
Example response:
{ "id": 126375846344, "device": 126375846344, "state": 126375846344, "placement": null, "type": "channel_type5", "ad_converter_type": null, "number": 1, "note": "Note for channel #0", "gain": 30 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Channel.
Example request:
{ "number": 1, "state": 126375846344, "note": "Note for channel #0", "device": 126375846344, "gain": 30, "type": "channel_type5" }
Example response:
{ "id": 126375846344, "device": 126375846344, "state": 126375846344, "placement": null, "type": "channel_type5", "ad_converter_type": null, "number": 1, "note": "Note for channel #0", "gain": 30 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
state | State of the Channel (null) |
placement | Placement where the Channel is connected (null) |
type | Type of this Channel (audio/general; not null, not blank) |
ad_converter_type | AD Converter Type on this Channel (null, blank) |
number required | Number of the Channel (not null) |
note | Note for the Channel (null, blank) |
gain | Gain of the Channel (not null, not blank) |
partial_update
Partially updates Channel.
Example request:
{ "number": 1, "state": 126375846344, "note": "Note for channel #0", "device": 126375846344, "gain": 30, "type": "channel_type5" }
Example response:
{ "id": 126375846344, "device": 126375846344, "state": 126375846344, "placement": null, "type": "channel_type5", "ad_converter_type": null, "number": 1, "note": "Note for channel #0", "gain": 30 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
state | State of the Channel (null) |
placement | Placement where the Channel is connected (null) |
type | Type of this Channel (audio/general; not null, not blank) |
ad_converter_type | AD Converter Type on this Channel (null, blank) |
number | Number of the Channel (not null) |
note | Note for the Channel (null, blank) |
gain | Gain of the Channel (not null, not blank) |
delete
Deletes Channel.
Example response:
{ "id": 126375846344, "device": 126375846344, "state": 126375846344, "placement": null, "type": "channel_type5", "ad_converter_type": null, "number": 1, "note": "Note for channel #0", "gain": 30 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Channel. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
check_token
list
Checks whether password reset token is valid.
Example response:
{ "status": "Token is valid" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
uuid required | User UUID |
token required | User token |
companies
list
Lists Companies.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "users": [], "projects": [], "all_users": [], "name": "Company #10", "email": "account10@example.com", "hubspot_id": 11, "is_archived": false } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
email | Filters Companies by e-mails (list) |
hubspot_id | Filters Companies by hubspot IDs (list) |
id | Filters entities by IDs (list) |
is_archived | Filters Companies by is_archived (single value) |
not_email | Filters Companies by e-mails (list) (inverse) |
not_hubspot_id | Filters Companies by hubspot IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_is_archived | Filters Companies by is_archived (single value) (inverse) |
not_q | Filters Companies by search in name (single value) (inverse) |
not_user | Filters Companies by User IDs (list) (inverse) |
q | Filters Companies by search in name (single value) |
user | Filters Companies by User IDs (list) |
create
Creates Company.
Example request:
{ "name": "Company #10", "email": "account10@example.com", "users": [], "is_archived": false }
Example response:
{ "id": 126375846344, "users": [], "projects": [], "all_users": [], "name": "Company #10", "email": "account10@example.com", "hubspot_id": 11, "is_archived": false }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
users | Users of the Company |
name required | Name of the Company (not null, not blank, unique) |
email required | Contact email for the Company (not null, not blank, unique) |
hubspot_id | Hubspot ID for the Company (null) |
is_archived | Whether the Company is archived |
read
Returns Company by ID.
Example response:
{ "id": 126375846344, "users": [], "projects": [], "all_users": [], "name": "Company #10", "email": "account10@example.com", "hubspot_id": 11, "is_archived": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Company.
Example request:
{ "name": "Company #10", "email": "account10@example.com", "users": [], "is_archived": false }
Example response:
{ "id": 126375846344, "users": [], "projects": [], "all_users": [], "name": "Company #10", "email": "account10@example.com", "hubspot_id": 11, "is_archived": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
users | Users of the Company |
name required | Name of the Company (not null, not blank, unique) |
email required | Contact email for the Company (not null, not blank, unique) |
hubspot_id | Hubspot ID for the Company (null) |
is_archived | Whether the Company is archived |
partial_update
Partially updates Company.
Example request:
{ "name": "Company #10", "email": "account10@example.com", "users": [], "is_archived": false }
Example response:
{ "id": 126375846344, "users": [], "projects": [], "all_users": [], "name": "Company #10", "email": "account10@example.com", "hubspot_id": 11, "is_archived": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
users | Users of the Company |
name | Name of the Company (not null, not blank, unique) |
email | Contact email for the Company (not null, not blank, unique) |
hubspot_id | Hubspot ID for the Company (null) |
is_archived | Whether the Company is archived |
delete
Deletes Company.
Example response:
{ "id": 126375846344, "users": [], "projects": [], "all_users": [], "name": "Company #10", "email": "account10@example.com", "hubspot_id": 11, "is_archived": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
image
A viewset used for retrieving and editing Company instances.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
monthly_reports
A viewset used for retrieving and editing Company instances.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
projects
Lists Projects for specified Company.
Example response:
{ "id": 1, "project_name": "Project #1", "name": "Project #1", "created_at": "2021-03-04T17:32:53.639449Z", "description": "Description for Project #1", "type": 1, "facilities": [], "bucket": "bucket1", "company": 2, "users": [], "org_id": 4 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
thumbnail
A viewset used for retrieving and editing Company instances.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
company_images
list
Lists Company Images.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "company": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
company | Filters Company Images by Company ID; example: ?company=3 (list) |
id | Filters entities by IDs (list) |
not_company | Filters Company Images by Company ID; example: ?company=3 (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Company Image.
Example request:
{ "company": null, "type": "FULL", "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "version": "abcdefgh0000", "thumbnail": null }
Example response:
{ "id": 126375846344, "company": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company required | The Company this is the Image as a logo of (not null) |
image_data required | Binary Image data |
type | Image type, must be one of FULL, THUMBNAIL (not null, not blank) |
read
Returns Company Image by ID.
Example response:
{ "id": 126375846344, "company": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company Image. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Company Image.
Example request:
{ "company": null, "type": "FULL", "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "version": "abcdefgh0000", "thumbnail": null }
Example response:
{ "id": 126375846344, "company": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Company Image. |
image_data | Binary Image data. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
partial_update
Partially updates Company Image.
Example request:
{ "company": null, "type": "FULL", "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "version": "abcdefgh0000", "thumbnail": null }
Example response:
{ "id": 126375846344, "company": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Company Image. |
image_data | Binary Image data. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
delete
Deletes Company Image.
Example response:
{ "id": 126375846344, "company": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Company Image. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
consumer_deployments
list
Lists Consumer Deployments.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "machine": null, "service": { "name": "service0", "password": "xxx00000" }, "model_deployment": null, "name": "name_for_model0", "created_at": null, "is_ready": true, "is_deleted": false, "meta": { "test0": "Test 0" } } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
deployment_type | Filters Consumer Deployments by Model Deployment Types (list) |
from | Filters Consumer Deployments by creation datetime (from; single value) |
id | Filters entities by IDs (list) |
is_deleted | Filters Consumer Deployments by is_deleted (single value) |
is_ready | Filters Consumer Deployments by is_ready (single value) |
machine | Filters Consumer Deployments by Machine IDs (list) |
model_deployment | Filters Consumer Deployments by Model Deployment IDs (list) |
not_deployment_type | Filters Consumer Deployments by Model Deployment Types (list) (inverse) |
not_from | Filters Consumer Deployments by creation datetime (from; single value) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_is_deleted | Filters Consumer Deployments by is_deleted (single value) (inverse) |
not_is_ready | Filters Consumer Deployments by is_ready (single value) (inverse) |
not_machine | Filters Consumer Deployments by Machine IDs (list) (inverse) |
not_model_deployment | Filters Consumer Deployments by Model Deployment IDs (list) (inverse) |
not_to | Filters Consumer Deployments by creation datetime (to; single value) (inverse) |
not_trained_model_id | Filters Consumer Deployments by Model Deployment trained_model_id (list) (inverse) |
to | Filters Consumer Deployments by creation datetime (to; single value) |
trained_model_id | Filters Consumer Deployments by Model Deployment trained_model_id (list) |
create
Creates Consumer Deployment.
Example request:
{ "machine": null, "created_at": null, "is_ready": true, "is_deleted": false, "model_deployment": null, "meta": { "test0": "Test 0" }, "service": { "name": "service0", "password": "xxx00000" } }
Example response:
{ "id": 126375846344, "machine": null, "service": { "name": "service0", "password": "xxx00000" }, "model_deployment": null, "name": "name_for_model0", "created_at": null, "is_ready": true, "is_deleted": false, "meta": { "test0": "Test 0" } }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine required | Machine of the Consumer Deployment (not null) |
model_deployment required | Model Deployment used by the Consumer Deployment (not null) |
is_ready | Whether the Consumer Deployment is ready to be fed with data |
is_deleted | Whether the Consumer Deployment is deleted |
meta | Metadata for the Consumer Deployment (any JSON) |
read
Returns Consumer Deployment by ID.
Example response:
{ "id": 126375846344, "machine": null, "service": { "name": "service0", "password": "xxx00000" }, "model_deployment": null, "name": "name_for_model0", "created_at": null, "is_ready": true, "is_deleted": false, "meta": { "test0": "Test 0" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Consumer Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Consumer Deployment.
Example request:
{ "machine": null, "created_at": null, "is_ready": true, "is_deleted": false, "model_deployment": null, "meta": { "test0": "Test 0" }, "service": { "name": "service0", "password": "xxx00000" }, "name": "name_for_model0" }
Example response:
{ "id": 126375846344, "machine": null, "service": { "name": "service0", "password": "xxx00000" }, "model_deployment": null, "name": "name_for_model0", "created_at": null, "is_ready": true, "is_deleted": false, "meta": { "test0": "Test 0" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Consumer Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
model_deployment required | Model Deployment used by the Consumer Deployment (not null) |
name required | Name of the Consumer Deployment (not null, not blank, unique, alnum + _-) |
is_ready | Whether the Consumer Deployment is ready to be fed with data |
is_deleted | Whether the Consumer Deployment is deleted |
meta | Metadata for the Consumer Deployment (any JSON) |
partial_update
Partially updates Consumer Deployment.
Example request:
{ "machine": null, "created_at": null, "is_ready": true, "is_deleted": false, "model_deployment": null, "meta": { "test0": "Test 0" }, "service": { "name": "service0", "password": "xxx00000" }, "name": "name_for_model0" }
Example response:
{ "id": 126375846344, "machine": null, "service": { "name": "service0", "password": "xxx00000" }, "model_deployment": null, "name": "name_for_model0", "created_at": null, "is_ready": true, "is_deleted": false, "meta": { "test0": "Test 0" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Consumer Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
model_deployment | Model Deployment used by the Consumer Deployment (not null) |
name | Name of the Consumer Deployment (not null, not blank, unique, alnum + _-) |
is_ready | Whether the Consumer Deployment is ready to be fed with data |
is_deleted | Whether the Consumer Deployment is deleted |
meta | Metadata for the Consumer Deployment (any JSON) |
delete
Deletes Consumer Deployment.
Example response:
{ "id": 126375846344, "machine": null, "service": { "name": "service0", "password": "xxx00000" }, "model_deployment": null, "name": "name_for_model0", "created_at": null, "is_ready": true, "is_deleted": false, "meta": { "test0": "Test 0" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Consumer Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
organization_structure
Gets info by the Consumer Deployment ID up to the Company.
Example response:
{ "consumer_deployment_id": 1, "machine_id": 579, "station_id": 146, "facility_id": 33, "project_id": 13, "company_id": 8, "model_environment": "testing", "placements": [ { "placement_id": 1, "faults": [ { "id": 1, "placement": 1, "frequency_for_enveloping_start": 500, "frequency_for_enveloping_end": 12000, "rpm": 30, "is_rpm_automatically_detected": false, "coefficient": null, "band_alerting": "show", "type": "bearing_faults", "description": "test", "ftf": 3.412, "bfs": 6.234, "bpfi": 1.253, "bpfo": 2.534, "signal_processing": "envelope_acceleration", "threshold": 0.005 }, { "id": 2, "placement": 1, "frequency_for_enveloping_start": 500, "frequency_for_enveloping_end": 12000, "rpm": 30, "is_rpm_automatically_detected": false, "coefficient": 8, "band_alerting": "alert", "type": "specific_frequency", "description": "test 2", "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "acceleration", "threshold": null } ], "placement_type": "outlet" } ] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Consumer Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
results
Creates Consumer Deployment results (Machine/Placements)
Example request:
{ "machine_predictions": [ { "type": "loudness", "start_datetime": "2015-03-08T01:00:00-0400", "end_datetime": "2015-03-08T12:00:00-0400", "score": 0.1337, "probability": null, "classification": 0, "meta": { "message": { "text": "Machine is not running for 72 hours", "importance": "3" } } }, { "type": "anomaly_detector", "start_datetime": "2015-03-08T01:00:00-0400", "end_datetime": "2015-03-08T12:00:00-0400", "score": null, "probability": null, "classification": 0, "meta": null } ], "placement_predictions": [ { "placement": 8, "type": "anomaly_detector", "start_datetime": "2015-03-08T01:01:01-0400", "end_datetime": "2015-03-08T01:01:05-0400", "score": 0.1337, "probability": 0.956, "classification": 0, "meta": null }, { "placement": 9, "type": "anomaly_detector", "start_datetime": "2015-03-08T01:01:01-0400", "end_datetime": "2015-03-08T01:01:05-0400", "score": 0.1337, "probability": 0.1234, "classification": 1, "meta": null }, { "placement": 10, "type": "anomaly_detector", "start_datetime": "2015-03-08T01:01:01-0400", "end_datetime": "2015-03-08T01:01:05-0400", "score": 0.1337, "probability": 0.434, "classification": 3, "meta": null } ] }
Example response:
[ { "model_results_machines": [ { "id": 268218204, "consumer_deployment": 4, "model_environment": "production", "type": "loudness", "classification": 0, "start_datetime": "2015-03-08T05:00:00Z", "end_datetime": "2015-03-08T16:00:00Z", "score": 0.1337, "probability": null, "meta": { "message": { "text": "Machine is not running for 72 hours", "importance": "3" } } }, { "id": 268218205, "consumer_deployment": 4, "model_environment": "production", "type": "anomaly_detector", "classification": 0, "start_datetime": "2015-03-08T05:00:00Z", "end_datetime": "2015-03-08T16:00:00Z", "score": null, "probability": null, "meta": null } ], "model_results_placements": [ { "id": 24, "placement": 8, "consumer_deployment": 4, "model_environment": "production", "type": "anomaly_detector", "classification": 0, "start_datetime": "2015-03-08T05:01:01Z", "end_datetime": "2015-03-08T05:01:05Z", "score": 0.1337, "probability": 0.956, "meta": null }, { "id": 25, "placement": 9, "consumer_deployment": 4, "model_environment": "production", "type": "anomaly_detector", "classification": 1, "start_datetime": "2015-03-08T05:01:01Z", "end_datetime": "2015-03-08T05:01:05Z", "score": 0.1337, "probability": 0.1234, "meta": null }, { "id": 26, "placement": 10, "consumer_deployment": 4, "model_environment": "production", "type": "anomaly_detector", "classification": 3, "start_datetime": "2015-03-08T05:01:01Z", "end_datetime": "2015-03-08T05:01:05Z", "score": 0.1337, "probability": 0.434, "meta": null } ] } ]
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Consumer Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine_predictions required | List of Machine predictions |
placement_predictions required | List of Placement predictions |
contact_sets
list
Lists Contact Sets.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "project": null, "name": "Contact set #3", "description": "Description for Contact Set #3" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Contact Set.
Example request:
{ "name": "Contact set #3", "project": null, "description": "Description for Contact Set #3" }
Example response:
{ "id": 126375846344, "project": null, "name": "Contact set #3", "description": "Description for Contact Set #3" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
project required | Project of the Contact Set |
name required | Name of the Contact Set |
description | Description of the Contact Set (null, blank) |
read
Returns Contact Set by ID.
Example response:
{ "id": 126375846344, "project": null, "name": "Contact set #3", "description": "Description for Contact Set #3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact Set. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Contact Set.
Example request:
{ "name": "Contact set #3", "project": null, "description": "Description for Contact Set #3" }
Example response:
{ "id": 126375846344, "project": null, "name": "Contact set #3", "description": "Description for Contact Set #3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact Set. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Contact Set |
description | Description of the Contact Set (null, blank) |
partial_update
Partially updates Contact Set.
Example request:
{ "name": "Contact set #3", "project": null, "description": "Description for Contact Set #3" }
Example response:
{ "id": 126375846344, "project": null, "name": "Contact set #3", "description": "Description for Contact Set #3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact Set. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Contact Set |
description | Description of the Contact Set (null, blank) |
delete
Deletes Contact Set.
Example response:
{ "id": 126375846344, "project": null, "name": "Contact set #3", "description": "Description for Contact Set #3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact Set. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
contact_types
list
Lists Contact Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Contact Type.
Example request:
{ "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" }
Example response:
{ "id": 126375846344, "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of Contact Type |
description | Description of Contact Type (null, blank) |
read
Returns Contact Type by ID.
Example response:
{ "id": 126375846344, "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Contact Type.
Example request:
{ "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" }
Example response:
{ "id": 126375846344, "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of Contact Type |
description | Description of Contact Type (null, blank) |
partial_update
Partially updates Contact Type.
Example request:
{ "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" }
Example response:
{ "id": 126375846344, "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of Contact Type |
description | Description of Contact Type (null, blank) |
delete
Deletes Contact Type.
Example response:
{ "id": 126375846344, "name": "Name for Contact Type #0", "description": "Description for Contact Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
contacts
list
Lists Contacts.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "contact_set": null, "name": "Contact #0", "value": "1234560", "type": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Contact.
Example request:
{ "name": "Contact #0", "contact_set": null, "type": null, "value": "1234560" }
Example response:
{ "id": 126375846344, "contact_set": null, "name": "Contact #0", "value": "1234560", "type": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
contact_set required | Contact Set where the Contact belongs to |
name required | Name of the Contact (not null, not blank) |
value required | Value of given Contact, eg. phone number (not null) |
type required | Type of Contact (not null) |
read
Returns Contact by ID.
Example response:
{ "id": 126375846344, "contact_set": null, "name": "Contact #0", "value": "1234560", "type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Contact.
Example request:
{ "name": "Contact #0", "contact_set": null, "type": null, "value": "1234560" }
Example response:
{ "id": 126375846344, "contact_set": null, "name": "Contact #0", "value": "1234560", "type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Contact (not null, not blank) |
value required | Value of given Contact, eg. phone number (not null) |
type required | Type of Contact (not null) |
partial_update
Partially updates Contact.
Example request:
{ "name": "Contact #0", "contact_set": null, "type": null, "value": "1234560" }
Example response:
{ "id": 126375846344, "contact_set": null, "name": "Contact #0", "value": "1234560", "type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Contact (not null, not blank) |
value | Value of given Contact, eg. phone number (not null) |
type | Type of Contact (not null) |
delete
Deletes Contact.
Example response:
{ "id": 126375846344, "contact_set": null, "name": "Contact #0", "value": "1234560", "type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Contact. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
currencies
list
Lists Currencies.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "rate": "1.77000000", "codename": "0", "name": "Currency 0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Currencies.
Example request:
{ "codename": "0", "rate": "1.77000000", "name": "Currency 0" }
Example response:
{ "id": 126375846344, "rate": "1.77000000", "codename": "0", "name": "Currency 0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
rate required | Currency rate (not null, not blank) |
codename | Currency ISO code (not null, not blank, unique) |
name | Currency name (not null, not blank, unique) |
read
Returns Currency by ID.
Example response:
{ "id": 126375846344, "rate": "1.77000000", "codename": "0", "name": "Currency 0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Currency. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Currency.
Example request:
{ "codename": "0", "rate": "1.77000000", "name": "Currency 0" }
Example response:
{ "id": 126375846344, "rate": "1.77000000", "codename": "0", "name": "Currency 0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Currency. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
rate required | Currency rate (not null, not blank) |
codename | Currency ISO code (not null, not blank, unique) |
name | Currency name (not null, not blank, unique) |
partial_update
Partially updates Currency.
Example request:
{ "codename": "0", "rate": "1.77000000", "name": "Currency 0" }
Example response:
{ "id": 126375846344, "rate": "1.77000000", "codename": "0", "name": "Currency 0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Currency. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
rate | Currency rate (not null, not blank) |
codename | Currency ISO code (not null, not blank, unique) |
name | Currency name (not null, not blank, unique) |
delete
Deletes Currency.
Example response:
{ "id": 126375846344, "rate": "1.77000000", "codename": "0", "name": "Currency 0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Currency. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
dashboard_types
list
Lists Dashboard Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Name for Dashboard Type #1", "description": "Description for Dashboard Type #1", "codename": "Codename for Dashboard Type #1" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Dashboard Type.
Example request:
{ "codename": "Codename for Dashboard Type #1", "name": "Name for Dashboard Type #1", "description": "Description for Dashboard Type #1" }
Example response:
{ "id": 126375846344, "name": "Name for Dashboard Type #1", "description": "Description for Dashboard Type #1", "codename": "Codename for Dashboard Type #1" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Dashboard Type (not null, not blank, unique) |
description | Description of the Dashboard Type (null, blank) |
codename required | Codename of the Dashboard Type (not null, not blank, unique) |
read
Returns Dashboard Type by ID.
Example response:
{ "id": 126375846344, "name": "Name for Dashboard Type #1", "description": "Description for Dashboard Type #1", "codename": "Codename for Dashboard Type #1" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Dashboard Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Dashboard Type.
Example request:
{ "codename": "Codename for Dashboard Type #1", "name": "Name for Dashboard Type #1", "description": "Description for Dashboard Type #1" }
Example response:
{ "id": 126375846344, "name": "Name for Dashboard Type #1", "description": "Description for Dashboard Type #1", "codename": "Codename for Dashboard Type #1" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Dashboard Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Dashboard Type (not null, not blank, unique) |
description | Description of the Dashboard Type (null, blank) |
codename required | Codename of the Dashboard Type (not null, not blank, unique) |
partial_update
Partially updates Dashboard Type.
Example request:
{ "codename": "Codename for Dashboard Type #1", "name": "Name for Dashboard Type #1", "description": "Description for Dashboard Type #1" }
Example response:
{ "id": 126375846344, "name": "Name for Dashboard Type #1", "description": "Description for Dashboard Type #1", "codename": "Codename for Dashboard Type #1" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Dashboard Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Dashboard Type (not null, not blank, unique) |
description | Description of the Dashboard Type (null, blank) |
codename | Codename of the Dashboard Type (not null, not blank, unique) |
delete
A viewset used for retrieving and editing stored Dashboard Types.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Dashboard Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
dashboards
list
Lists Dashboards.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
dashboard_type | Filters Dashboard by Dashboard Type IDs (list) |
grafana_uid | Filters Dashboard by Grafana UIDs (list) |
id | Filters entities by IDs (list) |
machine | Filters Dashboard by Machine IDs (list) |
model_environment | Filters Dashboard by Model Environment IDs (list) |
not_dashboard_type | Filters Dashboard by Dashboard Type IDs (list) (inverse) |
not_grafana_uid | Filters Dashboard by Grafana UIDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Dashboard by Machine IDs (list) (inverse) |
not_model_environment | Filters Dashboard by Model Environment IDs (list) (inverse) |
create
Creates Dashboard.
Example request:
{ "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Example response:
{ "id": 126375846344, "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine required | Machine that Dashboard displays |
dashboard_type required | Dashboard Type for Dashboard |
model_environment required | Model Environment of Dashboard |
grafana_id required | Grafana Dashboard ID |
grafana_uid required | Grafana Dashboard UID |
read
Returns Dashboard by ID.
Example response:
{ "id": 126375846344, "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Dashboard. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Dashboard.
Example request:
{ "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Example response:
{ "id": 126375846344, "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Dashboard. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
grafana_id required | Grafana Dashboard ID |
grafana_uid required | Grafana Dashboard UID |
partial_update
Partially updates Dashboard.
Example request:
{ "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Example response:
{ "id": 126375846344, "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Dashboard. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
grafana_id | Grafana Dashboard ID |
grafana_uid | Grafana Dashboard UID |
delete
Deletes Dashboard.
Example response:
{ "id": 126375846344, "machine": 126375846344, "dashboard_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Dashboard. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
default_model_deployments
list
Lists Default Model Deployments.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "default_model_deployment_0", "model_deployment": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
codename | Filters Default Model Deployments by codenames (list) |
id | Filters entities by IDs (list) |
not_codename | Filters Default Model Deployments by codenames (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
read
Returns Default Model Deployment by ID.
Example response:
{ "id": 126375846344, "codename": "default_model_deployment_0", "model_deployment": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Default Model Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
device_configuration
partial_update
Partially updates Devices, Channels and Placements in one transaction. All entities must include current ID. For details, see partial update on Devices, Channels and Placements.
Example request:
{ "devices": [ { "id": 209, "recording_plan": "3per60" } ], "channels": [ { "id": 2172, "gain": 40, "placement": 437 }, { "id": 2173, "gain": 20, "placement": 433 } ], "placements": [ { "id": 437, "running_threshold": 0.3 }, { "id": 433, "running_threshold": 0.7 } ] }
Example response:
{ "devices": [ { "id": 209, "name": "10546", "note": "AB", "internet_connection": "LTE", "version": 532, "telephone_number": null, "carrier": "None", "has_sdcard": false, "mac_address": "0a:f1:6b:3c:f7:9a", "has_hdd": false, "serial_uid": "4rolhfh8oil3", "status": "new", "project": 13, "channels": [ 2172, 2173, 2174, 2175, 2176, 2177, 2178, 2179, 2180, 2181, 2182, 2183 ], "channel_count": 12, "assigned_channel_count": 7, "assigned_placements": [ 437, 433, 434, 435, 436, 438, null, 439, null, null, null, null ], "facility": 33, "company": 8, "machines": [ 579 ], "recording_plan": "3per60", "edge_discard_audio": false } ], "channels": [ { "id": 2172, "device": 209, "state": null, "placement": 437, "number": 1, "note": "", "gain": 40 }, { "id": 2173, "device": 209, "state": null, "placement": 433, "number": 2, "note": "", "gain": 20 } ], "placements": [ { "id": 437, "machine": 579, "type": 94, "qr_code": null, "panel_id": null, "custom_name": null, "placement_type_name": "Motor - axial mount", "channel": 2172, "is_enabled": true, "running_threshold": 0.3 }, { "id": 433, "machine": 579, "type": 25, "qr_code": "", "panel_id": null, "custom_name": "custom name 2", "placement_type_name": "N 2020-04-15T21:27:40.652Z u pu", "channel": 2173, "is_enabled": false, "running_threshold": 0.7 } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
devices | List of Device details in a JSON format. |
channels | List of Channel details in a JSON format. |
placements | List of Placement details in a JSON format. |
device_configuration_change_request_statuses
list
Lists Device Configuration Change Request Statuses.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
read
Returns Device Configuration Change Request Status by ID.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Configuration Change Request Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
device_configuration_change_requests
list
Lists Device Configuration Change Requests.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
device | Filters Device Configuration Change Requests by Device IDs (list) |
id | Filters entities by IDs (list) |
not_device | Filters Device Configuration Change Requests by Device IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_status | Filters Device Configuration Change Requests by Device Configuration Change Request Statuses (codenames; list) (inverse) |
status | Filters Device Configuration Change Requests by Device Configuration Change Request Statuses (codenames; list) |
read
Returns Device Configuration Change Request by ID.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Configuration Change Request. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
device_recording_plans
list
Lists Device Recording Plans.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
read
Returns Device Recording Plan by ID.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Recording Plan. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
device_statuses
list
Lists Device Statuses.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "DeviceStatus 2", "codename": "devicestatus2" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Device Status.
Example request:
{ "codename": "devicestatus2", "name": "DeviceStatus 2" }
Example response:
{ "id": 126375846344, "name": "DeviceStatus 2", "codename": "devicestatus2" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Device Status (not null, not blank, unique) |
codename required | Codename of the Device Status (not null, not blank, unique) |
read
Returns Device Status by ID.
Example response:
{ "id": 126375846344, "name": "DeviceStatus 2", "codename": "devicestatus2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Device Status.
Example request:
{ "codename": "devicestatus2", "name": "DeviceStatus 2" }
Example response:
{ "id": 126375846344, "name": "DeviceStatus 2", "codename": "devicestatus2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Device Status (not null, not blank, unique) |
codename required | Codename of the Device Status (not null, not blank, unique) |
partial_update
Partially updates Device Status.
Example request:
{ "codename": "devicestatus2", "name": "DeviceStatus 2" }
Example response:
{ "id": 126375846344, "name": "DeviceStatus 2", "codename": "devicestatus2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device Status (not null, not blank, unique) |
codename | Codename of the Device Status (not null, not blank, unique) |
delete
Deletes Device Status.
Example response:
{ "id": 126375846344, "name": "DeviceStatus 2", "codename": "devicestatus2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
device_types
list
Lists Device Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "device_versions": [], "name": "Device Type #2", "description": "Description for Device Type #2", "codename": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Device Type.
Example request:
{ "name": "Device Type #2", "description": "Description for Device Type #2" }
Example response:
{ "id": 126375846344, "device_versions": [], "name": "Device Type #2", "description": "Description for Device Type #2", "codename": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Device Type (not null, not blank, unique) |
description | Description of the Device Type (null, blank) |
codename | Codename of the Device Type (null, blank) |
read
Returns Device Type by ID.
Example response:
{ "id": 126375846344, "device_versions": [], "name": "Device Type #2", "description": "Description for Device Type #2", "codename": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Device Type.
Example request:
{ "name": "Device Type #2", "description": "Description for Device Type #2" }
Example response:
{ "id": 126375846344, "device_versions": [], "name": "Device Type #2", "description": "Description for Device Type #2", "codename": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Device Type (not null, not blank, unique) |
description | Description of the Device Type (null, blank) |
codename | Codename of the Device Type (null, blank) |
partial_update
Partially updates Device Type.
Example request:
{ "name": "Device Type #2", "description": "Description for Device Type #2" }
Example response:
{ "id": 126375846344, "device_versions": [], "name": "Device Type #2", "description": "Description for Device Type #2", "codename": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device Type (not null, not blank, unique) |
description | Description of the Device Type (null, blank) |
codename | Codename of the Device Type (null, blank) |
delete
Deletes Device Type.
Example response:
{ "id": 126375846344, "device_versions": [], "name": "Device Type #2", "description": "Description for Device Type #2", "codename": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
device_versions
list
Lists Device Versions.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "device_type": null, "name": "Device Version #2", "description": "Description for Device Version #2", "channels": null, "ad_converter_channels": null, "name_min": 10600, "name_max": 100000, "ad_converter_type": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
device_type | Filters Device Versions by Device Type IDs (list) |
id | Filters entities by IDs (list) |
not_device_type | Filters Device Versions by Device Type IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Device Version.
Example request:
{ "name": "Device Version #2", "description": "Description for Device Version #2" }
Example response:
{ "id": 126375846344, "device_type": null, "name": "Device Version #2", "description": "Description for Device Version #2", "channels": null, "ad_converter_channels": null, "name_min": 10600, "name_max": 100000, "ad_converter_type": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
device_type required | Device Type for the Device Version |
name required | Name of the Device Version (not null, not blank) |
description | Description of the Device Version (null, blank) |
channels | Number of Channels for this Device Version (null, blank) |
ad_converter_channels | Number of AD Converter Channels for this Device Version (null, blank) |
name_min | Minimum number of Device name for this Device Version (not null, not blank) |
name_max | Maximum number of Device name for this Device Version (not null, not blank) |
ad_converter_type | AD Converter Type (null, blank) |
read
Returns Device Version by ID.
Example response:
{ "id": 126375846344, "device_type": null, "name": "Device Version #2", "description": "Description for Device Version #2", "channels": null, "ad_converter_channels": null, "name_min": 10600, "name_max": 100000, "ad_converter_type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Version. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Device Version.
Example request:
{ "name": "Device Version #2", "description": "Description for Device Version #2" }
Example response:
{ "id": 126375846344, "device_type": null, "name": "Device Version #2", "description": "Description for Device Version #2", "channels": null, "ad_converter_channels": null, "name_min": 10600, "name_max": 100000, "ad_converter_type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Version. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Device Version (not null, not blank) |
description | Description of the Device Version (null, blank) |
channels | Number of Channels for this Device Version (null, blank) |
ad_converter_channels | Number of AD Converter Channels for this Device Version (null, blank) |
name_min | Minimum number of Device name for this Device Version (not null, not blank) |
name_max | Maximum number of Device name for this Device Version (not null, not blank) |
ad_converter_type | AD Converter Type (null, blank) |
partial_update
Partially updates Device Version.
Example request:
{ "name": "Device Version #2", "description": "Description for Device Version #2" }
Example response:
{ "id": 126375846344, "device_type": null, "name": "Device Version #2", "description": "Description for Device Version #2", "channels": null, "ad_converter_channels": null, "name_min": 10600, "name_max": 100000, "ad_converter_type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Version. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device Version (not null, not blank) |
description | Description of the Device Version (null, blank) |
channels | Number of Channels for this Device Version (null, blank) |
ad_converter_channels | Number of AD Converter Channels for this Device Version (null, blank) |
name_min | Minimum number of Device name for this Device Version (not null, not blank) |
name_max | Maximum number of Device name for this Device Version (not null, not blank) |
ad_converter_type | AD Converter Type (null, blank) |
delete
Deletes Device Version.
Example response:
{ "id": 126375846344, "device_type": null, "name": "Device Version #2", "description": "Description for Device Version #2", "channels": null, "ad_converter_channels": null, "name_min": 10600, "name_max": 100000, "ad_converter_type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device Version. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
devices
list
Lists Devices.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": null, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
audio_format | Filters Devices by audio formats (list) |
company | Filters Devices by Company IDs (list) |
connected | Filters Devices by connected/not connected Status (single value) |
has_hdd | Filters Devices by having HDD (single value) |
has_sdcard | Filters Devices by having SD card (single value) |
health | Filters Devices by health (list) |
id | Filters entities by IDs (list) |
internet_connection | Filters Devices by internet connection types (list) |
is_deleted | Filters Devices by is_deleted (single value) |
name | Filters Devices by names (list) |
not_audio_format | Filters Devices by audio formats (list) (inverse) |
not_company | Filters Devices by Company IDs (list) (inverse) |
not_connected | Filters Devices by connected/not connected Status (single value) (inverse) |
not_has_hdd | Filters Devices by having HDD (single value) (inverse) |
not_has_sdcard | Filters Devices by having SD card (single value) (inverse) |
not_health | Filters Devices by health (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_internet_connection | Filters Devices by internet connection types (list) (inverse) |
not_is_deleted | Filters Devices by is_deleted (single value) (inverse) |
not_name | Filters Devices by names (list) (inverse) |
not_project | Filters Devices by Project IDs (list) (inverse) |
not_q | Filters Devices by search in name/UID (single value) (inverse) |
not_serial_uid | Filters Devices by serial UIDs (list) (inverse) |
not_status | Filters Devices by Device Status (codenames; list) (inverse) |
not_type | Filters Devices by Device Type IDs (list) (inverse) |
not_version | Filters Devices by Device Version IDs (list) (inverse) |
project | Filters Devices by Project IDs (list) |
q | Filters Devices by search in name/UID (single value) |
serial_uid | Filters Devices by serial UIDs (list) |
status | Filters Devices by Device Status (codenames; list) |
type | Filters Devices by Device Type IDs (list) |
version | Filters Devices by Device Version IDs (list) |
create
Creates Device.
Example request:
{ "name": "10602", "internet_connection": "LTE", "carrier": "None", "telephone_number": "420000000002", "mac_address": "11:22:33:44:55:02", "has_sdcard": false, "has_hdd": false, "version": 126375846344, "note": "Note for dev-10602", "serial_uid": "abcdefgh0002", "is_deleted": false, "status": "devicestatus3", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": null, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device, usually dev-10XXX (null, blank, unique) |
note | Additional note for the Device (null, blank) |
internet_connection | Internet connection type of the Device (not null, not blank, must be one of LTE, ETHERNET, WIFI) |
version | Device Version for the Device (null) |
telephone_number | Indentification number of SIM card present in the Device (null, blank) |
carrier | Carrier info for the Device (not null, not blank, must be one of Vodafone, T-mobile, O2, 4ka, None) |
has_sdcard | Whether the Device has SD card inserted (not null) |
mac_address | MAC Address of the Device (null, blank) |
has_hdd | Whether the Device has external hard drive (not null) |
serial_uid | Unique installation key of the Device for customers (not null, not blank) |
status required | Device Status of the Device (not null) |
project | Project of the Device (null) |
recording_plan | Device Recording Plan of the Device (not null) |
is_deleted | Whether the Device is deleted |
model_image | Model image |
sampling_frequency | Sampling rate for the Device in Hz (not null, must be one of 22050, 44100, 48000) |
current_model_deployed | Model Deployment |
edge_discard_audio | Whether to discard nonvaluable audio instead of uploading it to API when Edge model runs on the Device |
generate_name |
activation
Activates Device with given serial number.
Example request:
{ "serial_uid": "abcdefgh0002", "project": 1234 }
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": 1234, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
serial_uid required | Device serial UID |
project required | Project ID |
flash_device
Flashes Device with given serial number.
Example request:
{ "serial_uid": "abcdefgh0002", "password": "X7sd93fAh4d" }
Example response:
{ "status": true }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
serial_uid required | Device serial UID |
password required | Device password |
retrieve_by_name
Returns Device with given name.
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": null, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Device name |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
retrieve_by_uid
Returns Device with given serial number.
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": null, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uid required | Device serial UID |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
read
Returns Device by ID.
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": null, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Device.
Example request:
{ "name": "10602", "internet_connection": "LTE", "carrier": "None", "telephone_number": "420000000002", "mac_address": "11:22:33:44:55:02", "has_sdcard": false, "has_hdd": false, "version": 126375846344, "note": "Note for dev-10602", "serial_uid": "abcdefgh0002", "is_deleted": false, "status": "devicestatus3", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": 3, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device, usually dev-10XXX (null, blank, unique) |
note | Additional note for the Device (null, blank) |
internet_connection | Internet connection type of the Device (not null, not blank, must be one of LTE, ETHERNET, WIFI) |
version | Device Version for the Device (null) |
telephone_number | Indentification number of SIM card present in the Device (null, blank) |
carrier | Carrier info for the Device (not null, not blank, must be one of Vodafone, T-mobile, O2, 4ka, None) |
has_sdcard | Whether the Device has SD card inserted (not null) |
mac_address | MAC Address of the Device (null, blank) |
has_hdd | Whether the Device has external hard drive (not null) |
serial_uid | Unique installation key of the Device for customers (not null, not blank) |
status required | Device Status of the Device (not null) |
project | Project of the Device (null) |
recording_plan | Device Recording Plan of the Device (not null) |
is_deleted | Whether the Device is deleted |
model_image | Model image |
sampling_frequency | Sampling rate for the Device in Hz (not null, must be one of 22050, 44100, 48000) |
current_model_deployed | Model Deployment |
edge_discard_audio | Whether to discard nonvaluable audio instead of uploading it to API when Edge model runs on the Device |
generate_name |
partial_update
Partially updates Device.
Example request:
{ "name": "10602", "internet_connection": "LTE", "carrier": "None", "telephone_number": "420000000002", "mac_address": "11:22:33:44:55:02", "has_sdcard": false, "has_hdd": false, "version": 126375846344, "note": "Note for dev-10602", "serial_uid": "abcdefgh0002", "is_deleted": false, "status": "devicestatus3", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": 3, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device, usually dev-10XXX (null, blank, unique) |
note | Additional note for the Device (null, blank) |
internet_connection | Internet connection type of the Device (not null, not blank, must be one of LTE, ETHERNET, WIFI) |
version | Device Version for the Device (null) |
telephone_number | Indentification number of SIM card present in the Device (null, blank) |
carrier | Carrier info for the Device (not null, not blank, must be one of Vodafone, T-mobile, O2, 4ka, None) |
has_sdcard | Whether the Device has SD card inserted (not null) |
mac_address | MAC Address of the Device (null, blank) |
has_hdd | Whether the Device has external hard drive (not null) |
serial_uid | Unique installation key of the Device for customers (not null, not blank) |
status | Device Status of the Device (not null) |
project | Project of the Device (null) |
recording_plan | Device Recording Plan of the Device (not null) |
is_deleted | Whether the Device is deleted |
model_image | Model image |
sampling_frequency | Sampling rate for the Device in Hz (not null, must be one of 22050, 44100, 48000) |
current_model_deployed | Model Deployment |
edge_discard_audio | Whether to discard nonvaluable audio instead of uploading it to API when Edge model runs on the Device |
generate_name |
delete
Marks Device as deleted.
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": 3, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
channels
Lists Channels for specified Device.
Example response:
{ "id": 1885, "device": 120, "state": null, "placement": null, "number": 1, "note": null, "gain": 20 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
configuration_change_requests
Lists Device Configuration Change Requests for specified Device.
Example response:
{ "id": 61533, "status": "sent", "created_at": "2021-02-18T09:56:36.371622Z", "content": { "project": null, "channels": [ { "no": 1, "gain": 20, "placement": null }, { "no": 2, "gain": 20, "placement": null } ], "serial_uid": "ldhn5o48n19k", "recording_plan": { "type": "custom", "settings": {} } }, "reason": null, "device": 120, "user": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
connectable_machines
Lists Connectable Machines for specified Device.
Example response:
{ "id": 43, "name": "Trolleys Line1", "subcategory": 9, "station": 138, "description": "Trolleys Line", "qr_code": null, "record_length": 15, "recording_period": 3, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": null, "recording_ranges": [], "recording_gate_level": null, "facility": 39, "project": 22, "company": 10, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": true, "suppress_notifications_until": null, "is_generating_dashboards": true }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
deactivation
Deactivates given Device.
Example request:
{}
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": null, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
move
Moves Device to given Project.
Example request:
{ "project": 3 }
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": 3, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be "application/json"
encoded, and should contain a single item.
Parameter | Description |
---|---|
project required | Project ID. |
test_logs > list
Lists Test Logs.
Example response:
[ { "id": 1, "log": "Device self-test passed", "time": "2021-03-05T11:34:29.450553Z", "user": 123 } ]
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
test_logs > create
Creates Test Log.
Example request:
{ "log": "Device self-test passed" }
Example response:
{ "id": 1, "log": "Device self-test passed", "time": "2021-03-05T11:34:29.450553Z", "user": 123 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device, usually dev-10XXX (null, blank, unique) |
note | Additional note for the Device (null, blank) |
internet_connection | Internet connection type of the Device (not null, not blank, must be one of LTE, ETHERNET, WIFI) |
version | Device Version for the Device (null) |
telephone_number | Indentification number of SIM card present in the Device (null, blank) |
carrier | Carrier info for the Device (not null, not blank, must be one of Vodafone, T-mobile, O2, 4ka, None) |
has_sdcard | Whether the Device has SD card inserted (not null) |
mac_address | MAC Address of the Device (null, blank) |
has_hdd | Whether the Device has external hard drive (not null) |
serial_uid | Unique installation key of the Device for customers (not null, not blank) |
status required | Device Status of the Device (not null) |
project | Project of the Device (null) |
recording_plan | Device Recording Plan of the Device (not null) |
is_deleted | Whether the Device is deleted |
model_image | Model image |
sampling_frequency | Sampling rate for the Device in Hz (not null, must be one of 22050, 44100, 48000) |
current_model_deployed | Model Deployment |
edge_discard_audio | Whether to discard nonvaluable audio instead of uploading it to API when Edge model runs on the Device |
generate_name |
test_logs > read
Returns Test Log by ID.
Example response:
{ "id": 1, "log": "Device self-test passed", "time": "2021-03-05T11:34:29.450553Z", "user": 123 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
test_log_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
test_logs > update
Updates Test Log.
Example request:
{ "log": "Device self-test passed" }
Example response:
{ "id": 1, "log": "Device self-test passed", "time": "2021-03-05T11:34:29.450553Z", "user": 123 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
test_log_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device, usually dev-10XXX (null, blank, unique) |
note | Additional note for the Device (null, blank) |
internet_connection | Internet connection type of the Device (not null, not blank, must be one of LTE, ETHERNET, WIFI) |
version | Device Version for the Device (null) |
telephone_number | Indentification number of SIM card present in the Device (null, blank) |
carrier | Carrier info for the Device (not null, not blank, must be one of Vodafone, T-mobile, O2, 4ka, None) |
has_sdcard | Whether the Device has SD card inserted (not null) |
mac_address | MAC Address of the Device (null, blank) |
has_hdd | Whether the Device has external hard drive (not null) |
serial_uid | Unique installation key of the Device for customers (not null, not blank) |
status required | Device Status of the Device (not null) |
project | Project of the Device (null) |
recording_plan | Device Recording Plan of the Device (not null) |
is_deleted | Whether the Device is deleted |
model_image | Model image |
sampling_frequency | Sampling rate for the Device in Hz (not null, must be one of 22050, 44100, 48000) |
current_model_deployed | Model Deployment |
edge_discard_audio | Whether to discard nonvaluable audio instead of uploading it to API when Edge model runs on the Device |
generate_name |
test_logs > partial_update
Partially updates Test Log.
Example request:
{ "log": "Device self-test passed" }
Example response:
{ "id": 1, "log": "Device self-test passed", "time": "2021-03-05T11:34:29.450553Z", "user": 123 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
test_log_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Device, usually dev-10XXX (null, blank, unique) |
note | Additional note for the Device (null, blank) |
internet_connection | Internet connection type of the Device (not null, not blank, must be one of LTE, ETHERNET, WIFI) |
version | Device Version for the Device (null) |
telephone_number | Indentification number of SIM card present in the Device (null, blank) |
carrier | Carrier info for the Device (not null, not blank, must be one of Vodafone, T-mobile, O2, 4ka, None) |
has_sdcard | Whether the Device has SD card inserted (not null) |
mac_address | MAC Address of the Device (null, blank) |
has_hdd | Whether the Device has external hard drive (not null) |
serial_uid | Unique installation key of the Device for customers (not null, not blank) |
status | Device Status of the Device (not null) |
project | Project of the Device (null) |
recording_plan | Device Recording Plan of the Device (not null) |
is_deleted | Whether the Device is deleted |
model_image | Model image |
sampling_frequency | Sampling rate for the Device in Hz (not null, must be one of 22050, 44100, 48000) |
current_model_deployed | Model Deployment |
edge_discard_audio | Whether to discard nonvaluable audio instead of uploading it to API when Edge model runs on the Device |
generate_name |
test_logs > delete
A viewset used for retrieving and editing Device instances.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Device. |
test_log_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
uid > retrieve_channels_by_uid
Returns Channels of Device with given serial number.
Example response:
{ "id": 126375846344, "name": "10602", "note": "Note for dev-10602", "internet_connection": "LTE", "version": 126375846344, "telephone_number": "420000000002", "carrier": "None", "has_sdcard": false, "mac_address": "11:22:33:44:55:02", "has_hdd": false, "serial_uid": "abcdefgh0002", "status": "devicestatus3", "project": null, "channels": [], "channel_count": 0, "assigned_channel_count": 0, "assigned_placements": [], "facility": null, "company": null, "machines": [], "recording_plan": "device_recording_plan2", "is_deleted": false, "model_image": "image2", "sampling_frequency": 22050, "current_model_deployed": null, "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
docs_swagger
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
environments
list
Lists Environments.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Environment #0", "description": "Description for Environment #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Environment.
Example request:
{ "name": "Environment #0", "description": "Description for Environment #0" }
Example response:
{ "id": 126375846344, "name": "Environment #0", "description": "Description for Environment #0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Environment (not null, not blank) |
description | Description of the Environment (null, blank) |
read
Returns Environment by ID.
Example response:
{ "id": 126375846344, "name": "Environment #0", "description": "Description for Environment #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Environment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Environment.
Example request:
{ "name": "Environment #0", "description": "Description for Environment #0" }
Example response:
{ "id": 126375846344, "name": "Environment #0", "description": "Description for Environment #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Environment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Environment (not null, not blank) |
description | Description of the Environment (null, blank) |
partial_update
Partially updates Environment.
Example request:
{ "name": "Environment #0", "description": "Description for Environment #0" }
Example response:
{ "id": 126375846344, "name": "Environment #0", "description": "Description for Environment #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Environment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Environment (not null, not blank) |
description | Description of the Environment (null, blank) |
delete
Deletes Environment.
Example response:
{ "id": 126375846344, "name": "Environment #0", "description": "Description for Environment #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Environment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
event_attachments
list
Lists Event Attachments.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "event": null, "created_at": "2024-03-29T00:38:23.694503Z", "attachment": "test.txt", "mime_type": "", "created_by_user": null, "modified_by_user": null, "link": "https://storage.googleapis.com/sw_api/test.txt?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4865274137&Signature=Egr9WS3Y1GSIxkRsYom5fRu5jaekYQmx0Z8x1MbzlbGqc73BFVKGanHMnUfci0118IBABwxA5edoQeqoQe3DMDtmCYkHlkzBYfkgk%2BUWWQZ7nPCJVVsL9hr5LiA4JhLVKRP65%2Fw0LQdHvw0u95DYpXQaRChXdS6y2rDRAYdovHVsCGtvai0Pbu4oRC%2FZKoVUqssk83ZwcnBrvQVeNUecRelzqNdRWD7ydDzrW%2BA5ZSmUGLUPKUcA5BjvWi57RbMv3bDXthqSQEYuCKG3G%2BK2AF%2B5nLmQRMFZtLWPTUWqj2glyzYMP4g41EG9oqqrhLGEExFPIs0Ex7lKhTPbw86kEg%3D%3D", "machine": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
event | Filters Event Attachments by related Event IDs (list) |
id | Filters entities by IDs (list) |
machine | Filters Event Attachments by related Machine IDs (list) |
not_event | Filters Event Attachments by related Event IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Event Attachments by related Machine IDs (list) (inverse) |
create
Creates Event Attachment.
Example request:
{ "event": null, "attachment": "test.txt", "machine": null }
Example response:
{ "id": 126375846344, "event": null, "created_at": "2024-03-29T00:38:23.694503Z", "attachment": "test.txt", "mime_type": "", "created_by_user": null, "modified_by_user": null, "link": "https://storage.googleapis.com/sw_api/test.txt?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4865274137&Signature=Egr9WS3Y1GSIxkRsYom5fRu5jaekYQmx0Z8x1MbzlbGqc73BFVKGanHMnUfci0118IBABwxA5edoQeqoQe3DMDtmCYkHlkzBYfkgk%2BUWWQZ7nPCJVVsL9hr5LiA4JhLVKRP65%2Fw0LQdHvw0u95DYpXQaRChXdS6y2rDRAYdovHVsCGtvai0Pbu4oRC%2FZKoVUqssk83ZwcnBrvQVeNUecRelzqNdRWD7ydDzrW%2BA5ZSmUGLUPKUcA5BjvWi57RbMv3bDXthqSQEYuCKG3G%2BK2AF%2B5nLmQRMFZtLWPTUWqj2glyzYMP4g41EG9oqqrhLGEExFPIs0Ex7lKhTPbw86kEg%3D%3D", "machine": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | Event this Attachment belongs to |
attachment required | Attachment for the Event (not null, not blank) |
machine | Machine this Attachment belongs to |
read
Returns Event Attachment by ID.
Example response:
{ "id": 126375846344, "event": null, "created_at": "2024-03-29T00:38:23.694503Z", "attachment": "test.txt", "mime_type": "", "created_by_user": null, "modified_by_user": null, "link": "https://storage.googleapis.com/sw_api/test.txt?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4865274137&Signature=Egr9WS3Y1GSIxkRsYom5fRu5jaekYQmx0Z8x1MbzlbGqc73BFVKGanHMnUfci0118IBABwxA5edoQeqoQe3DMDtmCYkHlkzBYfkgk%2BUWWQZ7nPCJVVsL9hr5LiA4JhLVKRP65%2Fw0LQdHvw0u95DYpXQaRChXdS6y2rDRAYdovHVsCGtvai0Pbu4oRC%2FZKoVUqssk83ZwcnBrvQVeNUecRelzqNdRWD7ydDzrW%2BA5ZSmUGLUPKUcA5BjvWi57RbMv3bDXthqSQEYuCKG3G%2BK2AF%2B5nLmQRMFZtLWPTUWqj2glyzYMP4g41EG9oqqrhLGEExFPIs0Ex7lKhTPbw86kEg%3D%3D", "machine": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Attachment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Event Attachment.
Example request:
{ "event": null, "attachment": "test.txt", "machine": null }
Example response:
{ "id": 126375846344, "event": null, "created_at": "2024-03-29T00:38:23.694503Z", "attachment": "test.txt", "mime_type": "", "created_by_user": null, "modified_by_user": null, "link": "https://storage.googleapis.com/sw_api/test.txt?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4865274137&Signature=Egr9WS3Y1GSIxkRsYom5fRu5jaekYQmx0Z8x1MbzlbGqc73BFVKGanHMnUfci0118IBABwxA5edoQeqoQe3DMDtmCYkHlkzBYfkgk%2BUWWQZ7nPCJVVsL9hr5LiA4JhLVKRP65%2Fw0LQdHvw0u95DYpXQaRChXdS6y2rDRAYdovHVsCGtvai0Pbu4oRC%2FZKoVUqssk83ZwcnBrvQVeNUecRelzqNdRWD7ydDzrW%2BA5ZSmUGLUPKUcA5BjvWi57RbMv3bDXthqSQEYuCKG3G%2BK2AF%2B5nLmQRMFZtLWPTUWqj2glyzYMP4g41EG9oqqrhLGEExFPIs0Ex7lKhTPbw86kEg%3D%3D", "machine": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Attachment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | Event this Attachment belongs to |
attachment required | Attachment for the Event (not null, not blank) |
machine | Machine this Attachment belongs to |
partial_update
Partially updates Event Attachment.
Example request:
{ "event": null, "attachment": "test.txt", "machine": null }
Example response:
{ "id": 126375846344, "event": null, "created_at": "2024-03-29T00:38:23.694503Z", "attachment": "test.txt", "mime_type": "", "created_by_user": null, "modified_by_user": null, "link": "https://storage.googleapis.com/sw_api/test.txt?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4865274137&Signature=Egr9WS3Y1GSIxkRsYom5fRu5jaekYQmx0Z8x1MbzlbGqc73BFVKGanHMnUfci0118IBABwxA5edoQeqoQe3DMDtmCYkHlkzBYfkgk%2BUWWQZ7nPCJVVsL9hr5LiA4JhLVKRP65%2Fw0LQdHvw0u95DYpXQaRChXdS6y2rDRAYdovHVsCGtvai0Pbu4oRC%2FZKoVUqssk83ZwcnBrvQVeNUecRelzqNdRWD7ydDzrW%2BA5ZSmUGLUPKUcA5BjvWi57RbMv3bDXthqSQEYuCKG3G%2BK2AF%2B5nLmQRMFZtLWPTUWqj2glyzYMP4g41EG9oqqrhLGEExFPIs0Ex7lKhTPbw86kEg%3D%3D", "machine": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Attachment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | Event this Attachment belongs to |
attachment | Attachment for the Event (not null, not blank) |
machine | Machine this Attachment belongs to |
delete
Deletes Event Attachment.
Example response:
{ "id": 126375846344, "event": null, "created_at": "2024-03-29T00:38:23.694503Z", "attachment": "test.txt", "mime_type": "", "created_by_user": null, "modified_by_user": null, "link": "https://storage.googleapis.com/sw_api/test.txt?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4865274137&Signature=Egr9WS3Y1GSIxkRsYom5fRu5jaekYQmx0Z8x1MbzlbGqc73BFVKGanHMnUfci0118IBABwxA5edoQeqoQe3DMDtmCYkHlkzBYfkgk%2BUWWQZ7nPCJVVsL9hr5LiA4JhLVKRP65%2Fw0LQdHvw0u95DYpXQaRChXdS6y2rDRAYdovHVsCGtvai0Pbu4oRC%2FZKoVUqssk83ZwcnBrvQVeNUecRelzqNdRWD7ydDzrW%2BA5ZSmUGLUPKUcA5BjvWi57RbMv3bDXthqSQEYuCKG3G%2BK2AF%2B5nLmQRMFZtLWPTUWqj2glyzYMP4g41EG9oqqrhLGEExFPIs0Ex7lKhTPbw86kEg%3D%3D", "machine": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Attachment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
event_comments
list
Lists Event Comments.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "event": null, "note": "Note for Event #0", "created_at": "2024-03-29T00:38:23.694391+0000", "created_by_user": null, "modified_by_user": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
event | Filters Event Comments by related Event IDs (list) |
id | Filters entities by IDs (list) |
not_event | Filters Event Comments by related Event IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Event Comment.
Example request:
{ "event": null, "note": "Note for Event #0" }
Example response:
{ "id": 126375846344, "event": null, "note": "Note for Event #0", "created_at": "2024-03-29T00:38:23.694391+0000", "created_by_user": null, "modified_by_user": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | Event this Comment belongs to |
note required | Note for the Event (not null, not blank) |
read
Returns Event Comment by ID.
Example response:
{ "id": 126375846344, "event": null, "note": "Note for Event #0", "created_at": "2024-03-29T00:38:23.694391+0000", "created_by_user": null, "modified_by_user": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Event Comment.
Example request:
{ "event": null, "note": "Note for Event #0" }
Example response:
{ "id": 126375846344, "event": null, "note": "Note for Event #0", "created_at": "2024-03-29T00:38:23.694391+0000", "created_by_user": null, "modified_by_user": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | Event this Comment belongs to |
note required | Note for the Event (not null, not blank) |
partial_update
Partially updates Event Comment.
Example request:
{ "event": null, "note": "Note for Event #0" }
Example response:
{ "id": 126375846344, "event": null, "note": "Note for Event #0", "created_at": "2024-03-29T00:38:23.694391+0000", "created_by_user": null, "modified_by_user": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | Event this Comment belongs to |
note | Note for the Event (not null, not blank) |
delete
Deletes Event Comment.
Example response:
{ "id": 126375846344, "event": null, "note": "Note for Event #0", "created_at": "2024-03-29T00:38:23.694391+0000", "created_by_user": null, "modified_by_user": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
event_placement_failures
list
Lists Event Placement Failures.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
event | Filters Event Placement Failures by Event IDs (list) |
id | Filters entities by IDs (list) |
not_event | Filters Event Placement Failures by Event IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Event Placement Failure.
Example request:
{ "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" }
Example response:
{ "id": 126375846344, "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | Event |
placement required | Placement |
failure | Failure |
other_failure | Other Failure (null, blank) |
note | Note for the Failure (null, blank) |
read
Returns Event Placement Failures by ID.
Example response:
{ "id": 126375846344, "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Placement Failure. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Event Placement Failure.
Example request:
{ "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" }
Example response:
{ "id": 126375846344, "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Placement Failure. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | Event |
placement required | Placement |
failure | Failure |
other_failure | Other Failure (null, blank) |
note | Note for the Failure (null, blank) |
partial_update
Partially updates Event Placement Failure.
Example request:
{ "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" }
Example response:
{ "id": 126375846344, "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Placement Failure. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | Event |
placement | Placement |
failure | Failure |
other_failure | Other Failure (null, blank) |
note | Note for the Failure (null, blank) |
delete
Deletes Event Placement Failure.
Example response:
{ "id": 126375846344, "event": null, "placement": null, "failure": null, "other_failure": null, "note": "Note for Event Placement Failure #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Placement Failure. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
event_statuses
list
Lists Event Statuses.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Event Status name #0", "codename": "Event Status codename #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Event Status.
Example request:
{ "name": "Event Status name #0", "codename": "Event Status codename #0" }
Example response:
{ "id": 126375846344, "name": "Event Status name #0", "codename": "Event Status codename #0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Event Status (not null, not blank, unique) |
codename required | Codename of the Event Status (not null, not blank, unique) |
read
Returns Event Status by ID.
Example response:
{ "id": 126375846344, "name": "Event Status name #0", "codename": "Event Status codename #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Event Status.
Example request:
{ "name": "Event Status name #0", "codename": "Event Status codename #0" }
Example response:
{ "id": 126375846344, "name": "Event Status name #0", "codename": "Event Status codename #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Event Status (not null, not blank, unique) |
codename required | Codename of the Event Status (not null, not blank, unique) |
partial_update
Partially updates Event Status.
Example request:
{ "name": "Event Status name #0", "codename": "Event Status codename #0" }
Example response:
{ "id": 126375846344, "name": "Event Status name #0", "codename": "Event Status codename #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Event Status (not null, not blank, unique) |
codename | Codename of the Event Status (not null, not blank, unique) |
delete
Deletes Event Status.
Example response:
{ "id": 126375846344, "name": "Event Status name #0", "codename": "Event Status codename #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Status. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
event_type_event_statuses
list
Lists Event Type to Event Status relations.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "status": "Event Status codename #1", "type": "eventtype3" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
event_type | Filters EventTypeEventStatus relations by Event Type IDs (list) |
id | Filters entities by IDs (list) |
not_event_type | Filters EventTypeEventStatus relations by Event Type IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Event Type to Event Status relation.
Example request:
{ "status": "Event Status codename #1", "type": "eventtype3" }
Example response:
{ "id": 126375846344, "status": "Event Status codename #1", "type": "eventtype3" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status required | Event Status |
type required | Event Type |
read
Returns Event Type to Event Status relation by ID.
Example response:
{ "id": 126375846344, "status": "Event Status codename #1", "type": "eventtype3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Type to Event Status relation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Event Type to Event Status.
Example request:
{ "status": "Event Status codename #1", "type": "eventtype3" }
Example response:
{ "id": 126375846344, "status": "Event Status codename #1", "type": "eventtype3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Type to Event Status relation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status required | Event Status |
type required | Event Type |
partial_update
Partially updates Event Type to Event Status relation.
Example request:
{ "status": "Event Status codename #1", "type": "eventtype3" }
Example response:
{ "id": 126375846344, "status": "Event Status codename #1", "type": "eventtype3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Type to Event Status relation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status | Event Status |
type | Event Type |
delete
Deletes Event Type to Event Status relation.
Example response:
{ "id": 126375846344, "status": "Event Status codename #1", "type": "eventtype3" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Type to Event Status relation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
event_types
list
Lists Event Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "grafana_type": null, "grafana_state": null, "codename": "eventtype4", "name": "EventType 4", "is_alert": true, "is_internal": true, "end_type": null, "allowed_master_types": [] } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_q | Filters Event Types by search in name (single value) (inverse) |
q | Filters Event Types by search in name (single value) |
create
Creates Event Type.
Example request:
{ "codename": "eventtype4", "name": "EventType 4", "grafana_type": null, "grafana_state": null, "is_alert": true }
Example response:
{ "id": 126375846344, "grafana_type": null, "grafana_state": null, "codename": "eventtype4", "name": "EventType 4", "is_alert": true, "is_internal": true, "end_type": null, "allowed_master_types": [] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
grafana_type | Given Grafana Type |
grafana_state | Given Grafana State |
codename required | Codename of Event Type |
name required | Name of Event Type |
is_alert | If given Event Type is Alert |
is_internal | If given Event Type is internal Event (only Users who may create ANY Event can create it) |
end_type | None if Event Type is not a start of an Event pair, otherwise ID of end Type for this start Type |
allowed_master_types | Allowed master Event Types for grouping |
read
Returns Event Type by ID.
Example response:
{ "id": 126375846344, "grafana_type": null, "grafana_state": null, "codename": "eventtype4", "name": "EventType 4", "is_alert": true, "is_internal": true, "end_type": null, "allowed_master_types": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Event Type.
Example request:
{ "codename": "eventtype4", "name": "EventType 4", "grafana_type": null, "grafana_state": null, "is_alert": true }
Example response:
{ "id": 126375846344, "grafana_type": null, "grafana_state": null, "codename": "eventtype4", "name": "EventType 4", "is_alert": true, "is_internal": true, "end_type": null, "allowed_master_types": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
grafana_type | Given Grafana Type |
grafana_state | Given Grafana State |
codename required | Codename of Event Type |
name required | Name of Event Type |
is_alert | If given Event Type is Alert |
is_internal | If given Event Type is internal Event (only Users who may create ANY Event can create it) |
end_type | None if Event Type is not a start of an Event pair, otherwise ID of end Type for this start Type |
allowed_master_types | Allowed master Event Types for grouping |
partial_update
Partially updates Event Type.
Example request:
{ "codename": "eventtype4", "name": "EventType 4", "grafana_type": null, "grafana_state": null, "is_alert": true }
Example response:
{ "id": 126375846344, "grafana_type": null, "grafana_state": null, "codename": "eventtype4", "name": "EventType 4", "is_alert": true, "is_internal": true, "end_type": null, "allowed_master_types": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
grafana_type | Given Grafana Type |
grafana_state | Given Grafana State |
codename | Codename of Event Type |
name | Name of Event Type |
is_alert | If given Event Type is Alert |
is_internal | If given Event Type is internal Event (only Users who may create ANY Event can create it) |
end_type | None if Event Type is not a start of an Event pair, otherwise ID of end Type for this start Type |
allowed_master_types | Allowed master Event Types for grouping |
delete
Deletes Event Type.
Example response:
{ "id": 126375846344, "grafana_type": null, "grafana_state": null, "codename": "eventtype4", "name": "EventType 4", "is_alert": true, "is_internal": true, "end_type": null, "allowed_master_types": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
events
list
Lists Events.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "type": "eventtype5", "meta": null, "machine": null, "alert_severity": "eventtype4", "created_at": "2024-03-29T00:38:23.694216Z", "related_pair_event": null, "related_event": null, "related_alerts": [], "master_alert": null, "grouped_alerts": [], "note": null, "created_by_user": null, "modified_by_user": null, "placements": [], "maintenance_type": null, "status": null, "presumed_causes": null, "recommended_action": null, "anomaly_trend": null, "diag_description": null, "is_critical": false, "is_hidden": false, "mail_last_sent_on": null, "has_attachment": false, "mail_sent": false, "estimated_prevented_damage_amount": "0.00", "estimated_prevented_damage_currency": "EUR" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
alert_severity | Filters Events by Alert Severity (codenames; list) |
communication_status | |
from | Filters Events by 'from' creation datetime (single value) |
grouped_alerts | Filters grouped Alerts by grouping Alert IDs (list) |
has_attachment | |
has_master_alert | Filters events by having/not having master alert (single value) |
id | Filters entities by IDs (list) |
is_critical | |
is_hidden | Filters Alerts by is_hidden (single value) |
is_mail_sent | |
machine | Filters Events by Machine IDs (list) |
not_alert_severity | Filters Events by Alert Severity (codenames; list) (inverse) |
not_communication_status | None (inverse) |
not_from | Filters Events by 'from' creation datetime (single value) (inverse) |
not_grouped_alerts | Filters grouped Alerts by grouping Alert IDs (list) (inverse) |
not_has_attachment | None (inverse) |
not_has_master_alert | Filters events by having/not having master alert (single value) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_is_critical | None (inverse) |
not_is_hidden | Filters Alerts by is_hidden (single value) (inverse) |
not_is_mail_sent | None (inverse) |
not_machine | Filters Events by Machine IDs (list) (inverse) |
not_q | Filters Events by search in text fields (presumed_causes, recommended_action, anomaly_trend, diag_description, note; single value) (inverse) |
not_status | Filters Events by Event Status (codenames; list) (inverse) |
not_to | Filters Events by 'to' creation datetime (single value) (inverse) |
not_type | Filters Events by Event Types (codenames; list) (inverse) |
q | Filters Events by search in text fields (presumed_causes, recommended_action, anomaly_trend, diag_description, note; single value) |
status | Filters Events by Event Status (codenames; list) |
to | Filters Events by 'to' creation datetime (single value) |
type | Filters Events by Event Types (codenames; list) |
create
Creates Event.
Example request:
{ "machine": null, "type": "eventtype5", "created_at": "2024-03-29T00:38:23.694216Z", "meta": null, "alert_severity": "eventtype4", "placements": [], "related_pair_event": null, "related_alerts": [], "master_alert": null, "grouped_alerts": [], "maintenance_type": null, "status": null, "presumed_causes": null, "recommended_action": null, "anomaly_trend": null, "diag_description": null, "is_hidden": false, "mail_last_sent_on": null, "estimated_prevented_damage_amount": "0.00", "estimated_prevented_damage_currency": "EUR" }
Example response:
{ "id": 126375846344, "type": "eventtype5", "meta": null, "machine": null, "alert_severity": "eventtype4", "created_at": "2024-03-29T00:38:23.694216Z", "related_pair_event": null, "related_event": null, "related_alerts": [], "master_alert": null, "grouped_alerts": [], "note": null, "created_by_user": null, "modified_by_user": null, "placements": [], "maintenance_type": null, "status": null, "presumed_causes": null, "recommended_action": null, "anomaly_trend": null, "diag_description": null, "is_critical": false, "is_hidden": false, "mail_last_sent_on": null, "has_attachment": false, "mail_sent": false, "estimated_prevented_damage_amount": "0.00", "estimated_prevented_damage_currency": "EUR" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type required | Type of the Event (not null, not blank) |
meta | Extra info on the Event (null, blank) |
machine required | Machine which the Event came for (not null, not blank) |
alert_severity | Alert Severity of the Event (null, blank) |
created_at required | Creation datetime of the Event (automatically set) |
related_pair_event | Related start Event of pair Event (for alerts) |
master_alert | Related Event which groups another Events (for alerts) |
placements | Placements of the Event |
maintenance_type | Maintenance Type |
status | Event Status |
presumed_causes | Presumed causes of the anomaly (for assisted alerts) (null, blank) |
recommended_action | Recommended action (for assisted alerts) (null, blank) |
anomaly_trend | Anomaly trend (for assisted alerts) (null, blank) |
diag_description | Diagnostician description (for assisted alerts) (null, blank) |
is_critical | Whether the anomaly is critical (for assisted alerts) |
is_hidden | Whether the anomaly is hidden (for assisted alerts) |
mail_last_sent_on | Datetime of the last related email sent to the customer (for assisted alerts) (null, blank) |
estimated_prevented_damage_amount | Estimated prevented damage (for alerts) |
estimated_prevented_damage_currency | Currency of estimated prevented damage (for alerts) |
create_anomaly
Creates Event of anomaly Event Type.
Example request:
{ "machine": 567, "created_at": "2020-06-01T12:00:00Z" }
Example response:
{ "id": 74, "type": "anomaly", "machine": 567, "meta": null, "created_at": "2020-06-01T12:00:00Z", "status": "new" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine required | Machine which the Event came for (not null, not blank) |
created_at required | Creation datetime of the Event (automatically set) |
related_pair_event | Related start Event of pair Event (for alerts) |
master_alert | Related Event which groups another Events (for alerts) |
placements | Placements of the Event |
maintenance_type | Maintenance Type |
status | Event Status |
presumed_causes | Presumed causes of the anomaly (for assisted alerts) (null, blank) |
recommended_action | Recommended action (for assisted alerts) (null, blank) |
anomaly_trend | Anomaly trend (for assisted alerts) (null, blank) |
diag_description | Diagnostician description (for assisted alerts) (null, blank) |
is_critical | Whether the anomaly is critical (for assisted alerts) |
is_hidden | Whether the anomaly is hidden (for assisted alerts) |
mail_last_sent_on | Datetime of the last related email sent to the customer (for assisted alerts) (null, blank) |
estimated_prevented_damage_amount | Estimated prevented damage (for alerts) |
estimated_prevented_damage_currency | Currency of estimated prevented damage (for alerts) |
create_pair
Creates start Event or pair Event, depending on whether end is supplied.
Example request:
{ "machine": 567, "start": { "type": "maintenance_start", "created_at": "2020-06-01T12:00:00Z", "meta": { "purpose": "cleaning" }, "maintenance_type": 1 } }or
{ "machine": 567, "start": { "type": "maintenance_start", "created_at": "2020-06-01T12:00:00Z", "meta": { "purpose": "cleaning" }, "maintenance_type": 1 }, "end": { "type": "maintenance_end", "created_at": "2020-06-01T18:00:00Z" } }
Example response:
{ "start": { "id": 30, "type": "maintenance_start", "machine": 567, "meta": { "purpose": "cleaning" }, "related_event": null, "created_at": "2020-06-01T12:00:00Z", "note": "Machine cleaning", "maintenance_type": 1 }, "end": null }or
{ "start": { "id": 30, "type": "maintenance_start", "machine": 567, "meta": { "purpose": "cleaning" }, "related_event": { "id": 74, "type": "maintenance_end", "machine": 567, "meta": null, "created_at": "2020-06-01T18:00:00Z" }, "created_at": "2020-06-01T12:00:00Z", "note": "Machine cleaning", "maintenance_type": 1 }, "end": { "id": 74, "type": "maintenance_end", "machine": 567, "meta": null, "related_event": { "id": 30, "type": "maintenance_start", "machine": 567, "meta": { "purpose": "cleaning" }, "created_at": "2020-06-01T12:00:00Z" }, "created_at": "2020-06-01T18:00:00Z", "note": "Next cleaning should be on 2020-09-01", "maintenance_type": null } }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine required | Machine ID |
start required | Details about start Event in a JSON format. |
end | Details about end Event in a JSON format. |
webhook
Endpoint used for receiving Events from Grafana webhook. Event Type is deduced from Grafana State (request["state"] - alerting/ok/no_data) and Grafana Type (decode(request["message"])["type"]). At this time there are four Event Types - anomaly (alerting State + anomaly Type), machine_on (ok State + running Type), machine_off (alerting State + running Type) and error (no_data + running Type). Can be called by Service logins.
If the request pertains to a Machine in the "assisted alerts" regime, the message type is "anomaly", or "fault", and the state is "alerting", no Event is created. A Target Process ticket is created instead.
Example request:
{ "state": "alerting", "title": "[Alerting] Panel Title alert", "ruleId": 1081, "message": "{ \"type\": \"anomaly\", \"machine\": 579 }", "ruleUrl": "https://monitor.neuronsw.com/d/iazs9fEil/internal-testing-dashboard-delete-afterwards?fullscreen&edit&tab=alert&panelId=89&orgId=1", "imageUrl": "https://storage.googleapis.com/neuronsw-grafana-images/crplAEeNtTCrMKnip6XJ.png", "ruleName": "Panel Title alert", "evalMatches": [ { "tags": null, "value": 0.7540263084785175, "metric": "avg" } ] }or
{ "state": "alerting", "title": "[Alerting] Panel Title alert", "ruleId": 1081, "message": "{ \"type\": \"running\", \"machine\": 579 }", "ruleUrl": "https://monitor.neuronsw.com/d/iazs9fEil/internal-testing-dashboard-delete-afterwards?fullscreen&edit&tab=alert&panelId=89&orgId=1", "imageUrl": "https://storage.googleapis.com/neuronsw-grafana-images/crplAEeNtTCrMKnip6XJ.png", "ruleName": "Panel Title alert", "evalMatches": [ { "tags": null, "value": 0.25254026308478517, "metric": "avg" } ] }or
{ "state": "no_data", "title": "[No Data] Panel Title alert", "ruleId": 1081, "message": "{ \"type\": \"running\", \"machine\": 579 }", "ruleUrl": "https://monitor.neuronsw.com/d/iazs9fEil/internal-testing-dashboard-delete-afterwards?fullscreen&edit&tab=alert&panelId=89&orgId=1", "imageUrl": "https://storage.googleapis.com/neuronsw-grafana-images/gAOH5ou7obAGMztGCbrr.png", "ruleName": "Panel Title alert", "evalMatches": [] }or
{ "state": "ok", "title": "[OK] Panel Title alert", "ruleId": 1081, "message": "{ \"type\": \"running\", \"machine\": 579 }", "ruleUrl": "https://monitor.neuronsw.com/d/iazs9fEil/internal-testing-dashboard-delete-afterwards?fullscreen&edit&tab=alert&panelId=89&orgId=1", "imageUrl": "https://storage.googleapis.com/neuronsw-grafana-images/D66hsK9hmgO5xbWxokPA.png", "ruleName": "Panel Title alert", "evalMatches": [] }or
{ "state": "alerting", "title": "Panel Title alert", "ruleId": 1081, "message": "{ \"type\": \"fault\", \"machine\": 579, \"placement\": 43, \"fault\": \"looseness\" }", "ruleUrl": "https://monitor.neuronsw.com/d/iazs9fEil/internal-testing-dashboard-delete-afterwards?fullscreen&edit&tab=alert&panelId=89&orgId=1", "imageUrl": "https://storage.googleapis.com/neuronsw-grafana-images/D66hsK9hmgO5xbWxokPA.png", "ruleName": "Panel Title alert", "evalMatches": [] }
Example response:
{ "status": "created" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | Alert title |
state required | Grafana alert State ("alerting", "ok", "no data") |
ruleId required | ID of the Grafana alert rule which defines when the alert is triggered |
ruleUrl required | Grafana alert rule URL |
imageUrl required | Grafana image URL |
ruleName required | Grafana alert rule name |
evalMatches | Information about conditions, if applicable, for example: {"tags": None, "value": 0.75402630847851753, "metric": "avg"} |
message required | String containing JSON with Event Type and Machine, for example: {"type": "anomaly", "machine": 579 } |
read
Returns Event by ID.
Example response:
{ "id": 126375846344, "type": "eventtype5", "meta": null, "machine": null, "alert_severity": "eventtype4", "created_at": "2024-03-29T00:38:23.694216Z", "related_pair_event": null, "related_event": null, "related_alerts": [], "master_alert": null, "grouped_alerts": [], "note": null, "created_by_user": null, "modified_by_user": null, "placements": [], "maintenance_type": null, "status": null, "presumed_causes": null, "recommended_action": null, "anomaly_trend": null, "diag_description": null, "is_critical": false, "is_hidden": false, "mail_last_sent_on": null, "has_attachment": false, "mail_sent": false, "estimated_prevented_damage_amount": "0.00", "estimated_prevented_damage_currency": "EUR" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
A viewset used for retrieving and editing stored Events.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type required | Type of the Event (not null, not blank) |
meta | Extra info on the Event (null, blank) |
machine required | Machine which the Event came for (not null, not blank) |
alert_severity | Alert Severity of the Event (null, blank) |
created_at required | Creation datetime of the Event (automatically set) |
related_pair_event | Related start Event of pair Event (for alerts) |
master_alert | Related Event which groups another Events (for alerts) |
placements | Placements of the Event |
maintenance_type | Maintenance Type |
status | Event Status |
presumed_causes | Presumed causes of the anomaly (for assisted alerts) (null, blank) |
recommended_action | Recommended action (for assisted alerts) (null, blank) |
anomaly_trend | Anomaly trend (for assisted alerts) (null, blank) |
diag_description | Diagnostician description (for assisted alerts) (null, blank) |
is_critical | Whether the anomaly is critical (for assisted alerts) |
is_hidden | Whether the anomaly is hidden (for assisted alerts) |
mail_last_sent_on | Datetime of the last related email sent to the customer (for assisted alerts) (null, blank) |
estimated_prevented_damage_amount | Estimated prevented damage (for alerts) |
estimated_prevented_damage_currency | Currency of estimated prevented damage (for alerts) |
partial_update
Partially updates Event.
Example response:
{ "id": 126375846344, "type": "eventtype5", "meta": null, "machine": null, "alert_severity": "eventtype4", "created_at": "2024-03-29T00:38:23.694216Z", "related_pair_event": null, "related_event": null, "related_alerts": [], "master_alert": null, "grouped_alerts": [], "note": null, "created_by_user": null, "modified_by_user": null, "placements": [], "maintenance_type": null, "status": null, "presumed_causes": null, "recommended_action": null, "anomaly_trend": null, "diag_description": null, "is_critical": false, "is_hidden": false, "mail_last_sent_on": null, "has_attachment": false, "mail_sent": false, "estimated_prevented_damage_amount": "0.00", "estimated_prevented_damage_currency": "EUR" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
meta | Extra info on the Event (null, blank) |
alert_severity | Alert Severity of the Event (null, blank) |
related_pair_event | Related start Event of pair Event (for alerts) |
master_alert | Related Event which groups another Events (for alerts) |
placements | Placements of the Event |
maintenance_type | Maintenance Type |
status | Event Status |
presumed_causes | Presumed causes of the anomaly (for assisted alerts) (null, blank) |
recommended_action | Recommended action (for assisted alerts) (null, blank) |
anomaly_trend | Anomaly trend (for assisted alerts) (null, blank) |
diag_description | Diagnostician description (for assisted alerts) (null, blank) |
is_critical | Whether the anomaly is critical (for assisted alerts) |
is_hidden | Whether the anomaly is hidden (for assisted alerts) |
mail_last_sent_on | Datetime of the last related email sent to the customer (for assisted alerts) (null, blank) |
estimated_prevented_damage_amount | Estimated prevented damage (for alerts) |
estimated_prevented_damage_currency | Currency of estimated prevented damage (for alerts) |
delete
A viewset used for retrieving and editing stored Events.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
attachments
A viewset used for retrieving and editing stored Events.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
comments
A viewset used for retrieving and editing stored Events.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
placement_failures
Lists Event Placement Failures for specified Event.
Example response:
[ { "id": 3, "event": 15, "placement": 12, "failure": 5 } ]
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
set_as_master
Sets/unsets alert Event as master to other alert Events that are on same Machine and newer than the Event, optionally narrowed down by Event IDs. Returns list of all grouped Events for this master alert Event.
Example request:
{}or
{ "alerts": [ 5, 6, 7 ] }or
{ "reset": true }or
{ "alerts": [ 5, 6, 7 ], "reset": true }
Example response:
{ "grouped_alerts": [ { "id": 5, "type": "anomaly", "meta": null, "machine": 1, "alert_severity": null, "created_at": "2024-03-29T00:38:23.694216Z", "related_pair_event": null, "related_event": null, "related_alerts": [], "master_alert": 4, "grouped_alerts": [], "note": null, "created_by_user": null, "modified_by_user": null, "placements": [], "maintenance_type": null, "status": "new", "presumed_causes": null, "recommended_action": null, "anomaly_trend": null, "diag_description": null, "is_critical": false, "is_hidden": false, "mail_last_sent_on": null, "has_attachment": false, "mail_sent": false, "estimated_prevented_damage_amount": "0.00", "estimated_prevented_damage_currency": "EUR" }, { "id": 6, "type": "anomaly", "meta": null, "machine": 1, "alert_severity": null, "created_at": "2024-03-29T00:38:23.694216Z", "related_pair_event": null, "related_event": null, "related_alerts": [], "master_alert": 4, "grouped_alerts": [], "note": null, "created_by_user": null, "modified_by_user": null, "placements": [], "maintenance_type": null, "status": "new", "presumed_causes": null, "recommended_action": null, "anomaly_trend": null, "diag_description": null, "is_critical": false, "is_hidden": false, "mail_last_sent_on": null, "has_attachment": false, "mail_sent": false, "estimated_prevented_damage_amount": "0.00", "estimated_prevented_damage_currency": "EUR" }, { "id": 7, "type": "anomaly", "meta": null, "machine": 1, "alert_severity": null, "created_at": "2024-03-29T00:38:23.694216Z", "related_pair_event": null, "related_event": null, "related_alerts": [], "master_alert": 4, "grouped_alerts": [], "note": null, "created_by_user": null, "modified_by_user": null, "placements": [], "maintenance_type": null, "status": "new", "presumed_causes": null, "recommended_action": null, "anomaly_trend": null, "diag_description": null, "is_critical": false, "is_hidden": false, "mail_last_sent_on": null, "has_attachment": false, "mail_sent": false, "estimated_prevented_damage_amount": "0.00", "estimated_prevented_damage_currency": "EUR" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be "application/json"
encoded, and should contain a single item.
Parameter | Description |
---|---|
alerts | List of Event IDs to narrow down Events to be updated |
reset | When set to true, this endpoint unsets master alert Event from given Events |
pair > partial_update
Updates Event pair (which may include creating or destroying end) - specify just one of IDs in URL path.
Example request:
{ "start": { "type": "maintenance_start", "created_at": "2020-06-01T12:00:00Z", "meta": { "purpose": "cleaning" }, "maintenance_type": null }, "end": null }or
{ "start": { "type": "maintenance_start", "created_at": "2020-06-01T12:00:00Z", "meta": { "purpose": "cleaning" }, "maintenance_type": null }, "end": { "type": "maintenance_end", "created_at": "2020-06-01T18:00:00Z" } }
Example response:
{ "start": { "id": 30, "type": "maintenance_start", "machine": 567, "meta": { "purpose": "cleaning" }, "related_event": null, "created_at": "2020-06-01T12:00:00Z", "note": "Machine cleaning", "maintenance_type": 1 }, "end": null }or
{ "start": { "id": 30, "type": "maintenance_start", "machine": 567, "meta": { "purpose": "cleaning" }, "related_event": { "id": 74, "type": "maintenance_end", "machine": 567, "meta": null, "created_at": "2020-06-01T18:00:00Z" }, "created_at": "2020-06-01T12:00:00Z", "note": "Machine cleaning", "maintenance_type": 1 }, "end": { "id": 74, "type": "maintenance_end", "machine": 567, "meta": null, "related_event": { "id": 30, "type": "maintenance_start", "machine": 567, "meta": { "purpose": "cleaning" }, "created_at": "2020-06-01T12:00:00Z" }, "created_at": "2020-06-01T18:00:00Z", "note": "Next cleaning should be on 2020-09-01", "maintenance_type": null } }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
start required | Details about start Event in a JSON format. |
end | Details about end Event in a JSON format. |
pair > delete
Deletes both Events in pair (or start if there's no end) - specify just one of IDs in URL path.
Example response:
{}
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
facilities
list
Lists Facilities.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "tags": [], "machines": [], "stations": [], "users_to_notify": [] } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_project | Filters Facilities by Project IDs (list) (inverse) |
not_q | Filters Facilities by search in name/description/address (single value) (inverse) |
project | Filters Facilities by Project IDs (list) |
q | Filters Facilities by search in name/description/address (single value) |
create
Creates Facility. Users from Project are automatically added to users_to_notify.
Example request:
{ "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "users_to_notify": [] }
Example response:
{ "id": 126375846344, "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "tags": [], "machines": [], "stations": [], "users_to_notify": [] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Facility (not null, not blank) |
project required | Project of the Facility (not null) |
description | Description of the Facility (null, blank) |
address required | Address of the Facility (not null, not blank) |
users_to_notify | Users to send notifications to |
read
Returns Facility by ID.
Example response:
{ "id": 126375846344, "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "tags": [], "machines": [], "stations": [], "users_to_notify": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Facility. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Facility.
Example request:
{ "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "users_to_notify": [] }
Example response:
{ "id": 126375846344, "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "tags": [], "machines": [], "stations": [], "users_to_notify": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Facility. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Facility (not null, not blank) |
description | Description of the Facility (null, blank) |
address required | Address of the Facility (not null, not blank) |
users_to_notify | Users to send notifications to |
partial_update
Partially updates Facility.
Example request:
{ "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "users_to_notify": [] }
Example response:
{ "id": 126375846344, "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "tags": [], "machines": [], "stations": [], "users_to_notify": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Facility. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Facility (not null, not blank) |
description | Description of the Facility (null, blank) |
address | Address of the Facility (not null, not blank) |
users_to_notify | Users to send notifications to |
delete
Deletes Facility.
Example response:
{ "id": 126375846344, "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "tags": [], "machines": [], "stations": [], "users_to_notify": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Facility. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
add_tags
Adds Facility Tags.
Example request:
{ "tags": [ "tag1", "tag2", "tag3" ] }
Example response:
{ "id": 126375846344, "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "tags": [], "machines": [], "stations": [], "users_to_notify": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Facility. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Facility (not null, not blank) |
project required | Project of the Facility (not null) |
description | Description of the Facility (null, blank) |
address required | Address of the Facility (not null, not blank) |
users_to_notify | Users to send notifications to |
remove_tags
Removes Tags.
Example request:
{ "tags": [ "tag1", "tag2" ] }
Example response:
{ "id": 126375846344, "name": "Facility #11", "project": 126375846344, "description": "Description #11", "address": "Address for Facility #11", "tags": [], "machines": [], "stations": [], "users_to_notify": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Facility. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Facility (not null, not blank) |
project required | Project of the Facility (not null) |
description | Description of the Facility (null, blank) |
address required | Address of the Facility (not null, not blank) |
users_to_notify | Users to send notifications to |
stations
Lists Stations for specified Facility.
Example response:
{ "id": 165, "facility": 100, "environment": null, "machines": [ 566 ], "name": "Olaberria station", "description": "" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Facility. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
failure_types
list
Lists Failure Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "Failure Type #1", "description": "Description for Failure Type #1" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Failure Type.
Example request:
{ "codename": "Failure Type #1", "description": "Description for Failure Type #1" }
Example response:
{ "id": 126375846344, "codename": "Failure Type #1", "description": "Description for Failure Type #1" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the Failure Type (not null, not blank, unique) |
description | Description of the Failure Type (null, blank) |
read
Returns Failure Type by ID.
Example response:
{ "id": 126375846344, "codename": "Failure Type #1", "description": "Description for Failure Type #1" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Failure Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Failure Type.
Example request:
{ "codename": "Failure Type #1", "description": "Description for Failure Type #1" }
Example response:
{ "id": 126375846344, "codename": "Failure Type #1", "description": "Description for Failure Type #1" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Failure Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the Failure Type (not null, not blank, unique) |
description | Description of the Failure Type (null, blank) |
partial_update
Partially updates Failure Type.
Example request:
{ "codename": "Failure Type #1", "description": "Description for Failure Type #1" }
Example response:
{ "id": 126375846344, "codename": "Failure Type #1", "description": "Description for Failure Type #1" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Failure Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | Codename of the Failure Type (not null, not blank, unique) |
description | Description of the Failure Type (null, blank) |
delete
Deletes Failure Type.
Example response:
{ "id": 126375846344, "codename": "Failure Type #1", "description": "Description for Failure Type #1" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Failure Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
failures
list
Lists Failures.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "placement_type": null, "failure_type": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_placement_type | Filters Failures by Placement Type IDs (list) (inverse) |
placement_type | Filters Failures by Placement Type IDs (list) |
create
Creates Failure.
Example request:
{ "placement_type": null, "failure_type": null }
Example response:
{ "id": 126375846344, "placement_type": null, "failure_type": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
placement_type required | Placement Type for the Failure |
failure_type required | Failure Type for the Failure |
read
Returns Failure by ID.
Example response:
{ "id": 126375846344, "placement_type": null, "failure_type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Failure. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Failure.
Example request:
{ "placement_type": null, "failure_type": null }
Example response:
{ "id": 126375846344, "placement_type": null, "failure_type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Failure. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
placement_type required | Placement Type for the Failure |
failure_type required | Failure Type for the Failure |
partial_update
Partially updates Failure.
Example request:
{ "placement_type": null, "failure_type": null }
Example response:
{ "id": 126375846344, "placement_type": null, "failure_type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Failure. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
placement_type | Placement Type for the Failure |
failure_type | Failure Type for the Failure |
delete
Deletes Failure.
Example response:
{ "id": 126375846344, "placement_type": null, "failure_type": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Failure. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
faults
list
Lists Faults.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "placement": null, "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "type": "bands", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_placement | Filters Faults by Placement IDs (list) (inverse) |
placement | Filters Faults by Placement IDs (list) |
create
Creates Faults.
Example request:
{ "placement": null, "type": "bands", "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null }
Example response:
{ "id": 126375846344, "placement": null, "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "type": "bands", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
placement required | Placement of the Fault (not null) |
frequency_for_enveloping_start | Start value of frequency for enveloping (for bearing and specific_frequency types only) (not null) |
frequency_for_enveloping_end | End value of frequency for enveloping (for bearing and specific_frequency types only) (not null) |
rpm | Revolutions per minute (for band and bearing types only) (null) |
coefficient | Coefficient (for specific_frequency type only) (null) |
is_rpm_automatically_detected | Whether the RPM is automatically detected |
band_alerting | Whether the bands alerting is activated for this Fault (not null, must be one of off, show, alert) |
type | Fault type (not null, must be one of bearing_faults, bands, specific_frequency) |
description | Description of the Fault |
ftf | Frequency of rolling element set & cage |
bfs | Frequency of rolling element about its axis |
bpfi | Frequency of point on inner ring |
bpfo | Frequency of point on outer ring |
signal_processing | Source of signal (not null, must be one of acceleration, velocity, envelope_acceleration) |
threshold | Threshold for alerting (null) |
read
Returns Fault by ID.
Example response:
{ "id": 126375846344, "placement": null, "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "type": "bands", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Fault. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Fault.
Example request:
{ "placement": null, "type": "bands", "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null }
Example response:
{ "id": 126375846344, "placement": null, "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "type": "bands", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Fault. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
frequency_for_enveloping_start | Start value of frequency for enveloping (for bearing and specific_frequency types only) (not null) |
frequency_for_enveloping_end | End value of frequency for enveloping (for bearing and specific_frequency types only) (not null) |
rpm | Revolutions per minute (for band and bearing types only) (null) |
coefficient | Coefficient (for specific_frequency type only) (null) |
is_rpm_automatically_detected | Whether the RPM is automatically detected |
band_alerting | Whether the bands alerting is activated for this Fault (not null, must be one of off, show, alert) |
type | Fault type (not null, must be one of bearing_faults, bands, specific_frequency) |
description | Description of the Fault |
ftf | Frequency of rolling element set & cage |
bfs | Frequency of rolling element about its axis |
bpfi | Frequency of point on inner ring |
bpfo | Frequency of point on outer ring |
signal_processing | Source of signal (not null, must be one of acceleration, velocity, envelope_acceleration) |
threshold | Threshold for alerting (null) |
partial_update
Partially updates Fault.
Example request:
{ "placement": null, "type": "bands", "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null }
Example response:
{ "id": 126375846344, "placement": null, "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "type": "bands", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Fault. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
frequency_for_enveloping_start | Start value of frequency for enveloping (for bearing and specific_frequency types only) (not null) |
frequency_for_enveloping_end | End value of frequency for enveloping (for bearing and specific_frequency types only) (not null) |
rpm | Revolutions per minute (for band and bearing types only) (null) |
coefficient | Coefficient (for specific_frequency type only) (null) |
is_rpm_automatically_detected | Whether the RPM is automatically detected |
band_alerting | Whether the bands alerting is activated for this Fault (not null, must be one of off, show, alert) |
type | Fault type (not null, must be one of bearing_faults, bands, specific_frequency) |
description | Description of the Fault |
ftf | Frequency of rolling element set & cage |
bfs | Frequency of rolling element about its axis |
bpfi | Frequency of point on inner ring |
bpfo | Frequency of point on outer ring |
signal_processing | Source of signal (not null, must be one of acceleration, velocity, envelope_acceleration) |
threshold | Threshold for alerting (null) |
delete
Deletes Fault.
Example response:
{ "id": 126375846344, "placement": null, "frequency_for_enveloping_start": "500.000", "frequency_for_enveloping_end": "12000.000", "rpm": null, "coefficient": null, "is_rpm_automatically_detected": false, "band_alerting": "off", "type": "bands", "description": null, "ftf": null, "bfs": null, "bpfi": null, "bpfo": null, "signal_processing": "velocity", "threshold": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Fault. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
forgot_password
create
Sends email with UUID and token to User with HTML template email to allow User to reset password.
Example request:
{ "email": "someone@example.com" }
Example response:
{ "status": "send" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | User email |
get-user-id
list
Simple endpoint used by mobile application to get user's id for storing in right "folder" in AWS S3.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
get_audio
list
Returns audio data as audio/flac
response.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
placement required | Placement ID |
start_time required | Start time of region, in format YYYY-MM-DD HH:MM:SS.f |
end_time required | End time of region, in format YYYY-MM-DD HH:MM:SS.f |
get_availability
list
Lists days with available audio for specified Machine (and optionally start and end date).
Example response:
[ "2019-07-23", "2019-07-24", "2019-07-25" ]
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
machine required | Machine ID |
start_date | Start date |
end_date | End date |
get_availability_range
list
Lists available Audio Chunks for specified Device and time range.
Example response:
[ { "start": "2019-07-23 12:36:45.464537", "end": "2019-07-23 12:36:49.179730" }, { "start": "2019-07-23 12:36:50.294505", "end": "2019-07-23 12:36:56.238813" } ]
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
machine required | Machine ID |
start_time required | Start time of region, in format YYYY-MM-DD HH:MM:SS.f |
end_time required | End time of region, in format YYYY-MM-DD HH:MM:SS.f |
placement | Placement(s) to get availability for (list) |
grafana_states
list
Lists Grafana States.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "TestGrafanaState6", "description": "Description for Grafana State 6" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Grafana State.
Example request:
{ "name": "TestGrafanaState6", "description": "Description for Grafana State 6" }
Example response:
{ "id": 126375846344, "name": "TestGrafanaState6", "description": "Description for Grafana State 6" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of given Grafana State |
description required | Description |
read
Returns Grafana State by ID.
Example response:
{ "id": 126375846344, "name": "TestGrafanaState6", "description": "Description for Grafana State 6" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana State. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Grafana State.
Example request:
{ "name": "TestGrafanaState6", "description": "Description for Grafana State 6" }
Example response:
{ "id": 126375846344, "name": "TestGrafanaState6", "description": "Description for Grafana State 6" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana State. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of given Grafana State |
description required | Description |
partial_update
Partially updates Grafana State.
Example request:
{ "name": "TestGrafanaState6", "description": "Description for Grafana State 6" }
Example response:
{ "id": 126375846344, "name": "TestGrafanaState6", "description": "Description for Grafana State 6" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana State. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of given Grafana State |
description | Description |
delete
Deletes Grafana State.
Example response:
{ "id": 126375846344, "name": "TestGrafanaState6", "description": "Description for Grafana State 6" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana State. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
grafana_templates
list
Lists Grafana Templates.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "dashboard_type": null, "machine": null, "name": "Grafana Template #0", "json": { "key": "Some value" } } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Grafana Template.
Example request:
{ "name": "Grafana Template #0", "json": { "key": "Some value" } }
Example response:
{ "id": 126375846344, "dashboard_type": null, "machine": null, "name": "Grafana Template #0", "json": { "key": "Some value" } }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
dashboard_type | Dashboard Type for Dashboard |
machine | Specific Machine if selected |
name required | Name of the Grafana Template |
json required | JSON data of the Grafana Template |
read
Returns Grafana Template by ID.
Example response:
{ "id": 126375846344, "dashboard_type": null, "machine": null, "name": "Grafana Template #0", "json": { "key": "Some value" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana Template. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Grafana Template.
Example request:
{ "name": "Grafana Template #0", "json": { "key": "Some value" } }
Example response:
{ "id": 126375846344, "dashboard_type": null, "machine": null, "name": "Grafana Template #0", "json": { "key": "Some value" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana Template. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
dashboard_type | Dashboard Type for Dashboard |
machine | Specific Machine if selected |
name required | Name of the Grafana Template |
json required | JSON data of the Grafana Template |
partial_update
Partially updates Grafana Template.
Example request:
{ "name": "Grafana Template #0", "json": { "key": "Some value" } }
Example response:
{ "id": 126375846344, "dashboard_type": null, "machine": null, "name": "Grafana Template #0", "json": { "key": "Some value" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana Template. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
dashboard_type | Dashboard Type for Dashboard |
machine | Specific Machine if selected |
name | Name of the Grafana Template |
json | JSON data of the Grafana Template |
delete
Deletes Grafana Template.
Example response:
{ "id": 126375846344, "dashboard_type": null, "machine": null, "name": "Grafana Template #0", "json": { "key": "Some value" } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana Template. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
grafana_types
list
Lists Grafana Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Grafana Type.
Example request:
{ "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" }
Example response:
{ "id": 126375846344, "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of given Grafana Type |
description required | Description |
read
Returns Grafana Type by ID.
Example response:
{ "id": 126375846344, "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Grafana Type.
Example request:
{ "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" }
Example response:
{ "id": 126375846344, "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of given Grafana Type |
description required | Description |
partial_update
Partially updates Grafana Type.
Example request:
{ "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" }
Example response:
{ "id": 126375846344, "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of given Grafana Type |
description | Description |
delete
Deletes Grafana Type.
Example response:
{ "id": 126375846344, "name": "TestGrafanaType6", "description": "Description for Grafana Type 6" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Grafana Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
iso_groups
list
Lists ISO Groups.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "group1_rigid", "description": "Description for ISO Group #0", "rms_threshold": null, "is_rms_hidden": false } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates ISO Group.
Example request:
{ "codename": "group1_rigid", "description": "Description for ISO Group #0" }
Example response:
{ "id": 126375846344, "codename": "group1_rigid", "description": "Description for ISO Group #0", "rms_threshold": null, "is_rms_hidden": false }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the ISO 10816-3 Group, must be one of group1_rigid, group1_flexible, group2_rigid, group2_flexible, group3_rigid, group3_flexible, group4_rigid, group4_flexible, hidden (not null, not blank, unique) |
description | Description of the ISO 10816-3 Group |
rms_threshold | Threshold for RMS alerting |
is_rms_hidden | Whether RMS values are hidden in Dashboard |
read
Returns ISO Group by ID.
Example response:
{ "id": 126375846344, "codename": "group1_rigid", "description": "Description for ISO Group #0", "rms_threshold": null, "is_rms_hidden": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this ISO Group. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates ISO Group.
Example request:
{ "codename": "group1_rigid", "description": "Description for ISO Group #0" }
Example response:
{ "id": 126375846344, "codename": "group1_rigid", "description": "Description for ISO Group #0", "rms_threshold": null, "is_rms_hidden": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this ISO Group. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the ISO 10816-3 Group, must be one of group1_rigid, group1_flexible, group2_rigid, group2_flexible, group3_rigid, group3_flexible, group4_rigid, group4_flexible, hidden (not null, not blank, unique) |
description | Description of the ISO 10816-3 Group |
rms_threshold | Threshold for RMS alerting |
is_rms_hidden | Whether RMS values are hidden in Dashboard |
partial_update
Partially updates ISO Group.
Example request:
{ "codename": "group1_rigid", "description": "Description for ISO Group #0" }
Example response:
{ "id": 126375846344, "codename": "group1_rigid", "description": "Description for ISO Group #0", "rms_threshold": null, "is_rms_hidden": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this ISO Group. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | Codename of the ISO 10816-3 Group, must be one of group1_rigid, group1_flexible, group2_rigid, group2_flexible, group3_rigid, group3_flexible, group4_rigid, group4_flexible, hidden (not null, not blank, unique) |
description | Description of the ISO 10816-3 Group |
rms_threshold | Threshold for RMS alerting |
is_rms_hidden | Whether RMS values are hidden in Dashboard |
delete
Deletes ISO Group.
Example response:
{ "id": 126375846344, "codename": "group1_rigid", "description": "Description for ISO Group #0", "rms_threshold": null, "is_rms_hidden": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this ISO Group. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
label_categories
list
Lists Label Categories.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "machine_subcategory": null, "company": null, "name": "Label Category #2", "description": "Description for Label Category #2" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
machine_category | Filters Label Categories by Machine Category IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine_category | Filters Label Categories by Machine Category IDs (list) (inverse) |
create
Creates Label Category.
Example request:
{ "name": "Label Category #2", "description": "Description for Label Category #2", "machine_subcategory": null, "company": null }
Example response:
{ "id": 126375846344, "machine_subcategory": null, "company": null, "name": "Label Category #2", "description": "Description for Label Category #2" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine_subcategory | Machine Subcategory of the Label Category (null) |
company | Company of the Label Category (null) |
name required | Name of the Label Category (not null, not blank) |
description | Description of the Label Category (null, blank) |
read
Returns Label Category by ID.
Example response:
{ "id": 126375846344, "machine_subcategory": null, "company": null, "name": "Label Category #2", "description": "Description for Label Category #2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Label Category.
Example request:
{ "name": "Label Category #2", "description": "Description for Label Category #2", "machine_subcategory": null, "company": null }
Example response:
{ "id": 126375846344, "machine_subcategory": null, "company": null, "name": "Label Category #2", "description": "Description for Label Category #2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company of the Label Category (null) |
name required | Name of the Label Category (not null, not blank) |
description | Description of the Label Category (null, blank) |
partial_update
Partially updates Label Category.
Example request:
{ "name": "Label Category #2", "description": "Description for Label Category #2", "machine_subcategory": null, "company": null }
Example response:
{ "id": 126375846344, "machine_subcategory": null, "company": null, "name": "Label Category #2", "description": "Description for Label Category #2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company of the Label Category (null) |
name | Name of the Label Category (not null, not blank) |
description | Description of the Label Category (null, blank) |
delete
Deletes Label Category.
Example response:
{ "id": 126375846344, "machine_subcategory": null, "company": null, "name": "Label Category #2", "description": "Description for Label Category #2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
label_sources
list
Lists Label Sources.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Name for Label Source #2", "description": "Description for Label Source #2" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Label Source.
Example request:
{ "name": "Name for Label Source #2", "description": "Description for Label Source #2" }
Example response:
{ "id": 126375846344, "name": "Name for Label Source #2", "description": "Description for Label Source #2" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Label Source (not null, not blank, unique) |
description | Description of the Label Source (null, blank) |
read
Returns Label Source by ID.
Example response:
{ "id": 126375846344, "name": "Name for Label Source #2", "description": "Description for Label Source #2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Source. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Label Source.
Example request:
{ "name": "Name for Label Source #2", "description": "Description for Label Source #2" }
Example response:
{ "id": 126375846344, "name": "Name for Label Source #2", "description": "Description for Label Source #2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Source. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Label Source (not null, not blank, unique) |
description | Description of the Label Source (null, blank) |
partial_update
Partially updates Label Source.
Example request:
{ "name": "Name for Label Source #2", "description": "Description for Label Source #2" }
Example response:
{ "id": 126375846344, "name": "Name for Label Source #2", "description": "Description for Label Source #2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Source. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Label Source (not null, not blank, unique) |
description | Description of the Label Source (null, blank) |
delete
Deletes Label Source.
Example response:
{ "id": 126375846344, "name": "Name for Label Source #2", "description": "Description for Label Source #2" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Source. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
label_subcategories
list
Lists Label Subcategories.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "category": null, "company": null, "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "meta": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
category | Filters Label Subcategories by Category IDs (list) |
id | Filters entities by IDs (list) |
machine | Filters Label Subcategories by Machine ID (single value) |
not_category | Filters Label Subcategories by Category IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Label Subcategories by Machine ID (single value) (inverse) |
create
Creates Label Subcategory.
Example request:
{ "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "category": null, "company": null }
Example response:
{ "id": 126375846344, "category": null, "company": null, "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "meta": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
category | Label Category of the Label Subcategory (null) |
company | Company of the Label Subcategory (null) |
name required | Name of the Label Subcategory (not null, not blank) |
description | Description of the Label Subcategory (null, blank) |
meta | Metadata for the Label Subcategory (any JSON) |
read
Returns Label Subcategory by ID.
Example response:
{ "id": 126375846344, "category": null, "company": null, "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "meta": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Label Subcategory.
Example request:
{ "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "category": null, "company": null }
Example response:
{ "id": 126375846344, "category": null, "company": null, "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "meta": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company of the Label Subcategory (null) |
name required | Name of the Label Subcategory (not null, not blank) |
description | Description of the Label Subcategory (null, blank) |
meta | Metadata for the Label Subcategory (any JSON) |
partial_update
Partially updates Label Subcategory.
Example request:
{ "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "category": null, "company": null }
Example response:
{ "id": 126375846344, "category": null, "company": null, "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "meta": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company of the Label Subcategory (null) |
name | Name of the Label Subcategory (not null, not blank) |
description | Description of the Label Subcategory (null, blank) |
meta | Metadata for the Label Subcategory (any JSON) |
delete
Deletes Label Subcategory.
Example response:
{ "id": 126375846344, "category": null, "company": null, "name": "Label Subcategory #2", "description": "Description for Label Subcategory #2", "meta": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
labels
list
Lists Labels.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "subcategory": 126375846344, "machine": 126375846344, "channel": null, "source": 126375846344, "placements": [], "meta": { "test0": "Test 0" }, "event": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "description": "Description for Label #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
event | Filters Labels by related Event IDs (list) |
from | Filters Labels by datetime from (single value) |
id | Filters entities by IDs (list) |
machine | Filters Labels by Machine IDs (list) |
not_event | Filters Labels by related Event IDs (list) (inverse) |
not_from | Filters Labels by datetime from (single value) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Labels by Machine IDs (list) (inverse) |
not_placement | Filters Labels by Placement IDs (list) (inverse) |
not_source | Filters Labels by Label Source IDs (list) (inverse) |
not_subcategory | Filters Labels by Subcategory IDs (list) (inverse) |
not_subcategory_name | Filters Labels by Subcategory names (list) (inverse) |
not_to | Filters Labels by datetime to (single value) (inverse) |
not_type | Filters Labels by Label Type IDs (list) (inverse) |
not_value_gte | Filters Labels by value (greater than or equal; single value) (inverse) |
not_value_lte | Filters Labels by value (lower than or equal; single value) (inverse) |
placement | Filters Labels by Placement IDs (list) |
source | Filters Labels by Label Source IDs (list) |
subcategory | Filters Labels by Subcategory IDs (list) |
subcategory_name | Filters Labels by Subcategory names (list) |
to | Filters Labels by datetime to (single value) |
type | Filters Labels by Label Type IDs (list) |
value_gte | Filters Labels by value (greater than or equal; single value) |
value_lte | Filters Labels by value (lower than or equal; single value) |
create
Creates Label. Device authorization in header
Authorization: device dev-10525:SeCrEtPaSsWoRdis supported, in that case, use channel_numbers instead of Placements.
Example request:
{ "subcategory": 126375846344, "machine": 126375846344, "placements": [], "channel": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" }, "event": null }or
{ "subcategory": 126375846344, "channel_numbers": [ 1, 2, 3 ], "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" }, "event": null }
Example response:
{ "id": 126375846344, "subcategory": 126375846344, "machine": 126375846344, "channel": null, "source": 126375846344, "placements": [], "meta": { "test0": "Test 0" }, "event": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "description": "Description for Label #0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
subcategory required | Label Subcategory of the Label (not null) |
machine required | Machine of the Label (not null) |
channel | |
source | Source of the Label (null) |
placements | Placements of the Label |
meta | Metadata for the Label (any JSON) |
event | Related Event (null) |
start_datetime required | Start date for the Label (not null) |
end_datetime required | End date for the Label (not null) |
value | Value for the Label (null) |
description | Description of the Label (null, blank) |
upload
Creates multiple Labels at once.
Example request:
{ "labels": [ { "subcategory": 126375846344, "machine": 126375846344, "placements": [ 25, 26, 27 ], "dataset": 126375846344, "start_datetime": "2021-02-18T10:57:45.254485Z", "end_datetime": "2021-02-18T10:58:05.254485Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" } } ] }or
{ "labels": [ { "subcategory": 126375846344, "channel_numbers": [ 1, 2, 3 ], "dataset": 126375846344, "start_datetime": "2021-02-18T10:57:45.254485Z", "end_datetime": "2021-02-18T10:58:05.254485Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" } } ] }
Example response:
[ { "labels": [ { "id": 16326, "subcategory": 126375846344, "machine": 126375846344, "placements": [ 25, 26, 27 ], "dataset": 126375846344, "start_datetime": "2021-02-18T10:57:45.254485Z", "end_datetime": "2021-02-18T10:58:05.254485Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" } } ] } ]
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
labels | Labels to upload |
read
Returns Label by ID.
Example response:
{ "id": 126375846344, "subcategory": 126375846344, "machine": 126375846344, "channel": null, "source": 126375846344, "placements": [], "meta": { "test0": "Test 0" }, "event": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "description": "Description for Label #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Label.
Example request:
{ "subcategory": 126375846344, "machine": 126375846344, "placements": [], "channel": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" }, "event": null }or
{ "subcategory": 126375846344, "channel_numbers": [ 1, 2, 3 ], "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" }, "event": null }
Example response:
{ "id": 126375846344, "subcategory": 126375846344, "machine": 126375846344, "channel": null, "source": 126375846344, "placements": [], "meta": { "test0": "Test 0" }, "event": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "description": "Description for Label #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
channel | |
source | Source of the Label (null) |
placements | Placements of the Label |
meta | Metadata for the Label (any JSON) |
event | Related Event (null) |
start_datetime required | Start date for the Label (not null) |
end_datetime required | End date for the Label (not null) |
value | Value for the Label (null) |
description | Description of the Label (null, blank) |
partial_update
Partially updates Label.
Example request:
{ "subcategory": 126375846344, "machine": 126375846344, "placements": [], "channel": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" }, "event": null }or
{ "subcategory": 126375846344, "channel_numbers": [ 1, 2, 3 ], "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "source": 126375846344, "description": "Description for Label #0", "meta": { "test0": "Test 0" }, "event": null }
Example response:
{ "id": 126375846344, "subcategory": 126375846344, "machine": 126375846344, "channel": null, "source": 126375846344, "placements": [], "meta": { "test0": "Test 0" }, "event": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "description": "Description for Label #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
channel | |
source | Source of the Label (null) |
placements | Placements of the Label |
meta | Metadata for the Label (any JSON) |
event | Related Event (null) |
start_datetime | Start date for the Label (not null) |
end_datetime | End date for the Label (not null) |
value | Value for the Label (null) |
description | Description of the Label (null, blank) |
delete
Deletes Label.
Example response:
{ "id": 126375846344, "subcategory": 126375846344, "machine": 126375846344, "channel": null, "source": 126375846344, "placements": [], "meta": { "test0": "Test 0" }, "event": null, "start_datetime": "2024-03-29T00:38:23.692066Z", "end_datetime": "2024-03-29T00:38:43.692066Z", "value": 0.4, "description": "Description for Label #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Label. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
languages
list
Lists Languages.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Language.
Example request:
{ "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" }
Example response:
{ "id": 126375846344, "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Language name in this language (not null, not blank, unique) |
english_name required | Language name in English (not null, not blank, unique) |
codename required | Language codename - en_US, cs_CZ, ... (not null, not blank, unique) |
read
Returns Language by ID.
Example response:
{ "id": 126375846344, "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Language. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Language.
Example request:
{ "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" }
Example response:
{ "id": 126375846344, "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Language. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Language name in this language (not null, not blank, unique) |
english_name required | Language name in English (not null, not blank, unique) |
codename required | Language codename - en_US, cs_CZ, ... (not null, not blank, unique) |
partial_update
Partially updates Language.
Example request:
{ "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" }
Example response:
{ "id": 126375846344, "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Language. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Language name in this language (not null, not blank, unique) |
english_name | Language name in English (not null, not blank, unique) |
codename | Language codename - en_US, cs_CZ, ... (not null, not blank, unique) |
delete
Deletes Language.
Example response:
{ "id": 126375846344, "name": "Language #0", "english_name": "English name for language #0", "codename": "xx_AA" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Language. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
locations
list
List the queryset.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
tz | Time zone name in format Europe/Prague etc. |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Facility. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
machine_categories
list
Lists Machine Categories.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "company": null, "name": "Machine Category #22", "description": "Description for Machine Category #22", "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Machine Category.
Example request:
{ "name": "Machine Category #22", "description": "Description for Machine Category #22", "company": null, "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" }
Example response:
{ "id": 126375846344, "company": null, "name": "Machine Category #22", "description": "Description for Machine Category #22", "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company owning the Machine Category (null) |
name required | Name of the Machine Category (not null, not blank, unique) |
description | Description of the Machine Category (null, blank) |
installation_manual | URL of installation manual for the Machine Category (null, blank) |
read
Returns Machine Category by ID.
Example response:
{ "id": 126375846344, "company": null, "name": "Machine Category #22", "description": "Description for Machine Category #22", "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Machine Category.
Example request:
{ "name": "Machine Category #22", "description": "Description for Machine Category #22", "company": null, "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" }
Example response:
{ "id": 126375846344, "company": null, "name": "Machine Category #22", "description": "Description for Machine Category #22", "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company owning the Machine Category (null) |
name required | Name of the Machine Category (not null, not blank, unique) |
description | Description of the Machine Category (null, blank) |
installation_manual | URL of installation manual for the Machine Category (null, blank) |
partial_update
Partially updates Machine Category.
Example request:
{ "name": "Machine Category #22", "description": "Description for Machine Category #22", "company": null, "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" }
Example response:
{ "id": 126375846344, "company": null, "name": "Machine Category #22", "description": "Description for Machine Category #22", "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company owning the Machine Category (null) |
name | Name of the Machine Category (not null, not blank, unique) |
description | Description of the Machine Category (null, blank) |
installation_manual | URL of installation manual for the Machine Category (null, blank) |
delete
Deletes Machine Category.
Example response:
{ "id": 126375846344, "company": null, "name": "Machine Category #22", "description": "Description for Machine Category #22", "installation_manual": "https://some.domain.neuronsw.com/some/path/to/manual/22" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
machine_subcategories
Lists Machine Subcategories for specified Machine Category.
Example response:
{ "id": 42, "company": null, "category": 1, "name": "Machine Subcategory #9", "description": "Description for Machine Subcategory #9", "attachment": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
machine_images
list
Lists Machine Images.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "machine": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
machine | Filters Machine Images by Machine ID; example: ?machine=3 (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Machine Images by Machine ID; example: ?machine=3 (list) (inverse) |
create
Creates Machine Image.
Example request:
{ "machine": null, "type": "FULL", "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "version": "abcdefgh0000", "thumbnail": null }
Example response:
{ "id": 126375846344, "machine": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine required | The Machine this is the Image of (not null) |
image_data required | Binary Image data |
type | Image type, must be one of FULL, THUMBNAIL (not null, not blank) |
read
Returns Machine Image by ID.
Example response:
{ "id": 126375846344, "machine": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Image. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Machine Image.
Example request:
{ "machine": null, "type": "FULL", "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "version": "abcdefgh0000", "thumbnail": null }
Example response:
{ "id": 126375846344, "machine": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine Image. |
image_data | Binary Image data. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
partial_update
Partially updates Machine Image.
Example request:
{ "machine": null, "type": "FULL", "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "version": "abcdefgh0000", "thumbnail": null }
Example response:
{ "id": 126375846344, "machine": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine Image. |
image_data | Binary Image data. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
delete
Deletes Machine Image.
Example response:
{ "id": 126375846344, "machine": null, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "abcdefgh0000", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Image. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
machine_production_modes
list
Lists Machine Production Modes.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "machine": null, "codename": "Name for MachineProductionMode #0", "name": "Codename for MachineProductionMode #0", "description": "Description for MachineProductionMode #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
machine | Filters Machine Production Modes by Machine IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Machine Production Modes by Machine IDs (list) (inverse) |
create
override to have possibility to save tags
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine required | Machine (not null, not blank) |
codename required | Codename of the Machine Production Mode (not null, not blank) |
name required | Name of the Machine Production Mode (not null, not blank) |
description | Description of the Production Mode (null, blank) |
read
Returns Machine Production Mode by ID.
Example response:
{ "id": 126375846344, "machine": null, "codename": "Name for MachineProductionMode #0", "name": "Codename for MachineProductionMode #0", "description": "Description for MachineProductionMode #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Production Mode. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
A viewset used for retrieving and editing Machine Production Modes.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Production Mode. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine required | Machine (not null, not blank) |
codename required | Codename of the Machine Production Mode (not null, not blank) |
name required | Name of the Machine Production Mode (not null, not blank) |
description | Description of the Production Mode (null, blank) |
partial_update
A viewset used for retrieving and editing Machine Production Modes.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Production Mode. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine | Machine (not null, not blank) |
codename | Codename of the Machine Production Mode (not null, not blank) |
name | Name of the Machine Production Mode (not null, not blank) |
description | Description of the Production Mode (null, blank) |
delete
A viewset used for retrieving and editing Machine Production Modes.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Production Mode. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
machine_subcategories
list
Lists Machine Subcategories.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "company": null, "category": 126375846344, "name": "Machine Subcategory #23", "description": "Description for Machine Subcategory #23", "attachment": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
category | Filters Machine Subcategories by Machine Category IDs (list) |
id | Filters entities by IDs (list) |
not_category | Filters Machine Subcategories by Machine Category IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Machine Subcategory.
Example request:
{ "name": "Machine Subcategory #23", "category": 126375846344, "description": "Description for Machine Subcategory #23", "attachment": null, "company": null }
Example response:
{ "id": 126375846344, "company": null, "category": 126375846344, "name": "Machine Subcategory #23", "description": "Description for Machine Subcategory #23", "attachment": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company owning the Machine Subcategory (null) |
category required | Machine Category of the Machine Subcategory (not null) |
name required | Name of Machine Subcategory (not null, not blank) |
description | Description of the Machine Subcategory (null, blank) |
attachment | Attachment for the Machine Subcategory (null, blank) |
read
Returns Machine Subcategory by ID.
Example response:
{ "id": 126375846344, "company": null, "category": 126375846344, "name": "Machine Subcategory #23", "description": "Description for Machine Subcategory #23", "attachment": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Machine Subcategory.
Example request:
{ "name": "Machine Subcategory #23", "category": 126375846344, "description": "Description for Machine Subcategory #23", "attachment": null, "company": null }
Example response:
{ "id": 126375846344, "company": null, "category": 126375846344, "name": "Machine Subcategory #23", "description": "Description for Machine Subcategory #23", "attachment": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company owning the Machine Subcategory (null) |
name required | Name of Machine Subcategory (not null, not blank) |
description | Description of the Machine Subcategory (null, blank) |
attachment | Attachment for the Machine Subcategory (null, blank) |
partial_update
Partially updates Machine Subcategory.
Example request:
{ "name": "Machine Subcategory #23", "category": 126375846344, "description": "Description for Machine Subcategory #23", "attachment": null, "company": null }
Example response:
{ "id": 126375846344, "company": null, "category": 126375846344, "name": "Machine Subcategory #23", "description": "Description for Machine Subcategory #23", "attachment": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
company | Company owning the Machine Subcategory (null) |
name | Name of Machine Subcategory (not null, not blank) |
description | Description of the Machine Subcategory (null, blank) |
attachment | Attachment for the Machine Subcategory (null, blank) |
delete
Deletes Machine Subcategory.
Example response:
{ "id": 126375846344, "company": null, "category": 126375846344, "name": "Machine Subcategory #23", "description": "Description for Machine Subcategory #23", "attachment": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
category
Returns Machine Category for specified Machine Subcategory.
Example response:
{ "id": 3, "company": null, "name": "Test engine category", "description": null, "installation_manual": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine Subcategory. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
machines
list
Lists Machines.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Machine #19", "subcategory": 126375846344, "station": 126375846344, "additional_info": "Additional information about the Machine #19", "qr_code": "QR code for Machine #19", "record_length": 5, "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "has_snoozed_placements": false, "production_mode": null, "train_non_connected_placements": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null } ], "running": 1, "not_running": 0, "unknown": 0, "any_maintenance": 1, "broken": 2, "with_alert": 1 }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
company | Filters Machines by Company IDs (list) |
condition | Filters Machines by maintenance and broken Status:
|
facility | Filters Machines by Facility ID; example: ?facility=3 (list) |
has_snoozed_placements | Filters Machines by having/not having snoozed Placements (single value) |
id | Filters entities by IDs (list) |
images | Filters Machines by Machine Image IDs (list) |
is_additional_training_data | Filters Machines by additional training data Status (true/false; single value) |
is_any_maintenance | Filters Machines by any maintenance Status (true/false; single value) |
is_archived | Filters Machines by is_archived (single value) |
is_broken | Filters Machines by broken Status (true/false; single value) |
is_maintenance | Filters Machines by maintenance Status (true/false; single value) |
is_nominal_sound | Filters Machines by nominal sound Status (true/false; single value) |
is_nsw_maintenance | Filters Machines by NSW maintenance Status (true/false; single value) |
is_out_of_service | Filters Machines by out of service Status (true/false; single value) |
not_company | Filters Machines by Company IDs (list) (inverse) |
not_condition | Filters Machines by maintenance and broken Status:
|
not_facility | Filters Machines by Facility ID; example: ?facility=3 (list) (inverse) |
not_has_snoozed_placements | Filters Machines by having/not having snoozed Placements (single value) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_images | Filters Machines by Machine Image IDs (list) (inverse) |
not_is_additional_training_data | Filters Machines by additional training data Status (true/false; single value) (inverse) |
not_is_any_maintenance | Filters Machines by any maintenance Status (true/false; single value) (inverse) |
not_is_archived | Filters Machines by is_archived (single value) (inverse) |
not_is_broken | Filters Machines by broken Status (true/false; single value) (inverse) |
not_is_maintenance | Filters Machines by maintenance Status (true/false; single value) (inverse) |
not_is_nominal_sound | Filters Machines by nominal sound Status (true/false; single value) (inverse) |
not_is_nsw_maintenance | Filters Machines by NSW maintenance Status (true/false; single value) (inverse) |
not_is_out_of_service | Filters Machines by out of service Status (true/false; single value) (inverse) |
not_project | Filters Machines by Project IDs (list) (inverse) |
not_q | Filters Machines by search in name (single value) (inverse) |
not_status | Filters Machines by Status (running/not_running/unknown; list) (inverse) |
not_subcategory | Filters Machines by Subcategory IDs (list) (inverse) |
project | Filters Machines by Project IDs (list) |
q | Filters Machines by search in name (single value) |
status | Filters Machines by Status (running/not_running/unknown; list) |
subcategory | Filters Machines by Subcategory IDs (list) |
create
Creates Machine.
Example request:
{ "name": "Machine #19", "additional_info": "Additional information about the Machine #19", "record_length": 5, "subcategory": 126375846344, "station": 126375846344, "qr_code": "QR code for Machine #19", "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "production_mode": null, "train_non_connected_placements": false }
Example response:
{ "id": 126375846344, "name": "Machine #19", "subcategory": 126375846344, "station": 126375846344, "additional_info": "Additional information about the Machine #19", "qr_code": "QR code for Machine #19", "record_length": 5, "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "has_snoozed_placements": false, "production_mode": null, "train_non_connected_placements": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Machine (not null, not blank) |
subcategory required | Machine Subcategory of the Machine (not null) |
station required | Station of the Machine (not null) |
additional_info | Additional information about the Machine (null, blank) |
qr_code | QR code (null, blank) |
record_length | Maximum length of recording for the Machine (null) |
recording_period | Number of seconds of recording per minute for the Machine (not null) |
is_active | Whether the Machine is active |
contact_set | Contact Set for the Machine (null) |
recording_ranges | Machine of the Machine Recording Range |
recording_gate_level | Recording gate level for the Machine (null) |
is_sms_notifying | If SMS alert notifications should be triggered for this Machine |
is_email_notifying | If email alert notifications should be triggered for this Machine |
is_assisted_alerting | Whether the Machine uses the Assisted Alerting feature |
is_using_edge_loudness_model | Whether the Machine uses loundess model on Edge |
is_using_edge_models | Whether the Machine uses non-loudness models on Edge (e.g. anomaly, bands, ...) |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
is_archived | Whether the Machine is archived |
manufacturer | Manufacturer of the Machine (null, blank) |
product_name | Product name (null, blank) |
commissioning | Commissioning (null, blank) |
power | Power in kW (null, blank) |
machine_parts | Specifications of Machine parts (null, blank) |
operational_information | Whether the Machine is used 24/7 at full power or for peaks (null, blank) |
is_generating_dashboards | If API should automatically generate/regenerate Dashboards for this Machine |
time_zone | Time zone for the Machine (not null, not blank) |
production_mode | Machine Production Mode (blank) |
train_non_connected_placements | Whether the Placements that are not connected to any Device are trained |
read
Returns Machine by ID.
Example response:
{ "id": 126375846344, "name": "Machine #19", "subcategory": 126375846344, "station": 126375846344, "additional_info": "Additional information about the Machine #19", "qr_code": "QR code for Machine #19", "record_length": 5, "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "has_snoozed_placements": false, "production_mode": null, "train_non_connected_placements": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Machine.
Example request:
{ "name": "Machine #19", "additional_info": "Additional information about the Machine #19", "record_length": 5, "subcategory": 126375846344, "station": 126375846344, "qr_code": "QR code for Machine #19", "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "production_mode": null, "train_non_connected_placements": false }
Example response:
{ "id": 126375846344, "name": "Machine #19", "subcategory": 126375846344, "station": 126375846344, "additional_info": "Additional information about the Machine #19", "qr_code": "QR code for Machine #19", "record_length": 5, "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "has_snoozed_placements": false, "production_mode": null, "train_non_connected_placements": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Machine (not null, not blank) |
additional_info | Additional information about the Machine (null, blank) |
qr_code | QR code (null, blank) |
record_length | Maximum length of recording for the Machine (null) |
recording_period | Number of seconds of recording per minute for the Machine (not null) |
is_active | Whether the Machine is active |
contact_set | Contact Set for the Machine (null) |
recording_ranges | Machine of the Machine Recording Range |
recording_gate_level | Recording gate level for the Machine (null) |
is_sms_notifying | If SMS alert notifications should be triggered for this Machine |
is_email_notifying | If email alert notifications should be triggered for this Machine |
is_assisted_alerting | Whether the Machine uses the Assisted Alerting feature |
is_using_edge_loudness_model | Whether the Machine uses loundess model on Edge |
is_using_edge_models | Whether the Machine uses non-loudness models on Edge (e.g. anomaly, bands, ...) |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
is_archived | Whether the Machine is archived |
manufacturer | Manufacturer of the Machine (null, blank) |
product_name | Product name (null, blank) |
commissioning | Commissioning (null, blank) |
power | Power in kW (null, blank) |
machine_parts | Specifications of Machine parts (null, blank) |
operational_information | Whether the Machine is used 24/7 at full power or for peaks (null, blank) |
is_generating_dashboards | If API should automatically generate/regenerate Dashboards for this Machine |
time_zone | Time zone for the Machine (not null, not blank) |
production_mode | Machine Production Mode (blank) |
train_non_connected_placements | Whether the Placements that are not connected to any Device are trained |
partial_update
Partially updates Machine.
Example request:
{ "name": "Machine #19", "additional_info": "Additional information about the Machine #19", "record_length": 5, "subcategory": 126375846344, "station": 126375846344, "qr_code": "QR code for Machine #19", "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "production_mode": null, "train_non_connected_placements": false }
Example response:
{ "id": 126375846344, "name": "Machine #19", "subcategory": 126375846344, "station": 126375846344, "additional_info": "Additional information about the Machine #19", "qr_code": "QR code for Machine #19", "record_length": 5, "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "has_snoozed_placements": false, "production_mode": null, "train_non_connected_placements": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Machine (not null, not blank) |
additional_info | Additional information about the Machine (null, blank) |
qr_code | QR code (null, blank) |
record_length | Maximum length of recording for the Machine (null) |
recording_period | Number of seconds of recording per minute for the Machine (not null) |
is_active | Whether the Machine is active |
contact_set | Contact Set for the Machine (null) |
recording_ranges | Machine of the Machine Recording Range |
recording_gate_level | Recording gate level for the Machine (null) |
is_sms_notifying | If SMS alert notifications should be triggered for this Machine |
is_email_notifying | If email alert notifications should be triggered for this Machine |
is_assisted_alerting | Whether the Machine uses the Assisted Alerting feature |
is_using_edge_loudness_model | Whether the Machine uses loundess model on Edge |
is_using_edge_models | Whether the Machine uses non-loudness models on Edge (e.g. anomaly, bands, ...) |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
is_archived | Whether the Machine is archived |
manufacturer | Manufacturer of the Machine (null, blank) |
product_name | Product name (null, blank) |
commissioning | Commissioning (null, blank) |
power | Power in kW (null, blank) |
machine_parts | Specifications of Machine parts (null, blank) |
operational_information | Whether the Machine is used 24/7 at full power or for peaks (null, blank) |
is_generating_dashboards | If API should automatically generate/regenerate Dashboards for this Machine |
time_zone | Time zone for the Machine (not null, not blank) |
production_mode | Machine Production Mode (blank) |
train_non_connected_placements | Whether the Placements that are not connected to any Device are trained |
delete
Deletes Machine.
Example response:
{ "id": 126375846344, "name": "Machine #19", "subcategory": 126375846344, "station": 126375846344, "additional_info": "Additional information about the Machine #19", "qr_code": "QR code for Machine #19", "record_length": 5, "recording_period": 10, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": "2024-03-29T00:38:23.687783Z", "recording_ranges": [], "recording_gate_level": 0.3, "facility": null, "project": null, "company": null, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": false, "suppress_notifications_until": null, "is_archived": false, "manufacturer": null, "product_name": null, "commissioning": null, "power": null, "machine_parts": null, "operational_information": null, "is_generating_dashboards": true, "time_zone": "America/New_York", "has_snoozed_placements": false, "production_mode": null, "train_non_connected_placements": false, "status": "running", "alerts": 0, "new_alerts": null, "customer_informed_alerts": null, "under_investigation_alerts": null, "is_maintenance": true, "is_broken": true, "is_out_of_service": null, "is_nsw_maintenance": true, "is_any_maintenance": true, "is_nominal_sound": null, "is_additional_training_data": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
archive_model
A viewset used for retrieving and editing Machine instances.
Optional query parameters:
tz - offset timezone to modify returned dates
form - plain or detail, plain does not return nested serializers but only closest child IDs
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Machine (not null, not blank) |
subcategory | Machine Subcategory of the Machine (not null) |
station | Station of the Machine (not null) |
additional_info | Additional information about the Machine (null, blank) |
qr_code | QR code (null, blank) |
record_length | Maximum length of recording for the Machine (null) |
recording_period | Number of seconds of recording per minute for the Machine (not null) |
is_active | Whether the Machine is active |
contact_set | Contact Set for the Machine (null) |
recording_ranges | Machine of the Machine Recording Range |
recording_gate_level | Recording gate level for the Machine (null) |
is_sms_notifying | If SMS alert notifications should be triggered for this Machine |
is_email_notifying | If email alert notifications should be triggered for this Machine |
is_assisted_alerting | Whether the Machine uses the Assisted Alerting feature |
is_using_edge_loudness_model | Whether the Machine uses loundess model on Edge |
is_using_edge_models | Whether the Machine uses non-loudness models on Edge (e.g. anomaly, bands, ...) |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
is_archived | Whether the Machine is archived |
manufacturer | Manufacturer of the Machine (null, blank) |
product_name | Product name (null, blank) |
commissioning | Commissioning (null, blank) |
power | Power in kW (null, blank) |
machine_parts | Specifications of Machine parts (null, blank) |
operational_information | Whether the Machine is used 24/7 at full power or for peaks (null, blank) |
is_generating_dashboards | If API should automatically generate/regenerate Dashboards for this Machine |
time_zone | Time zone for the Machine (not null, not blank) |
production_mode | Machine Production Mode (blank) |
train_non_connected_placements | Whether the Placements that are not connected to any Device are trained |
attachments
A viewset used for retrieving and editing Machine instances.
Optional query parameters:
tz - offset timezone to modify returned dates
form - plain or detail, plain does not return nested serializers but only closest child IDs
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
dashboards
Lists Dashboards for specified Machine.
Example response:
{ "id": 20, "machine": 32828, "dashboard_type": 1, "model_environment": 1, "grafana_id": 525, "grafana_uid": "k-rYrShMz" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
deploy_model
Deploys trained models for specified Machine.
Example response:
{}
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
trained_model_id required | Trained model ID. |
environment | Environment (testing, stage, production (default) etc.). |
devices
Lists Devices for specified Machine.
Example response:
{ "id": 1075, "name": "10934", "note": "Dedicated device", "internet_connection": "LTE", "version": null, "telephone_number": null, "carrier": "None", "has_sdcard": false, "mac_address": null, "has_hdd": false, "serial_uid": "g24nuvvmqolb", "status": "new", "project": 602, "channels": [ 3870, 3871 ], "channel_count": 2, "assigned_channel_count": 2, "assigned_placements": [ 5619, 5618 ], "facility": 418, "company": 337, "machines": [ 1590 ], "recording_plan": "democase", "edge_discard_audio": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
events
Lists Events for specified Machine.
Example response:
{ "type": "anomaly", "meta": null, "machine": 1590, "created_at": "2021-03-04T17:32:53.639449Z" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
image
Returns Image data for specified Machine
Example response:
{ "id": 2, "machine": 275719, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "FULL", "version": "4925539f4b11d7e53ff2799ea962540c2458c045865b7910c05db8ab72256c93", "thumbnail": { "id": 1, "machine": 275719, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "THUMBNAIL", "version": "4ca58886ce6d366d932b87a9c7f8b095d90db03a744a39caeadf1e8fe92f149c", "thumbnail": null } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
mass_acknowledge_events
Mass acknowledges Events for given Machine and Event Types.
Example request:
{ "types": [ "anomaly" ], "events": [ 1, 2, 3, 4, 5 ], "note": "some note" }
Example response:
{ "status": "acknowledged", "count": 5 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
types | List of Event Type codenames to acknowledge (optional). |
events | List of Event IDs to acknowledge (optional). |
note | Note that will be appended to acknowledged Events (optional). |
alert_severity | Alert Severity (optional). |
placements
Lists Placements for specified Machine.
Example response:
{ "id": 5618, "machine": 1590, "type": 39, "qr_code": null, "panel_id": null, "custom_name": "hey Rail", "placement_type_name": "Rail", "channel": 3871, "is_enabled": true, "running_threshold": 0.5 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
production_modes
A viewset used for retrieving and editing Machine instances.
Optional query parameters:
tz - offset timezone to modify returned dates
form - plain or detail, plain does not return nested serializers but only closest child IDs
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
recompute
Recompute results for specified Machine.
Example response:
{}
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
trained_model_id required | Trained model ID. |
environment required | Environment (testing, stage, production (default) etc.). |
start_datetime required | Start datetime to recompute results for. |
end_datetime required | End datetime to recompute results for. |
stop_training
A viewset used for retrieving and editing Machine instances.
Optional query parameters:
tz - offset timezone to modify returned dates
form - plain or detail, plain does not return nested serializers but only closest child IDs
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Machine (not null, not blank) |
subcategory required | Machine Subcategory of the Machine (not null) |
station required | Station of the Machine (not null) |
additional_info | Additional information about the Machine (null, blank) |
qr_code | QR code (null, blank) |
record_length | Maximum length of recording for the Machine (null) |
recording_period | Number of seconds of recording per minute for the Machine (not null) |
is_active | Whether the Machine is active |
contact_set | Contact Set for the Machine (null) |
recording_ranges | Machine of the Machine Recording Range |
recording_gate_level | Recording gate level for the Machine (null) |
is_sms_notifying | If SMS alert notifications should be triggered for this Machine |
is_email_notifying | If email alert notifications should be triggered for this Machine |
is_assisted_alerting | Whether the Machine uses the Assisted Alerting feature |
is_using_edge_loudness_model | Whether the Machine uses loundess model on Edge |
is_using_edge_models | Whether the Machine uses non-loudness models on Edge (e.g. anomaly, bands, ...) |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
is_archived | Whether the Machine is archived |
manufacturer | Manufacturer of the Machine (null, blank) |
product_name | Product name (null, blank) |
commissioning | Commissioning (null, blank) |
power | Power in kW (null, blank) |
machine_parts | Specifications of Machine parts (null, blank) |
operational_information | Whether the Machine is used 24/7 at full power or for peaks (null, blank) |
is_generating_dashboards | If API should automatically generate/regenerate Dashboards for this Machine |
time_zone | Time zone for the Machine (not null, not blank) |
production_mode | Machine Production Mode (blank) |
train_non_connected_placements | Whether the Placements that are not connected to any Device are trained |
thumbnail
Returns Image thumbnail data for specified Machine
Example response:
{ "id": 1, "machine": 275719, "image_data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "type": "THUMBNAIL", "version": "4ca58886ce6d366d932b87a9c7f8b095d90db03a744a39caeadf1e8fe92f149c", "thumbnail": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
train
Trains models for specified Machine.
Example response:
{}
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
unarchive_model
A viewset used for retrieving and editing Machine instances.
Optional query parameters:
tz - offset timezone to modify returned dates
form - plain or detail, plain does not return nested serializers but only closest child IDs
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Machine (not null, not blank) |
subcategory | Machine Subcategory of the Machine (not null) |
station | Station of the Machine (not null) |
additional_info | Additional information about the Machine (null, blank) |
qr_code | QR code (null, blank) |
record_length | Maximum length of recording for the Machine (null) |
recording_period | Number of seconds of recording per minute for the Machine (not null) |
is_active | Whether the Machine is active |
contact_set | Contact Set for the Machine (null) |
recording_ranges | Machine of the Machine Recording Range |
recording_gate_level | Recording gate level for the Machine (null) |
is_sms_notifying | If SMS alert notifications should be triggered for this Machine |
is_email_notifying | If email alert notifications should be triggered for this Machine |
is_assisted_alerting | Whether the Machine uses the Assisted Alerting feature |
is_using_edge_loudness_model | Whether the Machine uses loundess model on Edge |
is_using_edge_models | Whether the Machine uses non-loudness models on Edge (e.g. anomaly, bands, ...) |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
is_archived | Whether the Machine is archived |
manufacturer | Manufacturer of the Machine (null, blank) |
product_name | Product name (null, blank) |
commissioning | Commissioning (null, blank) |
power | Power in kW (null, blank) |
machine_parts | Specifications of Machine parts (null, blank) |
operational_information | Whether the Machine is used 24/7 at full power or for peaks (null, blank) |
is_generating_dashboards | If API should automatically generate/regenerate Dashboards for this Machine |
time_zone | Time zone for the Machine (not null, not blank) |
production_mode | Machine Production Mode (blank) |
train_non_connected_placements | Whether the Placements that are not connected to any Device are trained |
undeploy_model
Undeploys trained models for specified Machine.
Example response:
{}
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
deployment_id required | Model Deployment ID. |
admin_logs > list
Lists Admin Logs.
Example response:
[ { "id": 1, "log": "Some log message", "title": "Some title", "time": "2021-03-05T11:34:29.450553Z", "user": 123 } ]
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
admin_logs > create
Creates Admin Log.
Example request:
{ "log": "Some log message", "title": "Some title" }
Example response:
{ "id": 1, "log": "Some log message", "title": "Some title", "time": "2021-03-05T11:34:29.450553Z", "user": 123 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
log required | Content of the Admin Log. |
title required | Title of the Admin Log. |
attachment | Attachment of the Admin Log. |
admin_logs > read
Returns Admin Log by ID.
Example response:
{ "id": 1, "log": "Some log message", "title": "Some title", "time": "2021-03-05T11:34:29.450553Z", "user": 123 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
admin_log_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
admin_logs > update
Updates Admin Log.
Example request:
{ "log": "Some log message", "title": "Some title" }
Example response:
{ "id": 1, "log": "Some log message", "title": "Some title", "time": "2021-03-05T11:34:29.450553Z", "user": 123 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
admin_log_id required | A unique integer value identifying this Admin Log. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
log required | Content of the Admin Log. |
title required | Title of the Admin Log. |
admin_logs > partial_update
Partially updates Admin Log.
Example request:
{ "log": "Some log message", "title": "Some title" }
Example response:
{ "id": 1, "log": "Some log message", "title": "Some title", "time": "2021-03-05T11:34:29.450553Z", "user": 123 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
admin_log_id required | A unique integer value identifying this Admin Log. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
log required | Content of the Admin Log. |
title required | Title of the Admin Log. |
admin_logs > delete
Deletes Admin Logs.
Example response:
{}
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
admin_log_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
admin_logs > attachment
Returns Admin Log attachment content (byte stream).
Example response:
{}
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Machine. |
admin_log_id required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
maintenance_types
list
Lists Maintenance Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Maintenance Type.
Example request:
{ "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" }
Example response:
{ "id": 126375846344, "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the Maintenance Type, must be one of regular_maintenance, urgent_unplanned (not null, not blank, unique) |
description | Description of the Maintenance Type (null, blank) |
read
Returns Maintenance Type by ID.
Example response:
{ "id": 126375846344, "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Maintenance Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Maintenance Type.
Example request:
{ "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" }
Example response:
{ "id": 126375846344, "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Maintenance Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the Maintenance Type, must be one of regular_maintenance, urgent_unplanned (not null, not blank, unique) |
description | Description of the Maintenance Type (null, blank) |
partial_update
Partially updates Maintenance Type.
Example request:
{ "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" }
Example response:
{ "id": 126375846344, "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Maintenance Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | Codename of the Maintenance Type, must be one of regular_maintenance, urgent_unplanned (not null, not blank, unique) |
description | Description of the Maintenance Type (null, blank) |
delete
Deletes Maintenance Type.
Example response:
{ "id": 126375846344, "codename": "regular_maintenance", "description": "Description for Maintenance Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Maintenance Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
model_deployments
list
Lists Model Deployments.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "model_environment": "Name for Model Environment #7", "model_type": null, "name": "name_for_model6", "created_at": null, "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "trained_model_id": null, "deployment_type": "cloud" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
from | Filters Model Deployments by creation datetime (from; single value) |
id | Filters entities by IDs (list) |
is_deleted | Filters Model Deployments by is_deleted (single value) |
is_ready | Filters Model Deployments by is_ready (single value) |
machine | Filters Model Deployments by Machine ID (list) |
model_environment | Filters Model Deployments by Model Environment name (list) |
model_type | Filters Model Deployments by Model Type ID (list) |
not_from | Filters Model Deployments by creation datetime (from; single value) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_is_deleted | Filters Model Deployments by is_deleted (single value) (inverse) |
not_is_ready | Filters Model Deployments by is_ready (single value) (inverse) |
not_machine | Filters Model Deployments by Machine ID (list) (inverse) |
not_model_environment | Filters Model Deployments by Model Environment name (list) (inverse) |
not_model_type | Filters Model Deployments by Model Type ID (list) (inverse) |
not_to | Filters Model Deployments by creation datetime (to; single value) (inverse) |
not_trained_model_id | Filters Model Deployments by trained_model_id (list) (inverse) |
to | Filters Model Deployments by creation datetime (to; single value) |
trained_model_id | Filters Model Deployments by trained_model_id (list) |
create
Creates Model Deployment.
Example request:
{ "created_at": null, "name": "name_for_model6", "model_environment": "Name for Model Environment #7", "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "deployment_type": "cloud" }
Example response:
{ "id": 126375846344, "model_environment": "Name for Model Environment #7", "model_type": null, "name": "name_for_model6", "created_at": null, "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "trained_model_id": null, "deployment_type": "cloud" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
model_environment required | Model Environment of the Model Deployment (not null) |
model_type | Model Type of Model Deployment |
name required | Name of the Model Deployment (not null, not blank, unique, alnum + _-) |
is_ready | Whether the Model Deployment is ready to be fed with data |
is_deleted | Whether the Model Deployment is deleted |
endpoint_url required | URI of endpoint of the Model Deployment |
meta | Metadata for the Model Deployment (any JSON) |
image_name | Name of the built image |
image_tag | Tag of the built image |
trained_model_id | ID of trained model in nswctl database |
deployment_type | Deployment type of the Model Deployment (not null, must be one of edge, cloud, recompute) |
read
Returns Model Deployment by ID.
Example response:
{ "id": 126375846344, "model_environment": "Name for Model Environment #7", "model_type": null, "name": "name_for_model6", "created_at": null, "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "trained_model_id": null, "deployment_type": "cloud" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Model Deployment.
Example request:
{ "created_at": null, "name": "name_for_model6", "model_environment": "Name for Model Environment #7", "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "deployment_type": "cloud" }
Example response:
{ "id": 126375846344, "model_environment": "Name for Model Environment #7", "model_type": null, "name": "name_for_model6", "created_at": null, "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "trained_model_id": null, "deployment_type": "cloud" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
model_environment required | Model Environment of the Model Deployment (not null) |
model_type | Model Type of Model Deployment |
name required | Name of the Model Deployment (not null, not blank, unique, alnum + _-) |
is_ready | Whether the Model Deployment is ready to be fed with data |
is_deleted | Whether the Model Deployment is deleted |
endpoint_url required | URI of endpoint of the Model Deployment |
meta | Metadata for the Model Deployment (any JSON) |
image_name | Name of the built image |
image_tag | Tag of the built image |
trained_model_id | ID of trained model in nswctl database |
deployment_type | Deployment type of the Model Deployment (not null, must be one of edge, cloud, recompute) |
partial_update
Partially updates Model Deployment.
Example request:
{ "created_at": null, "name": "name_for_model6", "model_environment": "Name for Model Environment #7", "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "deployment_type": "cloud" }
Example response:
{ "id": 126375846344, "model_environment": "Name for Model Environment #7", "model_type": null, "name": "name_for_model6", "created_at": null, "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "trained_model_id": null, "deployment_type": "cloud" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
model_environment | Model Environment of the Model Deployment (not null) |
model_type | Model Type of Model Deployment |
name | Name of the Model Deployment (not null, not blank, unique, alnum + _-) |
is_ready | Whether the Model Deployment is ready to be fed with data |
is_deleted | Whether the Model Deployment is deleted |
endpoint_url | URI of endpoint of the Model Deployment |
meta | Metadata for the Model Deployment (any JSON) |
image_name | Name of the built image |
image_tag | Tag of the built image |
trained_model_id | ID of trained model in nswctl database |
deployment_type | Deployment type of the Model Deployment (not null, must be one of edge, cloud, recompute) |
delete
Deletes Model Deployment.
Example response:
{ "id": 126375846344, "model_environment": "Name for Model Environment #7", "model_type": null, "name": "name_for_model6", "created_at": null, "is_ready": true, "is_deleted": false, "endpoint_url": "https://some-hostname/some-endpoint6", "meta": { "test6": "Test 6" }, "image_name": "image_name6", "image_tag": "image_tag6", "trained_model_id": null, "deployment_type": "cloud" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Deployment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
model_environments
list
Lists Model Environments.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Model Environment.
Example request:
{ "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" }
Example response:
{ "id": 126375846344, "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Model Environment (not null, not blank, unique) |
description | Description of the Model Environment (null, blank) |
read
Returns Model Environment by ID.
Example response:
{ "id": 126375846344, "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Environment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Model Environment.
Example request:
{ "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" }
Example response:
{ "id": 126375846344, "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Environment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Model Environment (not null, not blank, unique) |
description | Description of the Model Environment (null, blank) |
partial_update
Partially updates Model Environment.
Example request:
{ "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" }
Example response:
{ "id": 126375846344, "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Environment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Model Environment (not null, not blank, unique) |
description | Description of the Model Environment (null, blank) |
delete
Deletes Model Environment.
Example response:
{ "id": 126375846344, "name": "Name for Model Environment #8", "description": "Description for Model Environment #8" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Environment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
model_result_types
list
Lists Model Result Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
name | Filters Model Result Types by names (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_name | Filters Model Result Types by names (list) (inverse) |
create
Creates Model Result Type.
Example request:
{ "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" }
Example response:
{ "id": 126375846344, "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Model Result Type (not null, not blank, unique) |
description | Description of the Model Result Type (null, blank) |
read
Returns Model Result Type by ID.
Example response:
{ "id": 126375846344, "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Result Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Model Result Type.
Example request:
{ "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" }
Example response:
{ "id": 126375846344, "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Result Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Model Result Type (not null, not blank, unique) |
description | Description of the Model Result Type (null, blank) |
partial_update
Partially updates Model Result Type.
Example request:
{ "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" }
Example response:
{ "id": 126375846344, "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Result Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Model Result Type (not null, not blank, unique) |
description | Description of the Model Result Type (null, blank) |
delete
Deletes Model Result Type.
Example response:
{ "id": 126375846344, "name": "Name for Model Result Type #0", "description": "Description for Model Result Type #0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Result Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
model_types
list
Lists Model Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "Codename for Model Type #7", "name": "Name for Model Type #7", "description": "Description for Model Type #7" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Model Type.
Example request:
{ "codename": "Codename for Model Type #7", "name": "Name for Model Type #7", "description": "Description for Model Type #7" }
Example response:
{ "id": 126375846344, "codename": "Codename for Model Type #7", "name": "Name for Model Type #7", "description": "Description for Model Type #7" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of Model Type (not null, not blank, unique) |
name required | Name of Model Type (not null, not blank, unique) |
description | Description of the Model Type (null, blank) |
read
Returns Model Type by ID.
Example response:
{ "id": 126375846344, "codename": "Codename for Model Type #7", "name": "Name for Model Type #7", "description": "Description for Model Type #7" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Model Type.
Example request:
{ "codename": "Codename for Model Type #7", "name": "Name for Model Type #7", "description": "Description for Model Type #7" }
Example response:
{ "id": 126375846344, "codename": "Codename for Model Type #7", "name": "Name for Model Type #7", "description": "Description for Model Type #7" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of Model Type (not null, not blank, unique) |
name required | Name of Model Type (not null, not blank, unique) |
description | Description of the Model Type (null, blank) |
partial_update
Partially updates Model Type.
Example request:
{ "codename": "Codename for Model Type #7", "name": "Name for Model Type #7", "description": "Description for Model Type #7" }
Example response:
{ "id": 126375846344, "codename": "Codename for Model Type #7", "name": "Name for Model Type #7", "description": "Description for Model Type #7" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | Codename of Model Type (not null, not blank, unique) |
name | Name of Model Type (not null, not blank, unique) |
description | Description of the Model Type (null, blank) |
delete
A viewset used for retrieving and editing stored Model Types.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Model Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
monthly_report_files
list
Lists Monthly Report Files.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 192, "report": 21, "language": 1, "link": "https://storage.googleapis.com/sw_api/test/monthly_report_attachments/monthly_report_en_US_2023-09_15604.tbMIwTDj.pdf?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4849861078&Signature=W%2B7ivziRE4eImtRe8pBF7xApjEAKs0NrbZdTXQiJY9TEratoWeACuJXGwNOzUz1ni%2FiNllXT0zoLYl8VLqeA9ld%2BMN6BvRaVDG9iqrwY%2FmC0LEbvqZ9No3MbQudDIuRJJDfBd7WacQTd12uRpMgnuCT4QmP0%2FUb9RG1qTg826xMF8xyrN4x2OeyemLP0jkEnT1q2qmhINrO%2FGwQKCIApOjKL7%2FS%2FY53D8brNzIUTDCsUgEz8y2Kcr0KbWLHVgG2ZLSEP1yzQctYpl8ogslV3Pmfj%2BX9cU5gZhC1bW4at5TAflkbTSPAbBFPKT%2B09j83aOFETMKwWwFOnfd9Pn1A%2BYg%3D%3D", "file": "test/monthly_report_attachments/monthly_report_en_US_2023-09_15604.tbMIwTDj.pdf" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
language | Filters Monthly Report Files by Language codenames (list) |
not_id | Filters entities by IDs (list) (inverse) |
not_language | Filters Monthly Report Files by Language codenames (list) (inverse) |
not_report | Filters Monthly Report Files by Monthly Report IDs (list) (inverse) |
report | Filters Monthly Report Files by Monthly Report IDs (list) |
read
Returns Monthly Report File by ID.
Example response:
{ "id": 192, "report": 21, "language": 1, "link": "https://storage.googleapis.com/sw_api/test/monthly_report_attachments/monthly_report_en_US_2023-09_15604.tbMIwTDj.pdf?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4849861078&Signature=W%2B7ivziRE4eImtRe8pBF7xApjEAKs0NrbZdTXQiJY9TEratoWeACuJXGwNOzUz1ni%2FiNllXT0zoLYl8VLqeA9ld%2BMN6BvRaVDG9iqrwY%2FmC0LEbvqZ9No3MbQudDIuRJJDfBd7WacQTd12uRpMgnuCT4QmP0%2FUb9RG1qTg826xMF8xyrN4x2OeyemLP0jkEnT1q2qmhINrO%2FGwQKCIApOjKL7%2FS%2FY53D8brNzIUTDCsUgEz8y2Kcr0KbWLHVgG2ZLSEP1yzQctYpl8ogslV3Pmfj%2BX9cU5gZhC1bW4at5TAflkbTSPAbBFPKT%2B09j83aOFETMKwWwFOnfd9Pn1A%2BYg%3D%3D", "file": "test/monthly_report_attachments/monthly_report_en_US_2023-09_15604.tbMIwTDj.pdf" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Monthly Report File. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
monthly_reports
list
Lists Monthly Reports.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "created_at": "2024-03-29T00:38:23.688382Z", "last_update_at": "2024-03-29T00:38:23.688391Z", "project": null, "company_logo": null, "service_subject": null, "name": "Monthly report - 2024/03", "recommendations": null, "created_for": "2024-03-29", "link": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
created_for | Filters Monthly Reports by created_for(s) - only year and month is considered in the comparison (list) |
id | Filters entities by IDs (list) |
not_created_for | Filters Monthly Reports by created_for(s) - only year and month is considered in the comparison (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_project | Filters Monthly Reports by Project IDs (list) (inverse) |
project | Filters Monthly Reports by Project IDs (list) |
create
Creates Monthly Report.
Example request:
{ "project": null, "created_for": "2024-03-29", "recommendations": null }
Example response:
{ "name": "Monthly report - 2024/03", "project": null, "company_logo": null, "service_subject": null, "created_at": "2024-03-29T00:38:23.688382Z", "last_update_at": "2024-03-29T00:38:23.688391Z", "created_for": "2024-03-29", "recommendations": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
project required | |
recommendations | Warnings and recommendations |
created_for required | Month and year for creation of the Monthly Report |
read
Returns Monthly Report by ID.
Example response:
{ "id": 126375846344, "created_at": "2024-03-29T00:38:23.688382Z", "last_update_at": "2024-03-29T00:38:23.688391Z", "project": null, "company_logo": null, "service_subject": null, "name": "Monthly report - 2024/03", "recommendations": null, "created_for": "2024-03-29", "link": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Monthly Report. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Monthly Report.
Example request:
{ "project": null, "created_for": "2024-03-29", "recommendations": null }
Example response:
{ "name": "Monthly report - 2024/03", "project": null, "company_logo": null, "service_subject": null, "created_at": "2024-03-29T00:38:23.688382Z", "last_update_at": "2024-03-29T00:38:23.688391Z", "created_for": "2024-03-29", "recommendations": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Monthly Report. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
project required | |
recommendations | Warnings and recommendations |
created_for required | Month and year for creation of the Monthly Report |
partial_update
Partially updates Monthly Report.
Example request:
{ "project": null, "created_for": "2024-03-29", "recommendations": null }
Example response:
{ "name": "Monthly report - 2024/03", "project": null, "company_logo": null, "service_subject": null, "created_at": "2024-03-29T00:38:23.688382Z", "last_update_at": "2024-03-29T00:38:23.688391Z", "created_for": "2024-03-29", "recommendations": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Monthly Report. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
project | |
recommendations | Warnings and recommendations |
created_for | Month and year for creation of the Monthly Report |
delete
Deletes Monthly Report.
Example response:
{ "id": 126375846344, "created_at": "2024-03-29T00:38:23.688382Z", "last_update_at": "2024-03-29T00:38:23.688391Z", "project": null, "company_logo": null, "service_subject": null, "name": "Monthly report - 2024/03", "recommendations": null, "created_for": "2024-03-29", "link": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Monthly Report. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
generate
Generate Monthly Report Files in PDF.
Example response:
{ "id": 126375846344, "created_at": "2024-03-29T00:38:23.688382Z", "last_update_at": "2024-03-29T00:38:23.688391Z", "project": null, "company_logo": null, "service_subject": null, "name": "Monthly report - 2024/03", "recommendations": null, "created_for": "2024-03-29", "link": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | Monthly Report ID |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
send
Send email notifications with Monthly Report Files in PDF.
Example response:
{ "id": 126375846344, "created_at": "2024-03-29T00:38:23.688382Z", "last_update_at": "2024-03-29T00:38:23.688391Z", "project": null, "company_logo": null, "service_subject": null, "name": "Monthly report - 2024/03", "recommendations": null, "created_for": "2024-03-29", "link": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | Monthly Report ID |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
users required | Active non-internal Project Users to send the Reports to |
onboard_machine
create
Creates all needed stuff for new Machine onboarding.
Example request:
{ "facility": { "project": 3, "name": "Testing Facility Name", "address": "Testing Facility Address", "description": "Testing Facility Description" }, "machine": { "name": "Testing Machine Name", "additional_info": "Testing Machine Description", "facility": null, "subcategory": 3, "qr_code": "Test QR code", "record_length": 15, "recording_period": 3, "contact_set": null, "recording_ranges": [], "recording_gate_level": 0.3, "manufacturer": "TEDOM", "product_name": "TEDOM QUANTO D2000", "commissioning": "2024-03-29T00:38:23.699532Z", "power": 2014, "machine_parts": "Engine Deutz TCG 2020 V20. Generator MArellin MJB 560 LA4.", "operational_information": "Full power" }, "device_serial_uid": "m2k9kzf40fmy", "placements": [ { "placement_type": 29, "channel_number": 1 }, { "placement_type": 30, "channel_number": 2 } ] }
Example response:
{ "id": 589, "name": "Testing Machine Name", "subcategory": 3, "station": 211, "additional_info": "Testing Machine Description", "qr_code": "Test QR code", "record_length": 15, "recording_period": 3, "is_active": false, "state": null, "devices": [], "contact_set": null, "recording_start_datetime": null, "recording_ranges": [], "recording_gate_level": 0.3, "manufacturer": "TEDOM", "product_name": "TEDOM QUANTO D2000", "commissioning": "2024-03-29T00:38:23.699552Z", "power": 2014, "machine_parts": "Engine Deutz TCG 2020 V20. Generator MArellin MJB 560 LA4.", "operational_information": "Full power" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
facility | Facility details in a JSON format |
machine required | Machine details in a JSON format |
device_serial_uid | Device serial UID |
placements | List of Placement details in a JSON format |
password_reset
create
Resets password for User given by UUID, only if token is ok.
Example request:
{ "password": "12345", "password_confirmation": "12345" }
Example response:
{ "status": "Password changed" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required | User UUID |
token required | User token |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
password required | New password |
password_confirmation required | New password for confirmation |
placement_bearing_bands
list
Lists Placement Bearing Bands.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "placement": 126375846344, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}", "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0 } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Placement Bearing Bands.
Example request:
{ "placement": 126375846344, "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}" }
Example response:
{ "id": 126375846344, "placement": 126375846344, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}", "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0 }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
placement required | Placement this Placement Bearing Band belongs to (not null) |
fc_frequency required | Frequency of rolling element set & cage |
fc_width required | Width of rolling element set & cage |
fr_frequency required | Frequency of rolling element about its axis |
fr_width required | Width of rolling element about its axis |
fip_frequency required | Frequency of point on inner ring |
fip_width required | Width of point on inner ring |
fep_frequency required | Frequency of point on outer ring |
fep_width required | Width of point on outer ring |
read
Returns Placement Bearing Band by ID.
Example response:
{ "id": 126375846344, "placement": 126375846344, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}", "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Bearing Band. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Placement Bearing Band.
Example request:
{ "placement": 126375846344, "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}" }
Example response:
{ "id": 126375846344, "placement": 126375846344, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}", "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Bearing Band. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
fc_frequency required | Frequency of rolling element set & cage |
fc_width required | Width of rolling element set & cage |
fr_frequency required | Frequency of rolling element about its axis |
fr_width required | Width of rolling element about its axis |
fip_frequency required | Frequency of point on inner ring |
fip_width required | Width of point on inner ring |
fep_frequency required | Frequency of point on outer ring |
fep_width required | Width of point on outer ring |
partial_update
Partially updates Placement Bearing Band.
Example request:
{ "placement": 126375846344, "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}" }
Example response:
{ "id": 126375846344, "placement": 126375846344, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}", "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Bearing Band. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
fc_frequency | Frequency of rolling element set & cage |
fc_width | Width of rolling element set & cage |
fr_frequency | Frequency of rolling element about its axis |
fr_width | Width of rolling element about its axis |
fip_frequency | Frequency of point on inner ring |
fip_width | Width of point on inner ring |
fep_frequency | Frequency of point on outer ring |
fep_width | Width of point on outer ring |
delete
Deletes Placement Bearing Band.
Example response:
{ "id": 126375846344, "placement": 126375846344, "placement_bearing_band": "{\"frequency_bands\": [{\"band_id\": \"fc\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fr\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fip\", \"frequency\": 0, \"width\": 0}, {\"band_id\": \"fep\", \"frequency\": 0, \"width\": 0}]}", "fc_frequency": 0.0, "fc_width": 0.0, "fr_frequency": 0.0, "fr_width": 0.0, "fip_frequency": 0.0, "fip_width": 0.0, "fep_frequency": 0.0, "fep_width": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Bearing Band. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
placement_types
list
Lists Placement Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "Placement Type #7", "description": "Description for Placement Type #7" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Placement Type.
Example request:
{ "name": "Placement Type #7", "description": "Description for Placement Type #7" }
Example response:
{ "id": 126375846344, "name": "Placement Type #7", "description": "Description for Placement Type #7" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Placement Type (not null, not blank, unique) |
description | Description of the Placement Type (null, blank) |
read
Returns Placement Type by ID.
Example response:
{ "id": 126375846344, "name": "Placement Type #7", "description": "Description for Placement Type #7" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Placement Type.
Example request:
{ "name": "Placement Type #7", "description": "Description for Placement Type #7" }
Example response:
{ "id": 126375846344, "name": "Placement Type #7", "description": "Description for Placement Type #7" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Placement Type (not null, not blank, unique) |
description | Description of the Placement Type (null, blank) |
partial_update
Partially updates Placement Type.
Example request:
{ "name": "Placement Type #7", "description": "Description for Placement Type #7" }
Example response:
{ "id": 126375846344, "name": "Placement Type #7", "description": "Description for Placement Type #7" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Placement Type (not null, not blank, unique) |
description | Description of the Placement Type (null, blank) |
delete
Deletes Placement Type.
Example response:
{ "id": 126375846344, "name": "Placement Type #7", "description": "Description for Placement Type #7" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
failures
Lists Failures for specified Placement Type.
Example response:
[ { "id": 5, "placement_type": 7, "failure_type": 6 } ]
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
placements
list
Lists Placements.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "machine": 126375846344, "type": 126375846344, "qr_code": "QR code for Placement #8", "panel_id": 9, "custom_name": null, "placement_type_name": "Placement Type #12", "channel": 126375846344, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "band_width_in_percents": 100, "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "placement_bearing_band": [], "audio_chunk_type": "audio", "recording_plan": null, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true, "alerting_config_including_generated": { "rules": [] } } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
channel | Filters Placements by Channel IDs (list) |
id | Filters entities by IDs (list) |
machine | Filters Placements by Machine IDs (list) |
not_channel | Filters Placements by Channel IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_machine | Filters Placements by Machine IDs (list) (inverse) |
not_panel_id | Filters Placements by panel IDs (list) (inverse) |
not_type | Filters Placements by Placement Type IDs (list) (inverse) |
panel_id | Filters Placements by panel IDs (list) |
type | Filters Placements by Placement Type IDs (list) |
create
Creates Placement.
Example request:
{ "machine": 126375846344, "qr_code": "QR code for Placement #8", "type": 126375846344, "panel_id": 9, "custom_name": null, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "band_width_in_percents": 100, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true }
Example response:
{ "id": 126375846344, "machine": 126375846344, "type": 126375846344, "qr_code": "QR code for Placement #8", "panel_id": 9, "custom_name": null, "placement_type_name": "Placement Type #12", "channel": 126375846344, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "band_width_in_percents": 100, "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "placement_bearing_band": [], "audio_chunk_type": "audio", "recording_plan": null, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true, "alerting_config_including_generated": { "rules": [] } }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
machine required | Machine of the Placement (not null) |
type required | Type of the Placement (not null) |
qr_code | QR code of the Placement (null, blank) |
panel_id | ID of Grafana panel for the Placement (null) |
custom_name | Custom name of the Placement (null, blank) |
is_enabled | Whether the Placement is enabled (not null) |
running_threshold | Running threshold for ML model (not null) |
sensor_type | Sensor Type of sensor attached to the Placement (null) |
sensor_cable_length | Length of the cable of sensor attached to the Placement in meters (null) |
iso_group | ISO Group (null) |
rpm | Revolutions per minute (null) |
is_rpm_automatically_detected | Whether the RPM is automatically detected |
band_alerting | Whether the bands alerting is activated for this Placement (not null, must be one of off, show, alert) |
band_width_in_percents | Band width in percents) |
coefficients | Coefficients for frequency (not null) |
audio_chunk_type | Type of Audio Chunk (audio, electric_current, ...) this Placement contains (not null, not blank) |
recording_plan | Device Recording Plan of the Placement |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
envelope_sad | Whether to train Envelope SAD model |
alerting_config | Alerting configuration (null, blank) |
is_used_for_machine_running_prediction | Whether the Placement is used for Machine running prediction |
read
Returns Placement by ID.
Example response:
{ "id": 126375846344, "machine": 126375846344, "type": 126375846344, "qr_code": "QR code for Placement #8", "panel_id": 9, "custom_name": null, "placement_type_name": "Placement Type #12", "channel": 126375846344, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "band_width_in_percents": 100, "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "placement_bearing_band": [], "audio_chunk_type": "audio", "recording_plan": null, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true, "alerting_config_including_generated": { "rules": [] } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Placement.
Example request:
{ "machine": 126375846344, "qr_code": "QR code for Placement #8", "type": 126375846344, "panel_id": 9, "custom_name": null, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "band_width_in_percents": 100, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true }
Example response:
{ "id": 126375846344, "machine": 126375846344, "type": 126375846344, "qr_code": "QR code for Placement #8", "panel_id": 9, "custom_name": null, "placement_type_name": "Placement Type #12", "channel": 126375846344, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "band_width_in_percents": 100, "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "placement_bearing_band": [], "audio_chunk_type": "audio", "recording_plan": null, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true, "alerting_config_including_generated": { "rules": [] } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type required | Type of the Placement (not null) |
qr_code | QR code of the Placement (null, blank) |
panel_id | ID of Grafana panel for the Placement (null) |
custom_name | Custom name of the Placement (null, blank) |
is_enabled | Whether the Placement is enabled (not null) |
running_threshold | Running threshold for ML model (not null) |
sensor_type | Sensor Type of sensor attached to the Placement (null) |
sensor_cable_length | Length of the cable of sensor attached to the Placement in meters (null) |
iso_group | ISO Group (null) |
rpm | Revolutions per minute (null) |
is_rpm_automatically_detected | Whether the RPM is automatically detected |
band_alerting | Whether the bands alerting is activated for this Placement (not null, must be one of off, show, alert) |
band_width_in_percents | Band width in percents) |
coefficients | Coefficients for frequency (not null) |
audio_chunk_type | Type of Audio Chunk (audio, electric_current, ...) this Placement contains (not null, not blank) |
recording_plan | Device Recording Plan of the Placement |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
envelope_sad | Whether to train Envelope SAD model |
alerting_config | Alerting configuration (null, blank) |
is_used_for_machine_running_prediction | Whether the Placement is used for Machine running prediction |
partial_update
Partially updates Placement.
Example request:
{ "machine": 126375846344, "qr_code": "QR code for Placement #8", "type": 126375846344, "panel_id": 9, "custom_name": null, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "band_width_in_percents": 100, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true }
Example response:
{ "id": 126375846344, "machine": 126375846344, "type": 126375846344, "qr_code": "QR code for Placement #8", "panel_id": 9, "custom_name": null, "placement_type_name": "Placement Type #12", "channel": 126375846344, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "band_width_in_percents": 100, "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "placement_bearing_band": [], "audio_chunk_type": "audio", "recording_plan": null, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true, "alerting_config_including_generated": { "rules": [] } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type | Type of the Placement (not null) |
qr_code | QR code of the Placement (null, blank) |
panel_id | ID of Grafana panel for the Placement (null) |
custom_name | Custom name of the Placement (null, blank) |
is_enabled | Whether the Placement is enabled (not null) |
running_threshold | Running threshold for ML model (not null) |
sensor_type | Sensor Type of sensor attached to the Placement (null) |
sensor_cable_length | Length of the cable of sensor attached to the Placement in meters (null) |
iso_group | ISO Group (null) |
rpm | Revolutions per minute (null) |
is_rpm_automatically_detected | Whether the RPM is automatically detected |
band_alerting | Whether the bands alerting is activated for this Placement (not null, must be one of off, show, alert) |
band_width_in_percents | Band width in percents) |
coefficients | Coefficients for frequency (not null) |
audio_chunk_type | Type of Audio Chunk (audio, electric_current, ...) this Placement contains (not null, not blank) |
recording_plan | Device Recording Plan of the Placement |
suppress_notifications_until | Timestamp until the Alert notifications are snoozed (null) |
envelope_sad | Whether to train Envelope SAD model |
alerting_config | Alerting configuration (null, blank) |
is_used_for_machine_running_prediction | Whether the Placement is used for Machine running prediction |
delete
Deletes Placement.
Example response:
{ "id": 126375846344, "machine": 126375846344, "type": 126375846344, "qr_code": "QR code for Placement #8", "panel_id": 9, "custom_name": null, "placement_type_name": "Placement Type #12", "channel": 126375846344, "is_enabled": true, "running_threshold": 0.8, "sensor_type": 126375846344, "sensor_cable_length": "9.25", "iso_group": null, "rpm": "2048.000", "is_rpm_automatically_detected": false, "band_alerting": "off", "band_width_in_percents": 100, "coefficients": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], "placement_bearing_band": [], "audio_chunk_type": "audio", "recording_plan": null, "suppress_notifications_until": null, "envelope_sad": true, "alerting_config": null, "is_used_for_machine_running_prediction": true, "alerting_config_including_generated": { "rules": [] } }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Placement. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
project_dashboards
list
Lists Project Dashboards.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
grafana_uid | Filters Dashboard by Grafana UIDs (list) |
id | Filters entities by IDs (list) |
not_grafana_uid | Filters Dashboard by Grafana UIDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_project | Filters Project Dashboard by Project IDs (list) (inverse) |
not_type | Filters Dashboard by Project Dashboard Type (codename; list) (inverse) |
project | Filters Project Dashboard by Project IDs (list) |
type | Filters Dashboard by Project Dashboard Type (codename; list) |
create
Creates Project Dashboard.
Example request:
{ "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Example response:
{ "id": 126375846344, "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
project required | Project of this Project Dashboard |
type required | Project Dashboard Type of this Project Dashboard |
grafana_id required | Grafana Dashboard ID |
grafana_uid required | Grafana Dashboard UID |
read
Returns Project Dashboard by ID.
Example response:
{ "id": 126375846344, "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Dashboard. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Project Dashboard.
Example request:
{ "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Example response:
{ "id": 126375846344, "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Dashboard. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
grafana_id required | Grafana Dashboard ID |
grafana_uid required | Grafana Dashboard UID |
partial_update
Partially updates Project Dashboard.
Example request:
{ "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Example response:
{ "id": 126375846344, "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Dashboard. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
grafana_id | Grafana Dashboard ID |
grafana_uid | Grafana Dashboard UID |
delete
Deletes Project Dashboard.
Example response:
{ "id": 126375846344, "project": 126375846344, "type": "project_dashboard_type_1", "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Dashboard. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
project_types
list
Lists Project Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "name": "TestProjectType67", "description": "Description for Project Type 67" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Project Type.
Example request:
{ "name": "TestProjectType67" }
Example response:
{ "id": 126375846344, "name": "TestProjectType67", "description": "Description for Project Type 67" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Project Type (not null, not blank) |
description | Description of the Project Type (null, blank) |
read
Returns Project Type by ID.
Example response:
{ "id": 126375846344, "name": "TestProjectType67", "description": "Description for Project Type 67" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Project Type.
Example request:
{ "name": "TestProjectType67" }
Example response:
{ "id": 126375846344, "name": "TestProjectType67", "description": "Description for Project Type 67" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Project Type (not null, not blank) |
description | Description of the Project Type (null, blank) |
partial_update
Partially updates Project Type.
Example request:
{ "name": "TestProjectType67" }
Example response:
{ "id": 126375846344, "name": "TestProjectType67", "description": "Description for Project Type 67" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Project Type (not null, not blank) |
description | Description of the Project Type (null, blank) |
delete
Deletes Project Type.
Example response:
{ "id": 126375846344, "name": "TestProjectType67", "description": "Description for Project Type 67" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
projects
list
Lists Projects.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "project_name": "Project #67", "name": "Project #67", "created_at": null, "description": "Description for Project #67", "type": 126375846344, "facilities": [], "bucket": "bucket67", "company": null, "users": [], "org_id": 70, "is_archived": false, "user_ro": null, "user_rw": null, "service_subject": null, "is_temporary_access_token_auth_enabled": false } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
bucket | Filters Projects by bucket names (list) |
company | Filters Projects by Company IDs (list) |
id | Filters entities by IDs (list) |
is_archived | Filters Projects by is_archived (single value) |
not_bucket | Filters Projects by bucket names (list) (inverse) |
not_company | Filters Projects by Company IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_is_archived | Filters Projects by is_archived (single value) (inverse) |
not_q | Filters Projects by search in name (single value) (inverse) |
not_type | Filters Projects by Project Type IDs (list) (inverse) |
not_user | Filters Projects by User IDs (list) (inverse) |
q | Filters Projects by search in name (single value) |
type | Filters Projects by Project Type IDs (list) |
user | Filters Projects by User IDs (list) |
create
Creates Project.
Example request:
{ "name": "Project #67", "description": "Description for Project #67", "bucket": "bucket67", "is_archived": false, "service_subject": null }
Example response:
{ "name": "Project #67", "description": "Description for Project #67", "bucket": "bucket67", "is_archived": false, "service_subject": null, "user_ro": null, "user_rw": null, "is_temporary_access_token_auth_enabled": false }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Project (not null, not blank, unique) |
description | Description of the Project (null, blank) |
type | Project Type of the Project (null) |
bucket | GStorage bucket for the Project (not null, not blank, unique) |
company required | Company of the Projects (not null) |
users | Users of the Project |
org_id | ID of Grafana organization for the Project (null) |
is_archived | Whether the Project is archived |
service_subject | Subject of service provided |
is_temporary_access_token_auth_enabled | Whether the creation and authentication via Temporary Access Tokens is allowed for this Project |
read
Returns Project by ID.
Example response:
{ "id": 126375846344, "project_name": "Project #67", "name": "Project #67", "created_at": null, "description": "Description for Project #67", "type": 126375846344, "facilities": [], "bucket": "bucket67", "company": null, "users": [], "org_id": 70, "is_archived": false, "user_ro": null, "user_rw": null, "service_subject": null, "is_temporary_access_token_auth_enabled": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Project.
Example request:
{ "name": "Project #67", "description": "Description for Project #67", "bucket": "bucket67", "is_archived": false, "service_subject": null }
Example response:
{ "name": "Project #67", "description": "Description for Project #67", "bucket": "bucket67", "is_archived": false, "service_subject": null, "user_ro": null, "user_rw": null, "is_temporary_access_token_auth_enabled": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Name of the Project (not null, not blank, unique) |
description | Description of the Project (null, blank) |
type | Project Type of the Project (null) |
bucket | GStorage bucket for the Project (not null, not blank, unique) |
users | Users of the Project |
org_id | ID of Grafana organization for the Project (null) |
is_archived | Whether the Project is archived |
service_subject | Subject of service provided |
is_temporary_access_token_auth_enabled | Whether the creation and authentication via Temporary Access Tokens is allowed for this Project |
partial_update
Partially updates Project.
Example request:
{ "name": "Project #67", "description": "Description for Project #67", "bucket": "bucket67", "is_archived": false, "service_subject": null }
Example response:
{ "name": "Project #67", "description": "Description for Project #67", "bucket": "bucket67", "is_archived": false, "service_subject": null, "user_ro": null, "user_rw": null, "is_temporary_access_token_auth_enabled": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Name of the Project (not null, not blank, unique) |
description | Description of the Project (null, blank) |
type | Project Type of the Project (null) |
bucket | GStorage bucket for the Project (not null, not blank, unique) |
users | Users of the Project |
org_id | ID of Grafana organization for the Project (null) |
is_archived | Whether the Project is archived |
service_subject | Subject of service provided |
is_temporary_access_token_auth_enabled | Whether the creation and authentication via Temporary Access Tokens is allowed for this Project |
dashboards
Lists Dashboards for specified Project.
Example response:
{ "id": 126375846344, "machine": 126375846344, "model_type": null, "model_environment": null, "grafana_id": 0, "grafana_uid": "abcdefgh0000" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
facilities
Lists Facilities for specified Project.
Example response:
{ "id": 106, "name": "Mondi", "project": 77, "description": "Mondi", "address": "Czech Republic", "tags": [], "machines": [ 571 ], "stations": [ 195 ] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
machines
Lists Machines for specified Project.
Example response:
{ "id": 577, "name": "Portable demo engine", "subcategory": 2, "station": 199, "description": "Portable demo engine", "qr_code": null, "record_length": 15, "recording_period": 3, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": null, "recording_ranges": [], "recording_gate_level": null, "facility": 110, "project": 93, "company": 60, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": true, "suppress_notifications_until": null, "is_generating_dashboards": true }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
monthly_reports
Lists Monthly Reports for specified Project.
Example response:
[ { "id": 21, "created_at": "2023-09-12T14:46:23.307924Z", "project": 15604, "company_logo": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCACWAMgDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDyS+kBulgjyUjICFTj61q6O0VnfRXEzsEDBm45OO1UmSCY+YCBKBxsPC/hVjTdOudW1JLVFaVQRkgY2+tZpvRIw6Hs9hqMV/apcwM/lN0LKR/OrPmE8+Z+FZuk6M+j6eLZbh5h1O7oPpVoRv6AfWu6KutTJku8djTGkC8n5h6VA+9fQDPY1IShT0GO9Xyk8w/zQ33F5+lNDYB3H9KgLAD5WIP0qF5JGHLEVSgJzsTyIrcq+PfFRpChJDEsw75qBJCp5JI9DTW5YkZ/OrUHsZua7E6/KTkALnvViGYwSl8goR+VUzvCAHIxTNvOQ2KHC+4KdtjRk1EKflyQakiuhMuQ2Mdc1QiPkHcdpPbvUj3Lk4CKM+gqHTXRFqo+poqdsgKEFCPmU1Ilokjls4HpWbFeMvysKnF+emcVlKEuhopxZbltlClA459ankgtjEAqZfGODis2S7/dsH+b0xVeO8lzwxIoUJNA5xTLs1s8a5XP0qpJKysY2ByKm+3yfdIP1qvI7ysWBHPWrhF394mcl0IJ7iG0tZbqXiONSzbuhArxK7Zbq5nuUhEcbyk8HhMnt+deq+Lo4/8AhHJ1mDkEgAx4JU9jyRmvJG81kPylVyMnrWWJbukXQWlzSEMzW8sbwbyrfKV7n/8AVTzaojFHI4j3BDwQ55xVa0aRC2922AbsZPPFLp8L3k8kjvtwMAE469PrXHsmalsXctzbeR5ILKMrkcqT6UUXkjNZ2/kkBkkKvtOSx/lRUpdUNFPaLaTzd7NJtwoY5OPSu68ExWck63cV2yXbKfMgV+GHqRXnsrCLyxKgK5JHPOPr2rofAs3neJ4Qd4UZIUAn8yOn41rT0kmTJO1z14TsD1q1DNbn/Xfe/SqhAJ6Cm+WO1drimYqTRoSQ2kgyhIPqDWZd2pifjJU8g0pBU/KTT/Mdl2tyPenBSi9xScZIpMrA85+hqaMBhgp+IqR1ZyCe1KFJPHJ+taOV0Qo2Y024bsB+FOFugPGMjvSSTrArGQ4VfvNgkD6mpuoBHTHBFZ899EzTktq0NMKHrk+1N8iMHIXFSAOzYUZPYDvTHWVTh1KkdiKLvuGnYiaJVPK8etNwmSTkjtiuavPH2kW+oNZl5H2tsaZFygPf64ro4wJYw6NlWAII7inGSfUlproI8a9QRj601V28jB/GpvJOc4ppgOen5VV13JafYjZi3ykAfSgBQw+UUvkH6U5bfPGeaLoVpdhBlvlT8qljiAGR26iuYvPFttFevYadbT390vH7pcjI647nFQafqMty5a3d0hzuuFk+VlbpjFZurG9ky1Sla7R0mvaeNS8P3cTQxOyxl4y52hWHQ5HSvDYwWZkIYsA2QPWvaYdVaWSO2tszRvIUIPTb6mvKdYt7ZfEt3aae/mwmQjKDaFOeR9B0zXPWd9Ten2KW+WBDkkOVAHHbtV8Q3Ud4y+V5KxoB5bnOeOo+p5/Gq19p9xZeXcBHZCOXIypP8qnurm/a4Fzcz+ZNNCrbl6BOgHH0rDeLsaNEluqvbgyQ5G7Py9SelFRopWEMHZ885BORn/P6UVlZvYmxmxwB5dspKJnqB+HAr1TwBpkFrpsl0Io2mkbHnI2cr6Y7V51YWtxfTohcmSRti7x6/pXsPh7Sv7I00W7S7nLZJ3HH0Ga6KLvMU72NTj0rP103A0mRba4+zSuyoJtm7ywTycVqAYrN1bVdPsoGiubyOKRuFGckHscDtmumV2ny7kRtdXMLRl1TTNWgs7zV11K3uFPJiZWjbG4csOQQK60Ko7Vx+nX09rdte6s9lBaQhgjRz+YZGbGWXvjj9a6u2uYLuFZreZJY26MhyKyw8pOHvG2IjBT93YnAHpzXjcdn4ksb4a1GJAGnLEq2eC3ORnp2r0HXfGWn6BfR2k8cs0rAM4jx8in1z39q4uGO6bxfJqEcgl0cXBuRMMBXXOQv1yRx60q0rNWYUY3vdHcXWoy22o3ti0rKkqiTaId2VI5GSfXI6dqq6TcG/tZUbUru0W0/dwCNVIbAHLZBzycfhXNeItalu9Tt55blIYU/5d1By656Ejkg11Nnpuv28Ul49okomYyxpbS7VX5eM+oIrirXpycovc7aLjUiozWw2412+GjWdzb24kmeQpLnKgBSQcAZPatHSdRuNRsWe6t2hk3FQpfeMdsE81e8P6ZbeKtEOnzFrHVbJlaVQeTnoR/dHXNY2o6tBaTtp+mbWWAshuGyTKc8nGf1710x/iqb2sc8tKLgt7nM6Ybaz0a40uWW1Vl3Rys1mxIOSCC+cZzjFdlp9sbHTbW13lzDEse498DGa46HwzdjUP7XlFxcRvIZQGGEZxzuOOuMZ/Cujs9aklmWO5jX5jjenGPwq8OlCUm+pniJOcYpdDSubtbK1kuJmPlxjJx1PsKxr/W9Rjt1jksPsb3eUtpGmViD/tAdDjPrWv4hspIdDuEu4fLWWIsgdtpbHPB7dK4qG+fxJo3k2+nSq0RXM7SNII3I2jGf4utLEVZKSUNgw9KDi3PdHXaauomRIbhYxHECC5XDN6Z55rVWP5sHH4Vy0V9q2mMkOpBpHGQ7ONrNg9R2rT/tZZm8u0b5ym7cRnGfb2qaTVKn7zNpU54qtaCOY0BP+EX1+9thOqXMszgDyC52Y3KQQRxz0qLUrSCyGqXcc7OZ5vNUsccnov4E5rasdBvv7cOpXb3VzkBSEXbv9j7fSpNU8NGQGcwyW43FlBGUDHsQawjNKbkds8FVlTUNLrz39CpoWhiDRBPDc3kkzMBONyBQp6gAEkHoc15/ZQra63NLOsbhJGOyYkA4Peuqt/EFppWkwaXYXVxd6sZ9u3ytkcYzgg5AJPvVjW/Ct9q+pG+Roi7Iq4VvQdc45rejRqVYtHm161OjUXQ2fEV3Z33gi4+0eX5axKbcQxlRlhlR+deW3NtJLIiNOh2xqCRx26Y9q9b8P6dqUOjpbXq20sscuD5jEoEHYAAep61neIvAGmR6fdXemCSC4WNpBHv3K+OSOeRxRSwlWEGRiMbSnNKJ51ZiSKZ4uBzke4FFQ2hDv5krlVTaT64orlle4md74Z8Nahfaf9rj1dhGx3IBIPlYHuCPatuTwjd6hffuL8s5bcqLMuF9eO1cx4f1SXSWMaWl00EocR5JOSATx8vPT1qppuszaNfS3sEFxBcPuAafK9eozRyy5tDdTSjqjS8RNqulTzJJeXkcyNwNu0Hp0I4xXH/ajcSyPK5aQtksxySa25dXudeulTUJJHj8wGZh8xEY5Jz3GKztf1rTr/VhNp2nCztI0EaKqgbsE/MQO9dWHquDs0ZOPOnJFY7V5IAzW54K1cWXiOKORyLaYmOQbsDJ6H88VgvIrxjHINdT4e0Cxv8Awbf30kBW6gn/AHU28gN04I6V1VqvLG4qdPmZg+LdN1OLV7jUrwCSC4mZY5l4U46ADqMAVnaQHfU4II4973DCFcnABbjNegXumya/aaFYSvHCqqzyOx6kHBwPp/Op7LwppGmeLbJbO5+1mJj5ihwTGcHDHHSvOWI933tzsVBuzW2hm23h270HU2k1Ax3C3PyxXCchWXqpzyOPzreja7ihIhmkVMdFkOP50/xzEH0fTkjYgtclxzyeDn+YrPtpWW3Udh14rWjNzhdmdaHJO0TO1G9m0O5GpWbTLqqnCiIndKh4YH1GPyqGNsXdsZv3aS/MdvJCk89a39ElP9oX6qG3XFpIEH0HOB261zryJNFayMwW4RfKkQkAgjkcVMqj9pyjUF7O/U7eOXTzbGFdVnVGGzBVOF/SuYKSvqYEG6VUDhFUhSwzxxnGaiSbOFz171ahVYLee+YksiGOJF6sx/w4pzlyq5MY3Zm+Kta1vWvEj2gTJ08JE8akFQ+Bnceh5yPrWbqF9rV1ajTZ5Iba2j5+zQLsUnGcnaDk9+TWTrmn3OmXtvJNcyNPexefJng8sSM+vrVUAtg7ifxoXK0mg1joWl12/Fq0AnaTBAVpGJKD0GenNdowvtPsNP1SNGjEsgVgrAsRtOf5da57TtNs7rwjrMwt1N9bMsgl3HOzgkY/Ouv151m0Xw3GCAPJJ64BwFA/nWNWd3ZdDswicX/iN2DXEmhVxbTFuDl7g9fwFE8w1G4tbSKIW5kbl2ckHAzWJYSjywpbkepzV+Qgy2T7sbbhenfII/rWFmtbv72ev9XpQjzwjqjh47ZT8QtT81IojA7AqMgE9Nw+vX8a6LwprU10siTqz4OVbtjPAp15aomt+Mr1BmeOFdp9P3YJrN8NBoAsat+74IB5I+pr2MBWcrxtoj5LMqSS53u/8zvllOQVAGaeyyzXka4zE0TZGePf9Kht3ViBgGkDv/wk1lECRGIGfHZucGurF1XSpOcdzzcHRjWrKEtjwi6la3lmjUDaWIHPbNFV9QVV1O7VBhRO4A9BuNFeZFK1z2LW0O8XRrxbQRyXRYRxMsZjO5stgE9fTNVpfCUlyUD3sm0A43pzn1PNdosGoNny7RvbdgU57TUoo2lkECRqMsWfoPwFeP8AWq3Q3VNyaSRzOk+EJraQww3pKzgxuCn3lIwR1rUuf3tmIby10li2AMW7E9+pzx2oj1SZLhHU4CsDkcGm6xp9vcFpbLVWW3mJeW2LnqeuBjIz3HSrhWlL42etHK8RRiuaG/8AWp59NtWRgmAuTwOldr4WgurvwHqtrHJ5fn3KojMOF4BY1HFY20UIiESsvbcoJrdttQVdKW3ZFWOAFI41Hf147V1Sxiqx9nFa+ZGLyieEh7WU9+35GHfabPZ6NZW02y9FrM0kkfILo2Mgc9eK2LG+jkhkj0xUS4KHzJHh8sQgKQu71PQd6hinEqkH7wODV6y0Sa6gkuIiqIrAAO+Ax9vpVujdK7POhXcU0Zev3l09vpzBWeK0t9sx7l+MsPy/WsSLXE/1Y+ZT3U81tatm0uGh3hiHKHHRh0zXGRaBd3viI6dZIHeR/kycKF65J7AV0U0oqyMZtzd2dZod5IniXTDEwPmuyMhfJwUPX8qangSyvV+1w6vD5jk7lLAMG9B9PSuk0P4cX2hb9QF1Bd3SxMESEgqCevJOTxnsOtQ6PqU+pXK2JEDzFgoLRY2DHLE9O1YVm1K8TrowTjaZlW+gpaWokvb44CcbBliR2PvQLWXULTz4Y51sYuFd0wGY5yc9813LeGdPsZH1BXa8fhnR5yRn+8AQAai8T6nDB4YluGYxopHy9256Cs3z9TOoopWirHnHimG2vfEOhW0uUxbKJX/2ev8AjXQ6p4T0U+HJhpUPm3u0MuHy3tj2rz298SXjarY6iQoNqAihRztHqe55ruL/AMWRjws0lpfPJM8fliUoEO4+nqQM80OM4qKNISpy5mzm/CJf7Zrli3SWwkb6FeK1WgvdV8EaXNbzJ/ohZJUdQWYewP0ORWR4W1axsry7W7hLm8iMHm5xsz2+hq9dZtbyPS7NHxKVlX52LCTJGQeuTVSX7y3VmUKllZkek/aTqUEN1JEIHcA7VOfwyeK9LvNCtZbCJ7KREuInVxuO4Eg9G71xV/4eutIdXvAvmgbhCybl6d67bwvE2p21vbwzwpI8IjlaOEHYQOCfXjtVVYOMlZG1OvKcGpSZ5na6/wCRqPikaq6rNOxQxIc5bO3C+2B3pIfEWkxyrIplhI4KmHOfxBqLxt8Odf8ADF1LqNwRf2UshZryFThWJ/jX+H+XvXIv8q55/OuyjL2d3Fbnm1oKppJuy2PVbTxjoMZDNesPYwvz+lXrfxBpt9eT6ha3HFpaFNkg2szM3yhR3ya8dhlZhjII9DW14ft5Z553SWSMIoGUOOc5H8s08VW56TU9jKhQjQnzxOpT4O317a+bFfxfa5GLbZCQuMnPQHJ4orWl8WaoNNis4/3bRqqedGxDsAMfr3orieKpLY3Ur7s0JfEtuPuK7++MCs2/1uS9tWhVNqMRn5uayCinqSSO5rb8LxxrqLytyiJkgjOa8i56GDxLjiISauk7mGknzkEg47CnmQcKO9N1mRZ/Elx9ljG+QhdiDGCOB+da9za6V4bS2OppJczzR72VWwqn09TWqp3Pr1msHBTad30Wr/TTuxmh232zU40kheW3UHeVBwDjjJrRi0uG58RyWKDyon+Yheccdan8M+JY9YkZY7IWWmo2xXUfeb/D3q5FaQWXiu7uYZ2kaWBQN3bk5x7HinFOEr9TwsdiZYp26dji9UdtH8TXNlGwmRQqrhcFsjP4Y6V1FpNYR2sDSahOvG8pGVTBIHGRk1yV5cNPqWo3RyDLcvhmcqMD5ewPHFQC4ihQtNdxO3YIeK9WLdlc8KVr6EHjK/t11LT47RH8ov8AvMOSz5OOp+vpXqej6FaeHrFpo4AtxNGpk3fMSo5BU98HqO9ee+HIrO+8V2txdyRm3jUlU3fecEYDD071u/EyTxMzR2mnqzaZKm4+QPmLDsT2/DrUN3nY1pvli5M7qG8gmjLOdPkI6gqYXNVtOh02zupZ4IoLeRidzbTKx+mOBXFaF4ljuJVtZmmDgDdFhSw9QFb3rqft25fnuGC9ojNgoB2YKKVjdSjLU6G3uTOZYZZRtHH76P5hn+6o/nXjPxI1GWTVho+WCWnzOCMZcjjj2GPzr0DwtfzyeI9SjiUm22plgDhWx03HmsnWfBul67qWprE0kGoq24PuJDkjIyD1HbIpe0jF6mcoOS908lgs0ubSR2jkOJAhKkEZPTjrUn9neXGdyXICtsOIuA3p1ptxbXuhXJjlAeLf8x+7hvQ+lWYdSaVRl8fvN5w+enf/AOvXTGzVzhk5RZlFfLuniG8EddwwQa9N+HenprPjC11GdtsdtajJIyPMBIA/LmuV0DwZqvie/ubqN0gg3HM0oJDH27mvQ/BenL4e1W90g36TTvEr5VcBTyOM9e1Y1KkVqt0dFOk5WbO611NL1Kc2kpWWS3wPkIyC3Y1Q0QaZo1ohgBSebBO7PygnoPT/AOtXAa3Hf6NrcCMHD3Tl4JAflkYENtJ7NxU1xrN8ZTfxK0luoXcpQhkI/hxgjr/PrTjU5km0HK1ex7FpskV7bSwzqsqSblkjYZBBPQj6GvnfXfBLab4pvoTsGnw3JCLu+Zk6qMfkK9U8B+I/Nt7n7RHIZTKWx6A9BWN40eK6vzeqPKMkmGGfRcf0rOvX5Y2i9Q9m+VyaPFdUs2tdanjSPbGz7kA9D2rrNAspLawYyxmOR2z8wwcdqv2uhjVNZN35vli2ZVGBkk9f61dvE2XkyiQthyP1rkrYlypqBM6fLBSfUqujDIA/KimsVOQaK4rmOgixghsYHPc1r6FOtvfbNvEg25HNZZJALAbwehzmremXkVnfCWXIUgg98U0jehLlqJk0Wh32n+JZtREcUsBkLGMnDAbeCPx96888Ta5JrXiKWUPKkPCCNuMYGCPbpXp+t+J9Og0uR0voTdNEVjCNuJNeNSWzedwsjyP83qea9LD66yR14mpJKyl+J6b4L1iylht7JCRLDAyvDjg88MPzrRGqWtp41ht55Qhlt9gZ+md3FcL4N0++t/FFm32dlR8qzHnIINM19ptQ8aXIiTesDhTk4AC9eahwTrNraxCrfuVfuejf8ItaPYyulwVlO5sBgwH+IrzeWUi5uIQ+0xOUJXHNbLeLNC07SJf7JtZIb+eMI/UhM9cE1xkMF/lryKN5FdiSep68mt6TlrzGdZw05TvPDerQadby2r24ZZAScjmruj+OX07WDpGozx3WmS8Ryy8tFnoCe47c1gwaVcQKlxI6styokjUcgEDkZrE8TqxubdI4drMnIA5JBrofLOFznTlCdjtfF1xozfZ7rTbtJGbKna5DxkY6MOcYNWNG0e2ngXUtSv5LDSSN0QnnJMgHpk81wWiaWt74hsor1HismcGVmJIwBnBPbOMV0HxO1yPUruy06yEf2SziJXyyCN5OPwwAKlTV1Hd9y3F25lorrQ7iHx1prEWWjQmGxTg3DLjcf9kf1NUNc1+S3+xXFneI08Mvys45dWzlWx26V5voMMj8CRsE/cB44pbrUF/tWOKWXEMDAFXBIY55/wAKUqceQI1pc++h6H49tYzoyeIIYPlddl3GoyATwG+meD9a828O6YNZ1eOBImRCQ0kijPlrnk//AFq9J8Wa9ptpodxpyTJMt1bjy44wTww46cdefwrmfAmorZ38trPDsup9qoGG0YA4H6/pWNOTjBuxtUgpTST3PSrTU9K0eW00eziYWSja0wIwX64J65PWuV1vUrN/GcCWFz5PlOE8xP4SxyR+tcr4xuNSstbvUcOFaYtuHKj0x74xXLQztGxdiCpPzc8/WlGnze8gda3u9j6F1nTW8TeG5dP3oL2Nt8cgOAkq8qwPYHp+NYuj6Zrs+lmDXntbOJHwzLICz49ewrkE8WanoU9ndzWzx2s8Kx5wf3gX+IZ79KxP7cbVdZlu7qS4klLloVMnyAem36VULqLJqSTkn9/6HuVrp6Wlmw023DHbkEtt3ntzXF+K9Yj1O5ieC2e2Cllkicch1+Un6cGu28PeILHUdFiePAcICQeoPcV5t4ljvLvxLezpdKcPhFUfLtx0Pvk1zTtyu7KrN8umxY8NEfbb0M3y7VlPsADn+VU57hZmZ1Od5J61h/btc0q+lmRQLa4j8tzEgfA/HkdTWjGY5lDI4JI6ZrCdOyUjKpJypxt0JDKpVgef+BUU1FCkgcexFFYtGBNgfgOq55po2SBgudx7nvU6QRDdISFPGMmpVcFfkKgDPUVrYZzeo6WZ7lJ/lOxMeWfX14/zxVnT9Me33TSeUWYBeB90VrKMklUDEdSvFSxqGY5AwoJOOx9K0c5cvKO7sWdGEdvqlvMWVTnB54Gah1TSre11O6mt3jkE7mRipzz6GmFRJhmGBnJwuMU4FYVYnBwBxjr+NZ7Fc/uchzb+FYZLwyAsiOdxUAHaevHtW5BYrhUVV3d16c1YAVuTnb1wD1pAz8N1X361cpykrNk36F2PwuI4F8zW7S2iRi622d4yR7dBWRrGnafdPAY2kmeAnLqdg5x079qlMbSuQW5HUDpSvAqOThuRzmr9tNR5U9Abv0MS+0q6uHjSOT9wSDIu7B/CpG0azEXkrbKFbjOMke9aeSzspI9C3apFXaQ6ct155qOeVrCM3w3o3kXkdrcMseWJMknCgdiD/Sr+s+Cow6TXio6OcLLBKMN+P+IqZdzNmQ/hUm3n5CSvXk+9aTxEpW8gVkZE+jWjqIzE5UcKSeRgYHNOGnQv5QPzMmCkhPzA/WtQPgYU9ODnjmo3YLngbcc7az55PqF+pBLpVoRw7urgl1mUYB64GPxqjN4b0rzIpEtpC6kl1EmFf0x3GK1WkDIzAYx09zj1qIhmBOQMgc96pVJJ3uPm1MnxBZalrnkvLcK/kxiNVK44H071zX9galFJmNdpHIYOK7vO1Buxu5w3T9ajLoi45OR0bqO+KuNeaVgcm3qUdBs7vRbfdcQO885J8wyOvlZ78cMT71deVxIcEFjySeaDgBWJIJGc05M7QnC4Gee59KipPnd7A5XEDkKcopA7etEVsAQyxhD1GOKfuRgFJAxz16GkDc4V2PGB7/jWVhXEIKDse9FRNkAA456jvRRyhoTTzRrIEA3vxj0pvnfMvl/KrEnb14//AF02NU3lzw23+E9qfFg/KVG4jr2ovYQK+yVdp+b0HIFTGQqy45wSx5xn1xVR8L8ydSvX6VKSRhgwOf19qLgWlAMgGTyR1p7KJMDIJzzg1WQcj5fm2jHPP60uNnV/mHA/CpbGTKOBjPHBz/jTAV3Es5OACB/n6U1TtySc5PJH50uGLgAqPoMnHai4IlWUbsjLN/ShmbzFAXHGcdcULhGBZQWIxx1qNwwTPAJB7daLgPJTaXYDpzx0NQPcZHyqSMYY4/wp6l9rDG4YqJSAm7G3PXB60xD1kEYDgEZB9/zppld2OOAMcY/lSMQ8Z2KWION3qR2pm4hwAMY6/Si4ydW2y5ctkk9uv1ok2KdxPB6/T/JqJZnkYqRhgTwelI0u3dwyjoRjrRcRHhUiKjoD0PHH+f5U4NHt+UEAnnj8aQspKSnOckFMcUzHzsE/iXPtnPPH0qrgWRJEq4bjgcdvxpWMf9zDZ4z3H+NVcJKGLHJ4O3HWmTSMTsyGjPRs8g/5NCGicsIyqk4JyDngYpkspdAGTY/b3pkiuOA53tjnGcfjUZXBBXaQWH19KaAsxYCZ2HY3U59alZVVRuHHXr/Sq5kAVh1Bzkg00yZiLv0zgnP5UCHmVgVkIwu05IOe9FQg4IYMTjt39KKrQCZcMSMkE9xUXnKroAv8PJPPX2oorJCHq7TYC425xyKdGzudobqc89s+lFFDAm8sKu/JbaMkGofOGVYjd9aKKSKZIN25xngZPX9KnX922DyecnNFFTcCWMlSoHJwep7f5NQyszLljjJI4PvRRQhtDOArDJI6HNRM+JGY5bHHJ7UUVaENT+Ik8ZwcfhSLJvKochhk8HjFFFUIUox+XdyQDu7+lBBabyWYn1b8BRRUgLGx2tzho159zz/hTCQIwAOWwOOKKKOomNLlUKKFJQ4DEc44P9aRZXWJmbayltu3FFFUhMdEwVZfLG0AE4PPTk1FEpUxuTlJOdtFFMtDokaeZgT82c59SRSG33xJk4xnAHrRRRfURBLIj27EpjYMjHp6UUUVrFDP/9k=", "service_subject": "Some service subject", "name": "Monthly report - 2023/09", "recommendations": "Some recommendations", "created_for": "2023-09-12", "link": "https://storage.googleapis.com/sw_api/test/monthly_report_attachments/monthly_report_en_US_2023-09_15604.tbMIwTDj.pdf?GoogleAccessId=api-gcs-key%40nsw-production-environment.iam.gserviceaccount.com&Expires=4849836399&Signature=haUsxQllYTJhm0ZGGtVdHPyT7VZeM5ld81lnhM0GAo2m5iMMWwvc8Q6DbCm7zIWSQds1FFxtKsyc8OHyocFnwsjJJ1kMzVhvKkNZYvcD8RuIYNGtN%2FLPvs9eDpFV6N89t8MPYlLn%2FbkZ3pxot9FwepUd%2BH91GJYvNEt6WT8yhxAJwnrMRTdnoRQAxJB7TWPVGNa663aBAqrZ03gvnyQ27Gfkp9bcDkL6JXxYhIexEJsyCmZuUE8QN6%2B1dSsoImYWJpwRgSHjIYRgYFKQsMGTtsL%2FSnCkIRsIaOwdjrppk7fuChQU90aOzzWkqtCOnp9RAJ%2BtLPMqcnH96F7WP2G7Vg%3D%3D" } ]
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
readyz
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
roles
list
Lists Roles.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "groups": [], "name": "Name of Role #0", "codename": "role0", "description": "Description of Role #0", "roles": [] } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Role.
Example request:
{ "name": "Name of Role #0", "codename": "role0", "groups": [] }
Example response:
{ "id": 126375846344, "groups": [], "name": "Name of Role #0", "codename": "role0", "description": "Description of Role #0", "roles": [] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
groups | User Groups in the Role |
name required | Role name (not null, not blank, unique) |
codename required | Role codename (not null, not blank, unique) |
description | Description of the Role (null, blank) |
roles | Roles accessible within the Role |
visible
Lists Roles that are visible for current User's Role.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
read
Returns Role by ID.
Example response:
{ "id": 126375846344, "groups": [], "name": "Name of Role #0", "codename": "role0", "description": "Description of Role #0", "roles": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Role. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Role.
Example request:
{ "name": "Name of Role #0", "codename": "role0", "groups": [] }
Example response:
{ "id": 126375846344, "groups": [], "name": "Name of Role #0", "codename": "role0", "description": "Description of Role #0", "roles": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Role. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
groups | User Groups in the Role |
name required | Role name (not null, not blank, unique) |
codename required | Role codename (not null, not blank, unique) |
description | Description of the Role (null, blank) |
roles | Roles accessible within the Role |
partial_update
Partially updates Role.
Example request:
{ "name": "Name of Role #0", "codename": "role0", "groups": [] }
Example response:
{ "id": 126375846344, "groups": [], "name": "Name of Role #0", "codename": "role0", "description": "Description of Role #0", "roles": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Role. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
groups | User Groups in the Role |
name | Role name (not null, not blank, unique) |
codename | Role codename (not null, not blank, unique) |
description | Description of the Role (null, blank) |
roles | Roles accessible within the Role |
delete
Deletes Role.
Example response:
{ "id": 126375846344, "groups": [], "name": "Name of Role #0", "codename": "role0", "description": "Description of Role #0", "roles": [] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Role. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
sensor_corrections
list
Lists Sensor Corrections.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123, "offset": 0.0 } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Sensor Correction.
Example request:
{ "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123 }
Example response:
{ "id": 126375846344, "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123, "offset": 0.0 }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
ad_converter_type required | AD Converter Type (not null, not blank) |
sensor_type required | Sensor Type (not null, not blank) |
value required | Sensor Correction value (coefficient) |
offset | Sensor Correction offset |
read
Returns Sensor Correction by ID.
Example response:
{ "id": 126375846344, "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123, "offset": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Correction. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Sensor Correction.
Example request:
{ "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123 }
Example response:
{ "id": 126375846344, "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123, "offset": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Correction. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
ad_converter_type required | AD Converter Type (not null, not blank) |
sensor_type required | Sensor Type (not null, not blank) |
value required | Sensor Correction value (coefficient) |
offset | Sensor Correction offset |
partial_update
Partially updates Sensor Correction.
Example request:
{ "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123 }
Example response:
{ "id": 126375846344, "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123, "offset": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Correction. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
ad_converter_type | AD Converter Type (not null, not blank) |
sensor_type | Sensor Type (not null, not blank) |
value | Sensor Correction value (coefficient) |
offset | Sensor Correction offset |
delete
Deletes Sensor Correction.
Example response:
{ "id": 126375846344, "ad_converter_type": "ad_converter_type1", "sensor_type": null, "value": 0.00123, "offset": 0.0 }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Correction. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
sensor_type_groups
list
Lists Sensor Type Groups.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "codename": "Sensor Type Group#0" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Sensor Type Group.
Example request:
{ "codename": "Sensor Type Group#0" }
Example response:
{ "id": 126375846344, "codename": "Sensor Type Group#0" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the Sensor Type Group (not null, not blank, unique) |
read
Returns Sensor Type Group by ID.
Example response:
{ "id": 126375846344, "codename": "Sensor Type Group#0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Type Group. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Sensor Type Group.
Example request:
{ "codename": "Sensor Type Group#0" }
Example response:
{ "id": 126375846344, "codename": "Sensor Type Group#0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Type Group. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | Codename of the Sensor Type Group (not null, not blank, unique) |
partial_update
Partially updates Sensor Type Group.
Example request:
{ "codename": "Sensor Type Group#0" }
Example response:
{ "id": 126375846344, "codename": "Sensor Type Group#0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Type Group. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | Codename of the Sensor Type Group (not null, not blank, unique) |
delete
Deletes Sensor Type Group.
Example response:
{ "id": 126375846344, "codename": "Sensor Type Group#0" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Type Group. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
sensor_types
list
Lists Sensor Types.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "audio_chunk_type": "audio_chunk_type14", "group": null, "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "processing_mode": "normal", "device_versions": [ 1, 2, 5 ] } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
id | Filters entities by IDs (list) |
not_id | Filters entities by IDs (list) (inverse) |
create
Creates Sensor Type.
Example request:
{ "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "audio_chunk_type": "audio_chunk_type14", "device_versions": [ 1, 2, 5 ] }
Example response:
{ "id": 126375846344, "audio_chunk_type": "audio_chunk_type14", "group": null, "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "processing_mode": "normal", "device_versions": [ 1, 2, 5 ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
audio_chunk_type | Type of Audio Chunk (audio, electric_current, ...) this Sensor Type records (not null, not blank) |
group | Sensor Type Group |
name required | Name of the Sensor Type (not null, not blank, unique) |
codename | Codename of the Sensor Type (null, blank, unique) |
description | Description of the Sensor Type (null, blank) |
processing_mode | Processing mode in model, must be one of normal, remove_dc_component_and_compute_rms, compute_average (not null, not blank) |
device_versions | Supported Device Versions |
read
Returns Sensor Type by ID.
Example response:
{ "id": 126375846344, "audio_chunk_type": "audio_chunk_type14", "group": null, "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "processing_mode": "normal", "device_versions": [ 1, 2, 5 ] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Sensor Type.
Example request:
{ "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "audio_chunk_type": "audio_chunk_type14", "device_versions": [ 1, 2, 5 ] }
Example response:
{ "id": 126375846344, "audio_chunk_type": "audio_chunk_type14", "group": null, "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "processing_mode": "normal", "device_versions": [ 1, 2, 5 ] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
audio_chunk_type | Type of Audio Chunk (audio, electric_current, ...) this Sensor Type records (not null, not blank) |
group | Sensor Type Group |
name required | Name of the Sensor Type (not null, not blank, unique) |
codename | Codename of the Sensor Type (null, blank, unique) |
description | Description of the Sensor Type (null, blank) |
processing_mode | Processing mode in model, must be one of normal, remove_dc_component_and_compute_rms, compute_average (not null, not blank) |
device_versions | Supported Device Versions |
partial_update
Partially updates Sensor Type.
Example request:
{ "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "audio_chunk_type": "audio_chunk_type14", "device_versions": [ 1, 2, 5 ] }
Example response:
{ "id": 126375846344, "audio_chunk_type": "audio_chunk_type14", "group": null, "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "processing_mode": "normal", "device_versions": [ 1, 2, 5 ] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
audio_chunk_type | Type of Audio Chunk (audio, electric_current, ...) this Sensor Type records (not null, not blank) |
group | Sensor Type Group |
name | Name of the Sensor Type (not null, not blank, unique) |
codename | Codename of the Sensor Type (null, blank, unique) |
description | Description of the Sensor Type (null, blank) |
processing_mode | Processing mode in model, must be one of normal, remove_dc_component_and_compute_rms, compute_average (not null, not blank) |
device_versions | Supported Device Versions |
delete
Deletes Sensor Type.
Example response:
{ "id": 126375846344, "audio_chunk_type": "audio_chunk_type14", "group": null, "name": "Sensor Type #12", "codename": "sensor_type_12", "description": "Description for Sensor Type #12", "processing_mode": "normal", "device_versions": [ 1, 2, 5 ] }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Sensor Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
stations
list
Lists Stations.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "facility": 126375846344, "environment": null, "machines": [], "name": "Station #28", "description": "Description for Station #28" } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
environment | Filters Stations by Environment IDs (list) |
facility | Filters Stations by Facility IDs (list) |
id | Filters entities by IDs (list) |
not_environment | Filters Stations by Environment IDs (list) (inverse) |
not_facility | Filters Stations by Facility IDs (list) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_project | Filters Stations by Project IDs (list) (inverse) |
project | Filters Stations by Project IDs (list) |
create
Creates Station.
Example request:
{ "description": "Description for Station #28", "facility": 126375846344 }
Example response:
{ "id": 126375846344, "facility": 126375846344, "environment": null, "machines": [], "name": "Station #28", "description": "Description for Station #28" }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
facility required | Facility of the Station (not null) |
environment | Environment of the Station (null) |
name required | Name of the Station (not null, not blank) |
description | Description of the Station (null, blank) |
read
Returns Station by ID.
Example response:
{ "id": 126375846344, "facility": 126375846344, "environment": null, "machines": [], "name": "Station #28", "description": "Description for Station #28" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Station. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Station.
Example request:
{ "description": "Description for Station #28", "facility": 126375846344 }
Example response:
{ "id": 126375846344, "facility": 126375846344, "environment": null, "machines": [], "name": "Station #28", "description": "Description for Station #28" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Station. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
environment | Environment of the Station (null) |
name required | Name of the Station (not null, not blank) |
description | Description of the Station (null, blank) |
partial_update
Partially updates Station.
Example request:
{ "description": "Description for Station #28", "facility": 126375846344 }
Example response:
{ "id": 126375846344, "facility": 126375846344, "environment": null, "machines": [], "name": "Station #28", "description": "Description for Station #28" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Station. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
environment | Environment of the Station (null) |
name | Name of the Station (not null, not blank) |
description | Description of the Station (null, blank) |
delete
Deletes Station.
Example response:
{ "id": 126375846344, "facility": 126375846344, "environment": null, "machines": [], "name": "Station #28", "description": "Description for Station #28" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Station. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
machines
Lists Machines for specified Station.
Example response:
{ "id": 756, "name": "jmeno bez", "subcategory": 2, "station": 1, "description": null, "qr_code": null, "record_length": 15, "recording_period": 3, "is_active": false, "devices": [], "contact_set": null, "recording_start_datetime": null, "recording_ranges": [], "recording_gate_level": null, "facility": 73, "project": 60, "company": 20, "is_sms_notifying": true, "is_email_notifying": true, "dashboards": { "anomaly": null, "loudness": null, "combined": null, "combined_pro": null }, "is_assisted_alerting": false, "is_using_edge_loudness_model": false, "is_using_edge_models": true, "suppress_notifications_until": null, "is_generating_dashboards": true }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Station. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
temporary_access_tokens
list
Lists Temporary Access Tokens.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "key": "abcdefgh0000", "user": 126375846344, "created_at": "2024-03-29T00:38:23.696581Z", "expires_at": "2043-05-29T00:38:23.696588Z", "last_access": null, "project": null, "machines": [ 126375846344, 126375846345 ], "is_deleted": false, "created_by_user": null, "modified_by_user": null } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
from | Filters Temporary Access Tokens by expires_at from (single value) |
id | Filters entities by IDs (list) |
is_deleted | Filters Temporary Access Tokens by deleted status (single value) |
is_expired | Filters Temporary Access Tokens by expired status (single value) |
is_read_only | Filters Temporary Access Tokens by read_only (true) / read_write (false; single value) |
is_read_write | Filters Temporary Access Tokens by read_write (true) / read_only (false; single value) |
not_from | Filters Temporary Access Tokens by expires_at from (single value) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_is_deleted | Filters Temporary Access Tokens by deleted status (single value) (inverse) |
not_is_expired | Filters Temporary Access Tokens by expired status (single value) (inverse) |
not_is_read_only | Filters Temporary Access Tokens by read_only (true) / read_write (false; single value) (inverse) |
not_is_read_write | Filters Temporary Access Tokens by read_write (true) / read_only (false; single value) (inverse) |
not_project | Filters Temporary Access Tokens by Project IDs (list) (inverse) |
not_to | Filters Temporary Access Tokens by expires_at to (single value) (inverse) |
not_user | Filters Temporary Access Tokens by User IDs (list) (inverse) |
project | Filters Temporary Access Tokens by Project IDs (list) |
to | Filters Temporary Access Tokens by expires_at to (single value) |
user | Filters Temporary Access Tokens by User IDs (list) |
create
Creates Temporary Access Token.
Example request:
{ "user": 126375846344, "expires_at": "2043-05-29T00:38:23.696588Z", "machines": [ 126375846344, 126375846345 ] }
Example response:
{ "user": 126375846344, "expires_at": "2043-05-29T00:38:23.696588Z", "machines": [ 126375846344, 126375846345 ], "key": "abcdefgh0000", "project": null, "created_at": "2024-03-29T00:38:23.696581Z", "last_access": null }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user required | User impersonated by this Token |
expires_at required | Timestamp of Temporary Access Token expiration |
machines | Machines of the Temporary Access Token |
read
Returns Temporary Access Tokens by ID.
Example response:
{ "id": 126375846344, "key": "abcdefgh0000", "user": 126375846344, "created_at": "2024-03-29T00:38:23.696581Z", "expires_at": "2043-05-29T00:38:23.696588Z", "last_access": null, "project": null, "machines": [ 126375846344, 126375846345 ], "is_deleted": false, "created_by_user": null, "modified_by_user": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Temporary Access Token. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates Temporary Access Token.
Example request:
{ "expires_at": "2043-05-29T00:38:23.696588Z", "machines": [ 126375846344, 126375846345 ] }
Example response:
{ "user": 126375846344, "expires_at": "2043-05-29T00:38:23.696588Z", "machines": [ 126375846344, 126375846345 ], "key": "abcdefgh0000", "project": null, "created_at": "2024-03-29T00:38:23.696581Z", "last_access": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Temporary Access Token. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user required | User impersonated by this Token |
expires_at required | Timestamp of Temporary Access Token expiration |
machines | Machines of the Temporary Access Token |
partial_update
Partially updates Temporary Access Token.
Example request:
{ "expires_at": "2043-05-29T00:38:23.696588Z", "machines": [ 126375846344, 126375846345 ] }
Example response:
{ "user": 126375846344, "expires_at": "2043-05-29T00:38:23.696588Z", "machines": [ 126375846344, 126375846345 ], "key": "abcdefgh0000", "project": null, "created_at": "2024-03-29T00:38:23.696581Z", "last_access": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Temporary Access Token. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user | User impersonated by this Token |
expires_at | Timestamp of Temporary Access Token expiration |
machines | Machines of the Temporary Access Token |
delete
Deletes Temporary Access Token.
Example response:
{ "id": 126375846344, "key": "abcdefgh0000", "user": 126375846344, "created_at": "2024-03-29T00:38:23.696581Z", "expires_at": "2043-05-29T00:38:23.696588Z", "last_access": null, "project": null, "machines": [ 126375846344, 126375846345 ], "is_deleted": false, "created_by_user": null, "modified_by_user": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Temporary Access Token. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
users
list
Lists Users.
Example response:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 126375846344, "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "date_joined": "2024-03-29T01:02:18.278450Z", "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "facilities": [], "invitation_status": "active", "role": null, "status": "active", "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR", "is_internal": false } ] }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
ps | Number of results to return per page. |
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
all | Filter Users by is_active (single value) |
company | Filters Users by Companies (list) |
email | Filters Users by e-mails (list) |
from | Filters Users by creation date (from; single value) |
id | Filters entities by IDs (list) |
is_active | Filters Users by is_active (single value) |
is_internal | Filters Users by is_internal (single value) |
not_all | Filter Users by is_active (single value) (inverse) |
not_company | Filters Users by Companies (list) (inverse) |
not_email | Filters Users by e-mails (list) (inverse) |
not_from | Filters Users by creation date (from; single value) (inverse) |
not_id | Filters entities by IDs (list) (inverse) |
not_is_active | Filters Users by is_active (single value) (inverse) |
not_is_internal | Filters Users by is_internal (single value) (inverse) |
not_order_by_assigned_company | Helper parameter for ordering by whether it's assigned to given Company; use 'assigned_company' in order_by (single value) (inverse) |
not_order_by_assigned_project | Helper parameter for ordering by whether it's assigned to given Project; use 'assigned_project' in order_by (single value) (inverse) |
not_project | Filters Users by Projects (list) (inverse) |
not_q | Filters Users by search in firstname/lastname/username/email (single value) (inverse) |
not_role | Filters Users by Role (list) (inverse) |
not_status | Filters Users by status active/inactive/invited/expired (list) (inverse) |
not_to | Filters Users by creation date (to; single value) (inverse) |
order_by_assigned_company | Helper parameter for ordering by whether it's assigned to given Company; use 'assigned_company' in order_by (single value) |
order_by_assigned_project | Helper parameter for ordering by whether it's assigned to given Project; use 'assigned_project' in order_by (single value) |
project | Filters Users by Projects (list) |
q | Filters Users by search in firstname/lastname/username/email (single value) |
role | Filters Users by Role (list) |
status | Filters Users by status active/inactive/invited/expired (list) |
to | Filters Users by creation date (to; single value) |
create
Creates User.
Example request:
{ "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR" }
Example response:
{ "id": 126375846344, "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "date_joined": "2024-03-29T01:02:18.278450Z", "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "facilities": [], "invitation_status": "active", "role": null, "status": "active", "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR", "is_internal": false }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
last_login | A datetime of the User’s last login |
is_superuser | Designates that this User has all Permissions without explicitly assigning them. |
username required | Username of the User (not null, not blank, unique) |
first_name | First name of the User (null, not blank) |
last_name | Last name of the User (null, not blank) |
email required | Email address of the User (not null, not blank, unique) |
phone | Phone number of the User (null, blank) |
note | Note for the User (null, blank) |
is_active | Whether the User is active |
is_admin | Whether the User is an admin |
is_staff | Whether the User is member of the staff |
companies | Users of the Company |
projects | Users of the Project |
facilities | Users to send notifications to |
role | Role of the User |
is_email_notified | If User should be notified about Alerts via email |
is_phone_notified | If User should be notified about Alerts via SMS |
language | User's preferred Language |
is_alert_assistant | Whether this User receives notifications about Alerts creation |
display_currency | Displayed currency of estimated prevented damage (for alerts) |
read
Returns User by ID.
Example response:
{ "id": 126375846344, "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "date_joined": "2024-03-29T01:02:18.278450Z", "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "facilities": [], "invitation_status": "active", "role": null, "status": "active", "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR", "is_internal": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this User. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
update
Updates User.
Example request:
{ "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR" }
Example response:
{ "id": 126375846344, "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "date_joined": "2024-03-29T01:02:18.278450Z", "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "facilities": [], "invitation_status": "active", "role": null, "status": "active", "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR", "is_internal": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this User. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
last_login | A datetime of the User’s last login |
is_superuser | Designates that this User has all Permissions without explicitly assigning them. |
username required | Username of the User (not null, not blank, unique) |
first_name | First name of the User (null, not blank) |
last_name | Last name of the User (null, not blank) |
email required | Email address of the User (not null, not blank, unique) |
phone | Phone number of the User (null, blank) |
note | Note for the User (null, blank) |
is_active | Whether the User is active |
is_admin | Whether the User is an admin |
is_staff | Whether the User is member of the staff |
companies | Users of the Company |
projects | Users of the Project |
facilities | Users to send notifications to |
role | Role of the User |
is_email_notified | If User should be notified about Alerts via email |
is_phone_notified | If User should be notified about Alerts via SMS |
language | User's preferred Language |
is_alert_assistant | Whether this User receives notifications about Alerts creation |
display_currency | Displayed currency of estimated prevented damage (for alerts) |
partial_update
Partially updates User.
Example request:
{ "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR" }
Example response:
{ "id": 126375846344, "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "date_joined": "2024-03-29T01:02:18.278450Z", "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "facilities": [], "invitation_status": "active", "role": null, "status": "active", "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR", "is_internal": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this User. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
last_login | A datetime of the User’s last login |
is_superuser | Designates that this User has all Permissions without explicitly assigning them. |
username | Username of the User (not null, not blank, unique) |
first_name | First name of the User (null, not blank) |
last_name | Last name of the User (null, not blank) |
email | Email address of the User (not null, not blank, unique) |
phone | Phone number of the User (null, blank) |
note | Note for the User (null, blank) |
is_active | Whether the User is active |
is_admin | Whether the User is an admin |
is_staff | Whether the User is member of the staff |
companies | Users of the Company |
projects | Users of the Project |
facilities | Users to send notifications to |
role | Role of the User |
is_email_notified | If User should be notified about Alerts via email |
is_phone_notified | If User should be notified about Alerts via SMS |
language | User's preferred Language |
is_alert_assistant | Whether this User receives notifications about Alerts creation |
display_currency | Displayed currency of estimated prevented damage (for alerts) |
delete
Deletes User.
Example response:
{ "id": 126375846344, "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "date_joined": "2024-03-29T01:02:18.278450Z", "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "facilities": [], "invitation_status": "active", "role": null, "status": "active", "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR", "is_internal": false }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this User. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
projects
Lists Projects for specified User.
Example response:
{ "id": 681, "project_name": "TQWTQWDHff", "name": "TQWTQWDHff", "created_at": "2020-09-01T13:36:56.325253Z", "description": null, "type": null, "facilities": [ 2180, 2177, 2179, 2181, 2182, 2178 ], "bucket": "neuronsw-tqwtqwdh", "company": 394, "users": [ 1, 2, 19, 178, 399, 2819, 2847, 2849, 2851, 2854, 2856, 2957, 2978, 3109, 3110 ], "org_id": null }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this User. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
order_by | List of ordering fields, prefix with "-" for descending sort; usable fields are all fields returned by get including related objects (e.g. type__name); usage: order_by=name&order_by=-id&... |
tz | Time zone name in format Europe/Prague etc. |
resend_invitation
Resends invitation to the User.
Example request:
{}
Example response:
{ "status": "ok" }
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying the User. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
me > read
Endpoint for returning info for current User
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
me > partial_update
Partially updates current User.
Example request:
{ "phone": "775982068", "is_email_notified": false, "is_phone_notified": false, "language": "en_US" }
Example response:
{ "id": 126375846344, "last_login": null, "is_superuser": false, "username": "user1", "first_name": "TestUser", "last_name": "Unit the 1", "email": "user1@example.com", "phone": "775982068", "note": null, "date_joined": "2024-03-29T01:02:18.278450Z", "is_active": true, "is_admin": false, "is_staff": false, "groups": [], "permissions": [], "companies": [], "projects": [], "facilities": [], "invitation_status": "active", "role": null, "status": "active", "is_email_notified": false, "is_phone_notified": false, "language": "en_US", "is_alert_assistant": false, "display_currency": "EUR", "is_internal": false }
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
tz | Time zone name in format Europe/Prague etc. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
phone | Phone number of the User (null, blank) |
is_email_notified | If User should be notified about Alerts via email |
is_phone_notified | If User should be notified about Alerts via SMS |
language | User's preferred Language |