Overview

The CUWB Manager API is a REST API that is automatically runs as a systemd unit following the installation of the CUWB Manager package. This API configures all of the resource units required to facilitate the creation, configuration, and deletion of CUWB Configurations within the CUWB RTLS platform. This is the vessel through which the CUWB Manager’s web-based frontend requests adjustments through HTTP to the CUWB Configuration’s .cuwb saved state files.

Users have the option of creating their own control mechanisms utilizing this API by issuing the following requests over any of the host machine’s network interfaces on port 5000. The expected response formats are also provided for success, failure, and error scenarios.

Unless otherwise listed in the tables: the parameters, data body schemes, and responses are all required when using the API call.

JSON Format

This information can also be queried through the API itself via GET /api.json

Files produced:

• application/json
• text/html

Swagger API Access

Additionally, the API is available on the Host PC where the CUWB Manager Package is installed. This can be accessed by either going to localhost:5000/api or {hostpc_ipaddress}:5000/api. The swagger API access also has the ability to run api call examples in the interface.

Shared Schema

Classification Level

The classification level indicates the classification of each response. This is applied to every API response.

The following are the meanings behind each of the integer values for the classification portion of the Response Body.

Classification Level has been shortened to Level in this documentation for ease of reading. The JSON format in the Swagger Access will shorten Classification Level to Classification.

Messages

Every API response will always include a message in a string format.

Cache Manager

This section outlines the API commands that can interact with cached data. These commands can be run regardless of whether a CUWB Configuration is active.

GET

The GET API command can be used to retrieve cached data for a particular CUWB Configuration.

GET /cache-manager/{cuwb_name}

Parameters

Responses

DELETE

DELETE cached data for a Device in a CUWB Configuration

DELETE /cache-manager/{cuwb_name}/{device_key}

Parameters

Responses

DELETE cached data for a CUWB Configuration

DELETE /cache-manager/{cuwb_name}

Parameters

Responses

Calculate Maximum Tags

This section outlines API commands that can generate maximum tag calculations. These can be run regardless if whether a CUWB Configuration is active.

Data Body Schemes

Calculate Maximum Tags Parameterized Body

Calculate Maximum Tags Body

Calculate Maximum Tags via Parameters

This API command allows users to calculate the maximum number of tags allowed based on given parameters.

POST /calculate_maximum_tags

Parameters

Responses

Calculate Maximum Tags via Configured Role

This API command allows users to calculate the maximum number of tags allowed based on a given role in a CUWB Configuration.

POST /cuwbnets/{cuwb_name}/calculate_maximum_tags

Parameters

Responses

CDP Streams

This section outlines the available API commands to create, modify, or delete CDP streams in a particular CUWB Configuration.

The API allows for the use of either cdp-streams or cdp_streams within the API call

Data Body Schemes

CDP Stream Body

POST

The following API call creates a new CDP stream for a particular CUWB Configuration.

POST /cuwbnets/{cuwb_name}/cdp-streams

Parameters

Responses

GET

The GET API command can be used for individual CPD streams or for a list of all the CDP streams in a particular CUWB Configuration.

GET Individual Stream

The following API call queries if an individual CPD stream exists in a particular CUWB Configuration.

GET /cuwbnets/{cuwb_name}/cdp-streams/{id}

Parameters

Responses

GET List of All Streams

The following API call gets a list of all the CDP streams in a particular CUWB Configuration.

GET /cuwbnets/{cuwb_name}/cdp-streams

Parameters

Responses

GET List of Default Stream

The following API call gets a list of the default CDP Streams.

GET /default-cdp-streams

Responses

PATCH

The following API call can adjust a single existing CDP stream in a CUWB Configuration.

PATCH /cuwbnets/{cuwb_name}/cdp-streams/{id}

Parameters

Responses

DELETE

The following API command removes an existing CDP Stream from a particular CUWB Configuration.

DELETE /cuwbnets/{cuwb_name}/cdp-streams/{id}

Config, Anchor, and User CDP Streams cannot be removed.

Parameters

Responses

Commands

Data Body Schemas

Device Command Body

Multi-Device Command Body

Valid Actions

POST

Post a Device Action for Individual Device

This API call posts an action to a device. Must be a valid action.

POST /cuwbnets/{cuwb_name}/devices/{device_key}/action

Parameters

Responses

Post a Device Action for Multiple Devices

This API call posts an action to multiple devices. Must be a valid action.

POST /cuwbnets/{cuwb_name}/devices/action

Parameters

Responses

CUWB Configurations

This section outlines the available API commands to create, modify, or delete CUWB Configurations/CUWBNets.

Data Body Schemes

CUWB Network Body

Action Body

Valid Actions

These are the valid actions available for the CUWB Configuration Action Body:

POST

The POST API command can create a new CUWB Configuration, upload an existing CUWB Configuration, or send an action to a CUWB Configuration.

POST Create New

Create a new CUWB Configuration.

POST /cuwbnets

Parameters

Responses

POST Upload Existing

Upload an existing CUWB Configuration to the CUWB Manager.

POST /cuwbnets/upload

Parameters

Responses

Consumes

• multipart/form-data

POST an Action

POST an action to a CUWB Configuration. Must be a valid action.

POST /cuwbnets/{cuwb_name}

Parameters

Responses

GET

The GET API command can be used to query if an individual CUWB Configuration exists, get a list of all CUWB Configurations on a single Host PC, or download an existing CUWB Configuration to a local PC.

GET Individual CUWB Configuration

The following API command queries if an individual CUWB Configuration exists on a particular Host PC.

GET /cuwbnets/{cuwb_name}

Parameters

Responses

GET List of All CUWB Configurations

The following API call gets a list of all the CUWB Configurations available on a particular Host PC.

GET /cuwbnets

Responses

GET Download existing CUWB Configuration

The following API calls downloads a copy of the specified CUWB Configuration.

GET /cuwbnets/{cuwb_name}/download

Parameters

Responses

PATCH

The following API command can be used to update a CUWB Configuration.

PATCH /cuwbnets/{cuwb_name}

Parameters

Responses

DELETE

Delete a CUWB Configuration

DELETE /cuwbnets/{cuwb_name}

Parameters

Responses

Devices

Data Body Schemes

Device Body

Multiple Device Patch Body

Multiple Device Delete Body

POST

The POST method for adding a new device.

POST /cuwbnets/{cuwb_name}/devices

Parameters

Responses

GET

GET Individual Device

GET /cuwbnets/{cuwb_name}/devices/{device_key}

Parameters

Responses

GET List of All Devices

The GET method for a list of all devices.

GET /cuwbnets/{cuwb_name}/devices

Parameters

Responses

GET Unconfigured Devices by CUWBNet

GET /cuwbnets/{cuwb_name}/unconfigured_devices

Parameters

Responses

GET All Unconfigured Devices

GET /unconfigured_devices

Responses

PATCH

Patch Individual Device

The PATCH method for a single device.

PATCH /cuwbnets/{cuwb_name}/devices/{device_key}

Parameters

Responses

PATCH Multiple Devices

The PATCH method for multiple devices.

PATCH /cuwbnets/{cuwb_name}/devices

Parameters

Responses

DELETE

DELETE Single Device

The DELETE method for a single device.

DELETE /cuwbnets/{cuwb_name}/devices/{device_key}

Parameters

Responses

DELETE Multiple Devices

The DELETE method for multiple devices.

DELETE /cuwbnets/{cuwb_name}/devices

Parameters

Responses

Device Pairs

Data Body Schemes

Device Pairs Body

Pair Body

POST

The POST method for adding new device pairs.

POST /cuwbnets/{cuwb_name}/device_pairs

Parameters

Responses

GET

GET All Pairs for one Device

The GET method for getting all device pairs for one device in a CUWB Configuration.

GET /cuwbnets/{cuwb_name}/device_pairs/{serial_number}

Parameters

Responses

GET All Pairs for CUWB Configuration

The GET method for getting all device pairs.

GET /cuwbnets/{cuwb_name}/device_pairs

Parameters

Responses

DELETE

The DELETE method for deleting device pairs.

DELETE /cuwbnets/{cuwb_name}/device_pairs

Parameters

Responses

Group Images

Data Body Schemes

Group Image Patch Body

GET

The GET method for group images.

GET /cuwbnets/{cuwb_name}/group_image

Parameters

Responses

PATCH

The PATCH method for group images.

PATCH /cuwbnets/{cuwb_name}/group_image

Parameters

Responses

Interfaces

The API allows the use of either {device_key}-{interface_identifier} or {device_key}/interfaces/{interface_identifier} within the API call.

GET

GET Individual Interface

The GET method for a single interface.

GET /cuwbnets/{cuwb_name}/devices/{device_key}-{interface_identifier}

Parameters

Responses

GET All Interfaces

The GET method for a list of all interfaces.

GET /cuwbnets/{cuwb_name}/devices/{device_key}/interfaces

Parameters

Responses

DELETE

The DELETE method for a single interface.

DELETE /cuwbnets/{cuwb_name}/devices/{device_key}-{interface_identifier}

Parameters

Responses

Logs

GET

GET Log Messages

The GET method for a list of all log messages.

GET /cuwbnets/{cuwb_name}/log_messages

Parameters

Responses

GET List of Logs

The GET method for a list of the filenames of all the logs.

GET /cuwbnets/{cuwb_name}/logs

Parameters

Responses

GET Download a Log

The GET method for downloading a specific log.

GET /cuwbnets/{cuwb_name}/logs/{log_file_name}

Parameters

Responses

Magnetometer Calibration

Data Body Schemes

Magnetometer Calibration Body

POST

Create a new magnetometer calibration.

POST /cuwbnets/{cuwb_name}/devices/{device_key}/set_magnetometer_calibration

Parameters

Responses

Network Information

GET

The GET method for system network interfaces.

GET /network-info

Responses

Notifications

Data Body Schemes

Notification Patch Body

GET Notifications

GET Individual Notification

The GET method for a single notification.

GET /cuwbnets/{cuwb_name}/notifications/{identifier}

Parameters

Responses

GET All Notifications

The GET method for notifications.

GET /cuwbnets/{cuwb_name}/notifications

Parameters

Responses

GET Count of Unread Notifications

The GET method for the number of unread notifications.

GET /cuwbnets/{cuwb_name}/notifications_count

Parameters

Responses

PATCH

PATCH Individual Notification

The PATCH method to toggle a notification’s read status.

PATCH /cuwbnets/{cuwb_name}/notifications/{identifier}

Parameters

Responses

PATCH All Notifications

The PATCH method to mark all notifications as read or unread.

PATCH /cuwbnets/{cuwb_name}/notifications

Parameters

Responses

Operating Modes

Data Body Schemes

Operating Mode Patch Body

GET

The GET method for a list of all operational modes.

GET /network_modes

Responses

PATCH

The PATCH method for the operational mode.

PATCH /cuwbnets/{cuwb_name}/network_mode

Parameters

Responses

Packages

GET

The GET method for PPA packages.

GET /packages

Responses

Position Limits

The Position Limits are used to describe a Bounding Box for a CUWBNet. As a result, the term Bounding Box may be used in some of the endpoints.

Data Body Schemes

Position Limits Post Body

Position Limits Patch Body

POST

Create a new Position Limit object

POST /cuwbnets/{cuwb_name}/position_limits

Parameters

Responses

GET

GET Individual Position Limit

The GET method for a single position limit.

GET /cuwbnets/{cuwb_name}/position_limits/{id}

Parameters

Responses

GET List of All Limits

The GET method for a list of all position limits.

GET /cuwbnets/{cuwb_name}/position_limits

Parameters

Responses

PATCH

The PATCH method for a single position limit.

PATCH /cuwbnets/{cuwb_name}/position_limits/{id}

Parameters

Responses

DELETE

The DELETE method for a single position limit.

DELETE /cuwbnets/{cuwb_name}/position_limits/{id}

Parameters

Responses

RF Settings

Data Body Schemes

RF Settings Post Body

RF Settings Patch Body

POST

Create a new RF Settings object.

POST /cuwbnets/{cuwb_name}/rf_settings

Parameters

Responses

PATCH

The PATCH method for a single RF Settings.

PATCH /cuwbnets/{cuwb_name}/rf_settings/{name}

Parameters

Responses

GET

GET Single RF Setting

The GET method for a single RF Setting.

GET /cuwbnets/{cuwb_name}/rf_settings/{name}

Parameters

Responses

GET List of all RF Settings

The GET method for a list of all RF Settings.

GET /cuwbnets/{cuwb_name}/rf_settings

Parameters

Responses

DELETE

The DELETE method for a single RF Setting.

DELETE /cuwbnets/{cuwb_name}/rf_settings/{name}

Parameters

Responses

Roles

Data Body Schemes

Role Post Body

Role Patch Body

POST

The POST method for adding a new role.

POST /cuwbnets/{cuwb_name}/roles

Parameters

Responses

GET

GET Individual Role

The GET method for a single role

GET /cuwbnets/{cuwb_name}/roles/{role_id}

Parameters

Responses

GET a List of All Roles

The GET method for a list of all roles.

GET /cuwbnets/{cuwb_name}/roles

Parameters

Responses

PATCH

The PATCH method for a single role.

PATCH /cuwbnets/{cuwb_name}/roles/{role_id}

Parameters

Responses

DELETE

The DELETE method for a single role.

DELETE /cuwbnets/{cuwb_name}/roles/{role_id}

Parameters

Responses

System Settings Keys

These API calls are under the Special Settings in the Swagger UI.

The API allows the use of either /settings or /settings/{setting_class}/{setting_id} within the API call.

Data Body Schemes

Settings Body

POST

The POST method to create a new setting.

POST /cuwbnets/{cuwb_name}/settings

Parameters

Responses

GET

GET Individual Setting

The GET method for a single setting.

GET /cuwbnets/{cuwb_name}/settings/{key}

Parameters

Responses

GET a List of All Settings

The GET method for a list of all settings.

GET /cuwbnets/{cuwb_name}/settings

Parameters

Responses

PUT

The PUT method for a single setting.

PUT /cuwbnets/{cuwb_name}/settings

Parameters

Responses

PATCH

The PATCH method for a single setting.

PATCH /cuwbnets/{cuwb_name}/settings

Parameters

Responses

DELETE

The DELETE method for a single setting.

DELETE /cuwbnets/{cuwb_name}/settings/{key}

Parameters

Responses

System Settings Keys Defaults

These API commands retrieve the available system setting keys that a CUWB Configuration could use and their default values. These are not the system setting keys that have been applied to a CUWB Configuration.

The API allows for the use of either default-settings or default_settings within the API call.

GET

GET Individual setting

This API call provides the default value for a single system setting key.

GET /default-settings/{key}

Parameters

Responses

GET List of all settings

This API call provides a list of the available system settings keys that could be applied to a CUWB Configuration and their default values.

GET /default-settings

Responses

Revision