Overview
Documentation of all APIs related to Bluzone.
Version information
Version : 1.0
Contact information
Contact : HID Internet-of-Things
Contact Email : support@bluzone.io
License information
License : HID Global Corporation/ASSA ABLOY AB
License URL : https://www.hidglobal.com/internet-of-things
Terms of service : https://www.hidglobal.com/about/terms-of-use
URI scheme
Host : localhost:8080
BasePath : /portal
Tags
-
accounts : Portal Account Controller
-
assets : Asset Controller
-
beaconReadReports : Beacon Read Report Controller
-
beaconTemplates : Beacon Template Controller
-
beacons : Beacon Controller
-
blufiBulkProvisioning : Blufi Bulk Provisioning Controller
-
blufiSleepCycles : Blufi Sleep Cycle Controller
-
blufiSleepSchedules : Blufi Sleep Schedule Controller
-
blufiTemplates : Blufi Template Controller
-
blufis : Blufi Controller
-
bulkProvisioning : Bulk Beacon Provisioning Controller
-
dashboard : Dashboard Controller
-
deviceJobSchedules : Device Job Schedule Controller
-
deviceJobs : Device Job Controller
-
deviceRegistry : Device Registry Controller
-
deviceSelfie : Device Selfie Controller
-
deviceStatsReports : Device Stats Report Controller
-
deviceTemplates : Device Template Controller
-
deviceTypes : Device Type Controller
-
exportimport : Export Import Controller
-
grafana : Grafana Controller
-
history : History Controller
-
hotelLoaderJobs : Hotel Loader Job Controller
-
hoteling : Hoteling Controller
-
iBeaconConfiguration : I Beacon Configuration Controller
-
label : Label Controller
-
labelValue : Label Value Controller
-
ldapConnectors : Ldap Connector Controller
-
ldapQueries : Ldap Query Controller
-
locations : Location Controller
-
ltxReadReport : Ltx Read Report Controller
-
manufactureData : Portal Mfg Data Controller
-
mls : Mls Controller
-
mustering : Mustering Zone Controller
-
notificationSubscriptions : Notification Subscription Controller
-
panicButtonDashboard : Panic Button Dashboard Controller
-
policies : Policy Controller
-
portalCloud : Portal Cloud Controller
-
product : Product Controller
-
projects : Project Controller
-
provisioning : Beacon Provisioning Controller
-
rcm : RCM Controller
-
remoteConsumerConfig : Remote Consumer Config Controller
-
remoteStorageConfig : Remote Storage Config Controller
-
reports : Report Controller
-
tags : Tag Controller
-
teamFeatures : Team Feature Controller
-
teamInvitations : Team Invitation Controller
-
teamMembers : Team Member Controller
-
teamProducts : Team Product Controller
-
thirdPartyDevices : Third Party Device Controller
-
trays : Tray Controller
-
validations : Validation Controller
-
virtualBlufis : Virtual Blufi Controller
-
virtualDevice : Virtual Device Controller
-
webhooks : Webhook Controller
-
wifiScanReports : Wifi Scan Report Controller
-
wifiSecurityType : Wifi Security Type Controller
-
workZoneBlufi : Work Zone Blufi Controller
-
workplace : Workplace Controller
-
workplaceSelfie : Workplace Selfie Controller
-
wpoLocation : Wpo Location Controller
-
wpoZone : Zone Controller
Learn More
To learn more about how to use Bluzone REST API’s please visit Bluvision Developer Portal
Blufi
The BluFi provisioning process is tracked by a transaction. The client must be authenticated and must provide the credentials in the form of HTTP Cookie for each api request. The Provisioning process consists of the client initiating a transaction by binding the device sid64, projectId, and Blufi configuration templateId to the transaction. This is done via a convenience method in "Begin Transaction". The transaction tracks the state transitions during the provisioning process. At any point, the client can request transaction status, reset the transaction, or close the transaction. If the transaction does not complete within a specified amount of time (time TBD), the transaction state will be set to TIMEOUT and closed. Optionally, the client can provide Tags and DeviceSelfie.
Beacon
Beacon provisioning is completely handling by the Cloud. The App interaction is for registering the Beacon with the Cloud and associating it with a project. Once registered, the App may query the cloud for beacon status and update meta-data about the Beacon (name, latitude, longitude, altitude, floor number, tags, etc).
Custom Bluzone Errors
An HTTP Response status of 480 indicates that the client should parse a custom error message. The Content-Type should be "application/json", and there should be some additional headers added to the response. The Client is expected to map the "type" field to a platform specific resource bundle for i18n support. The array of args should be merged into the template value to provide a rich error messaging experience to the end user. Since some automated clients (or remote B2B systems) may not support i18n (or JSON parsing), the error code and default rendered message are placed in the response headers. It is critical that the Client inspect the http response codes for each API call.
Where Next
Please follow through the resources to learn more.
Paths
Get account
GET /papis/v1/accounts/{accountId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
accountId |
accountId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
accounts
Update Account
PUT /papis/v1/accounts/{accountId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
account |
account |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
accounts
Get all device types
GET /papis/v1/deviceTypes
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< DeviceType > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceTypes
Get device type
GET /papis/v1/deviceTypes/{code}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
code |
code |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceTypes
Get system template
GET /papis/v1/deviceTypes/{code}/template
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
code |
code |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceTypes
Get rcm data mag state aggregation csv
POST /papis/v1/history/addata/{projectId}/magstate
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
baseTemp |
baseTemp |
number (float) |
|
Query |
beaconId |
beaconId |
string |
|
Query |
details |
details |
boolean |
|
Query |
endDate |
endDate |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
raw |
raw |
boolean |
|
Query |
separator |
separator |
string |
|
Query |
showClosed |
showClosed |
boolean |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get rcm data mag state aggregation csv
GET /papis/v1/history/addata/{projectId}/magstate
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
baseTemp |
baseTemp |
number (float) |
|
Query |
beaconId |
beaconId |
string |
|
Query |
details |
details |
boolean |
|
Query |
endDate |
endDate |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
raw |
raw |
boolean |
|
Query |
separator |
separator |
string |
|
Query |
showClosed |
showClosed |
boolean |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get raw scan data csv
POST /papis/v1/history/addata/{projectId}/rawData
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
string |
|
Query |
dataType |
dataType |
string |
|
Query |
endDate |
endDate |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
rcmOnly |
rcmOnly |
boolean |
|
Query |
separator |
separator |
string |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get raw scan data csv
GET /papis/v1/history/addata/{projectId}/rawData
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
string |
|
Query |
dataType |
dataType |
string |
|
Query |
endDate |
endDate |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
rcmOnly |
rcmOnly |
boolean |
|
Query |
separator |
separator |
string |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get all aggregate history by csv
POST /papis/v1/history/metric/aggregate/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
< string > array(multi) |
|
Query |
endDate |
endDate |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
interval |
interval |
string |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
getAllAggregateMetricHistoryByBeacon
GET /papis/v1/history/metric/aggregate/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
< string > array(multi) |
|
Query |
download |
download |
boolean |
|
Query |
endDate |
endDate |
string |
|
Query |
format |
format |
enum (json) |
|
Query |
interval |
interval |
string |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconHistoryMetricGroup > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
history
Get condition cluster data csv
POST /papis/v1/history/metric/cluster/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
highRes |
highRes |
boolean |
|
Query |
policyId |
policyId |
integer (int64) |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
separator |
separator |
string |
|
Query |
xCluster |
xCluster |
integer (int32) |
|
Query |
yCluster |
yCluster |
integer (int32) |
|
Query |
zCluster |
zCluster |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get condition cluster data csv
GET /papis/v1/history/metric/cluster/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
highRes |
highRes |
boolean |
|
Query |
policyId |
policyId |
integer (int64) |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
separator |
separator |
string |
|
Query |
xCluster |
xCluster |
integer (int32) |
|
Query |
yCluster |
yCluster |
integer (int32) |
|
Query |
zCluster |
zCluster |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get condition cluster invalid data csv
POST /papis/v1/history/metric/cluster/{projectId}/invalid
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
highRes |
highRes |
boolean |
|
Query |
policyId |
policyId |
integer (int64) |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
separator |
separator |
string |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get condition cluster invalid data csv
GET /papis/v1/history/metric/cluster/{projectId}/invalid
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
string |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
highRes |
highRes |
boolean |
|
Query |
policyId |
policyId |
integer (int64) |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
separator |
separator |
string |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get last know value for Summary
GET /papis/v1/history/metric/lastKnownSummary/{projectId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
beaconIds |
beaconIds |
< string > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< string, BeaconHistoryMetricGroup > map |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
history
Get raw metric history by csv
POST /papis/v1/history/metric/raw/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
bz-page-token |
bz-page-token |
string |
|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
< string > array(multi) |
|
Query |
dataType |
dataType |
string |
|
Query |
deviceJobId |
deviceJobId |
integer (int64) |
|
Query |
endDate |
endDate |
string |
|
Query |
filters |
filters |
< string > array(multi) |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
separator |
separator |
string |
|
Query |
sessionId |
sessionId |
string |
|
Query |
startDate |
startDate |
string |
|
Query |
storageType |
storageType |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Raw Metric History Data |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Get raw metric history by csv
GET /papis/v1/history/metric/raw/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
bz-page-token |
bz-page-token |
string |
|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
< string > array(multi) |
|
Query |
dataType |
dataType |
string |
|
Query |
deviceJobId |
deviceJobId |
integer (int64) |
|
Query |
endDate |
endDate |
string |
|
Query |
filters |
filters |
< string > array(multi) |
|
Query |
format |
format |
enum (csv) |
|
Query |
header |
header |
boolean |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
separator |
separator |
string |
|
Query |
sessionId |
sessionId |
string |
|
Query |
startDate |
startDate |
string |
|
Query |
storageType |
storageType |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Raw Metric History Data |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Search aggregate metrics by beacon csv
POST /papis/v1/history/metric/{projectId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconHistoryMetricValue > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
history
Get aggregate metrics by beacon
GET /papis/v1/history/metric/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
< string > array(multi) |
|
Query |
blufiId |
blufiId |
< string > array(multi) |
|
Query |
download |
download |
boolean |
|
Query |
endDate |
endDate |
string |
|
Query |
format |
format |
enum (json) |
|
Query |
interval |
interval |
string |
|
Query |
metric |
metric |
enum (TEMP, RSSI, PER_BLUFI_RSSI, LUMS, X_ACCEL, Y_ACCEL, Z_ACCEL, X_ACCEL_HS, Y_ACCEL_HS, Z_ACCEL_HS, X_MAG, Y_MAG, Z_MAG, X_VELOCITY, Y_VELOCITY, Z_VELOCITY, MAG_STATE, BATTERY, DURESS_BTN_PRESS) |
|
Query |
provider |
provider |
enum (LEGACY, SAMPLER) |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconHistoryMetricValue > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
history
Search aggregate metrics by beacon csv
POST /papis/v1/history/metric_csv/{projectId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Accel Second Data
POST /papis/v1/history/storage/accel/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
allowAll |
allowAll |
boolean |
|
Query |
beaconId |
beaconId |
< string > array(multi) |
|
Query |
download |
download |
boolean |
|
Query |
endDate |
endDate |
string |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Accel Second Data
GET /papis/v1/history/storage/accel/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
allowAll |
allowAll |
boolean |
|
Query |
beaconId |
beaconId |
< string > array(multi) |
|
Query |
download |
download |
boolean |
|
Query |
endDate |
endDate |
string |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
history
Download Storage
GET /papis/v1/history/storage/download/{projectId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconId |
beaconId |
< string > array(multi) |
|
Query |
dataType |
dataType |
< string > array(multi) |
|
Query |
download |
download |
boolean |
|
Query |
endDate |
endDate |
string |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
history
List storage keys
GET /papis/v1/history/storage/list/{projectId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
beaconId |
beaconId |
< string > array(multi) |
Query |
dataType |
dataType |
< string > array(multi) |
Query |
endDate |
endDate |
string |
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< string > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
history
Get all manufacture data
GET /papis/v1/mfgdata
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
manufactureData
Get manufacture data by id64
GET /papis/v1/mfgdata/devices/{id64}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id64 |
id64 |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
manufactureData
Create a project
POST /papis/v1/projects
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
project |
project |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Get all the projects
GET /papis/v1/projects
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< Project > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Get panic button dashboard by current project
GET /papis/v1/projects/current/panicButtonDashboard
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
panicButtonDashboard
Get a project by its id
GET /papis/v1/projects/{projectId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Update a project
PUT /papis/v1/projects/{projectId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
project |
project |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Export complete project
POST /papis/v1/projects/{projectId}/_exports
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
*/*
Produces
-
*/*
Tags
-
exportimport
Post import Operations
POST /papis/v1/projects/{projectId}/_exports/{exportId}/_after
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
exportId |
exportId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Body |
blufiRedirect |
blufiRedirect |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
exportimport
Export status
GET /papis/v1/projects/{projectId}/_exports/{exportId}/status
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
exportId |
exportId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
exportimport
Import complete project
POST /papis/v1/projects/{projectId}/_imports
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
exportInfo |
exportInfo |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
exportimport
Import status
GET /papis/v1/projects/{projectId}/_imports
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
exportimport
Import status
GET /papis/v1/projects/{projectId}/_imports/{importId}/status
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
importId |
importId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
exportimport
Create a installer test log
POST /papis/v1/projects/{projectId}/_installerTestLog
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
dto |
dto |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Get a list installer test logs by project
GET /papis/v1/projects/{projectId}/_installerTestLog
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< InstallerTestLog > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Update project name
PUT /papis/v1/projects/{projectId}/_rename
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
projectNameObject |
projectNameObject |
< string, string > map |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Request to enable Policy features
PUT /papis/v1/projects/{projectId}/_requestPolicyFeatures
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Request to enable RTLS features
PUT /papis/v1/projects/{projectId}/_requestRTLSFeatures
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
requiresRoleAdmin
GET /papis/v1/projects/{projectId}/_requiresRoleAdmin
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
setProjectContext
PUT /papis/v1/projects/{projectId}/_set
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Get project api access
GET /papis/v1/projects/{projectId}/apiAccess
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< ApiAccess > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Create assets
POST /papis/v1/projects/{projectId}/assets
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
assets |
assets |
< Asset > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
< Asset > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
Get all assets
GET /papis/v1/projects/{projectId}/assets
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< Asset > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
Get all available beacons
GET /papis/v1/projects/{projectId}/assets/beacons/_available
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconLite > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
Get an asset
GET /papis/v1/projects/{projectId}/assets/{assetId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
update one asset
PUT /papis/v1/projects/{projectId}/assets/{assetId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Body |
asset |
asset |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
Remove an asset
DELETE /papis/v1/projects/{projectId}/assets/{assetId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
Find all beacons for a given projectId/assetId combination
GET /papis/v1/projects/{projectId}/assets/{assetId}/beacons
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconLite > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
Update beacons for an asset
PUT /papis/v1/projects/{projectId}/assets/{assetId}/beacons
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Body |
beacons |
beacons |
< BeaconLite > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconLite > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
Remove one beacon from an asset
DELETE /papis/v1/projects/{projectId}/assets/{assetId}/beacons/{beaconId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
beaconId |
beaconId |
string |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
assets
create a set of NotificationSubscription
POST /papis/v1/projects/{projectId}/assets/{assetId}/notificationSubscriptions
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Body |
notificationSubscriptions |
notificationSubscriptions |
< NotificationSubscription > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
< NotificationSubscription > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
notificationSubscriptions
Get all NotificationSubscription objects
GET /papis/v1/projects/{projectId}/assets/{assetId}/notificationSubscriptions
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< NotificationSubscription > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
notificationSubscriptions
Remove an array of NotificationSubscription objects
PUT /papis/v1/projects/{projectId}/assets/{assetId}/notificationSubscriptions/_delete
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Body |
notificationSubscriptionIds |
notificationSubscriptionIds |
< integer (int64) > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
notificationSubscriptions
Get NotificationSubscription
GET /papis/v1/projects/{projectId}/assets/{assetId}/notificationSubscriptions/{notificationSubscriptionId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
notificationSubscriptionId |
notificationSubscriptionId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
notificationSubscriptions
update one NotificationSubscription
PUT /papis/v1/projects/{projectId}/assets/{assetId}/notificationSubscriptions/{notificationSubscriptionId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
notificationSubscriptionId |
notificationSubscriptionId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Body |
notificationSubscription |
notificationSubscription |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
notificationSubscriptions
Remove NotificationSubscription
DELETE /papis/v1/projects/{projectId}/assets/{assetId}/notificationSubscriptions/{notificationSubscriptionId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
assetId |
assetId |
integer (int64) |
Path |
notificationSubscriptionId |
notificationSubscriptionId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
notificationSubscriptions
Create beacon template
POST /papis/v1/projects/{projectId}/beaconTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
template |
template |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconTemplates
Get all beacon templates by project id
GET /papis/v1/projects/{projectId}/beaconTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconTemplate > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconTemplates
Delete beacon templates by beacon template ids
PUT /papis/v1/projects/{projectId}/beaconTemplates/_delete
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
templateIds |
templateIds |
< integer (int64) > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconTemplates
Get beacon template by beacon template id
GET /papis/v1/projects/{projectId}/beaconTemplates/{templateId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
templateId |
templateId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconTemplates
Update beacon template by beacon template id
PUT /papis/v1/projects/{projectId}/beaconTemplates/{templateId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
templateId |
templateId |
integer (int64) |
Body |
template |
template |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconTemplates
Clone beacon template by beacon template id
PUT /papis/v1/projects/{projectId}/beaconTemplates/{templateId}/_clone
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
templateId |
templateId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconTemplates
Bulk provision beacons
POST /papis/v1/projects/{projectId}/beacons/_bulkProvision
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
configType |
configType |
string |
|
Query |
locationId |
locationId |
integer (int64) |
|
Query |
skipDeviceJob |
skipDeviceJob |
boolean |
|
Query |
templateId |
templateId |
integer (int64) |
|
FormData |
file |
file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< Beacon > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
multipart/form-data
Produces
-
*/*
Tags
-
bulkProvisioning
Get beacon read reports
GET /papis/v1/projects/{projectId}/beacons/{beaconId}/ltxReadReports
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
beaconId |
beaconId |
string |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< LtxReadReport > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
ltxReadReport
Create blufi template
POST /papis/v1/projects/{projectId}/blufiTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
blufiTemplate |
blufiTemplate |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Get all blufi templates
GET /papis/v1/projects/{projectId}/blufiTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BlufiTemplate > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Delete blufi templates by blufi template ids
PUT /papis/v1/projects/{projectId}/blufiTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
templateIds |
templateIds |
< integer (int64) > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Import Encrypted Blufi Template
POST /papis/v1/projects/{projectId}/blufiTemplates/_importEncrypted
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
encodedPayload |
encodedPayload |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Import Encrypted Blufi Template via form data
POST /papis/v1/projects/{projectId}/blufiTemplates/_importEncryptedFormData
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
FormData |
file |
file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
multipart/form-data
Produces
-
*/*
Tags
-
blufiTemplates
Get all blufi templates lite
GET /papis/v1/projects/{projectId}/blufiTemplates/_lite
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BlufiTemplateLite > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Get blufi template by id
GET /papis/v1/projects/{projectId}/blufiTemplates/{templateId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
templateId |
templateId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Update blufi template
PUT /papis/v1/projects/{projectId}/blufiTemplates/{templateId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
templateId |
templateId |
integer (int64) |
Body |
blufiTemplate |
blufiTemplate |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Export Encrypted Blufi Template
GET /papis/v1/projects/{projectId}/blufiTemplates/{templateId}/_exportEncrypted
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
templateId |
templateId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Get blufi template lite by id
GET /papis/v1/projects/{projectId}/blufiTemplates/{templateId}/_lite
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
templateId |
templateId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiTemplates
Bulk provision blufis
POST /papis/v1/projects/{projectId}/blufis/_bulkProvision
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
locationId |
locationId |
integer (int64) |
Query |
templateId |
templateId |
integer (int64) |
FormData |
file |
file |
file |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< Blufi > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
multipart/form-data
Produces
-
*/*
Tags
-
blufiBulkProvisioning
Provision blufi
POST /papis/v1/projects/{projectId}/blufis/_provision
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
id64Hex |
id64Hex |
string |
Query |
locationId |
locationId |
integer (int64) |
Query |
name |
name |
string |
Query |
templateId |
templateId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
blufiBulkProvisioning
Get a list installer test logs by project and blufi
GET /papis/v1/projects/{projectId}/blufis/{blufiId}/_installerTestLog
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
blufiId |
blufiId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< InstallerTestLog > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Get cloud user info
GET /papis/v1/projects/{projectId}/cloud/_user
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
portalCloud
Get project context
GET /papis/v1/projects/{projectId}/context
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
projects
Get devices by device search
POST /papis/v1/projects/{projectId}/dashboard
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
deviceSearch |
deviceSearch |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get devices view by project id
GET /papis/v1/projects/{projectId}/dashboard
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get search beacon view
GET /papis/v1/projects/{projectId}/dashboard/_search
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
value |
value |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconSearchView > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get beacon views by tag ids post
POST /papis/v1/projects/{projectId}/dashboard/beaconViews
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
tagIds |
tagIds |
< integer (int64) > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get beacon views by tag ids request
GET /papis/v1/projects/{projectId}/dashboard/beaconViews
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
includeDevices |
includeDevices |
boolean |
|
Query |
tagIds |
tagIds |
< integer (int64) > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get beacon views by tag ids request
GET /papis/v1/projects/{projectId}/dashboard/beaconViews/mobile
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
includeDevices |
includeDevices |
boolean |
|
Query |
tagIds |
tagIds |
< integer (int64) > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get beacon views by tag ids request
GET /papis/v1/projects/{projectId}/dashboard/beaconViewsLite
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
limit |
limit |
integer (int32) |
|
Query |
tagIds |
tagIds |
< integer (int64) > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get blufi views by post
POST /papis/v1/projects/{projectId}/dashboard/blufiViews
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
tagIds |
tagIds |
< integer (int64) > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get blufi views
GET /papis/v1/projects/{projectId}/dashboard/blufiViews
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get beacon ids by tag ids
GET /papis/v1/projects/{projectId}/dashboard/tags/{tagId}/beaconIds
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
tagId |
tagId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< string > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
dashboard
Get device templates
GET /papis/v1/projects/{projectId}/deviceTemplates
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< DeviceTemplate > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceTemplates
Get motion data for a specific beacon
GET /papis/v1/projects/{projectId}/devices/beacon/{beaconId}/motion
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
beaconId |
beaconId |
string |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< MotionData > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Get beacons
GET /papis/v1/projects/{projectId}/devices/beacons
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
parkingOnly |
parkingOnly |
boolean |
|
Query |
rtlsOnly |
rtlsOnly |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< Beacon > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Get Ambient Beacons by projectId
GET /papis/v1/projects/{projectId}/devices/beacons/_ambientBeacons
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< SimpleDevice > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon bulk configuration
PUT /papis/v1/projects/{projectId}/devices/beacons/_bulkConfig
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
configBeaconBulk |
configBeaconBulk |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon configuration
PUT /papis/v1/projects/{projectId}/devices/beacons/_config
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
configBeaconSingle |
configBeaconSingle |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon firmware by revision
PUT /papis/v1/projects/{projectId}/devices/beacons/_config/cmfirmware
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
config |
config |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon firmware to default
PUT /papis/v1/projects/{projectId}/devices/beacons/_config/cmfirmware/_latest
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
config |
config |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon configuration by configuration type
PUT /papis/v1/projects/{projectId}/devices/beacons/_config/configType
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
configBeaconConfigType |
configBeaconConfigType |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon configuration by template
PUT /papis/v1/projects/{projectId}/devices/beacons/_config/template
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
configBeaconTemplate |
configBeaconTemplate |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Delete beacons
PUT /papis/v1/projects/{projectId}/devices/beacons/_delete
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
beaconIds |
beaconIds |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Beacon Inventory Report
GET /papis/v1/projects/{projectId}/devices/beacons/_inventory
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
text/csv
Tags
-
beacons
Get beacon mac address views for project
GET /papis/v1/projects/{projectId}/devices/beacons/_macAddressViews
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconMacAddressView > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Get beacon map
GET /papis/v1/projects/{projectId}/devices/beacons/_map
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< string, BeaconMapItem > map |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Get beacons since sync time
GET /papis/v1/projects/{projectId}/devices/beacons/_sinceSync
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
endDate |
endDate |
string |
|
Query |
minDuration |
minDuration |
integer (int32) |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< Beacon > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Get beacons lite view
GET /papis/v1/projects/{projectId}/devices/beacons/_view
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconLite > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon condition monitoring config
PUT /papis/v1/projects/{projectId}/devices/beacons/conditionConfig
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< string > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Get default firmware revision for beacon
PUT /papis/v1/projects/{projectId}/devices/beacons/firmware/_defaultRevisions
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< BeaconFirmwareUpdate > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon firmware to default
PUT /papis/v1/projects/{projectId}/devices/beacons/firmware/config/_default
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
config |
config |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon firmware by revision
PUT /papis/v1/projects/{projectId}/devices/beacons/firmware/config/_revision
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
config |
config |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon firmware by image id
PUT /papis/v1/projects/{projectId}/devices/beacons/firmware/config/{firmwareImageId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
firmwareImageId |
firmwareImageId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Body |
config |
config |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Cancel device job bulk
POST /papis/v1/projects/{projectId}/devices/beacons/jobs/_bulkCancel
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
jobCancelBulk |
jobCancelBulk |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Create bulk device job
PUT /papis/v1/projects/{projectId}/devices/beacons/jobs/_bulkCreate
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
jobBulk |
jobBulk |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Cancel device job
POST /papis/v1/projects/{projectId}/devices/beacons/jobs/_cancel
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
jobCancel |
jobCancel |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Bulk clone device jobs
POST /papis/v1/projects/{projectId}/devices/beacons/jobs/_clone
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
deviceJobIds |
deviceJobIds |
< integer (int64) > array(multi) |
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< DeviceJobLite > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Bulk clone device jobs
GET /papis/v1/projects/{projectId}/devices/beacons/jobs/_clone
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
deviceJobIds |
deviceJobIds |
< integer (int64) > array(multi) |
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< DeviceJobLite > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Create device job
PUT /papis/v1/projects/{projectId}/devices/beacons/jobs/_create
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
job |
job |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Create device jobs by schedule
PUT /papis/v1/projects/{projectId}/devices/beacons/jobs/_create/schedules/{scheduleId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
scheduleId |
scheduleId |
integer (int64) |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< DeviceJob > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Create device jobs by template
PUT /papis/v1/projects/{projectId}/devices/beacons/jobs/_create/template
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
deviceJobTemplate |
deviceJobTemplate |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Search Device Jobs
GET /papis/v1/projects/{projectId}/devices/beacons/jobs/_search
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconIds |
beaconIds |
< string > array(multi) |
|
Query |
blufiIds |
blufiIds |
< integer (int64) > array(multi) |
|
Query |
configTypes |
configTypes |
< string > array(multi) |
|
Query |
currentStates |
currentStates |
< string > array(multi) |
|
Query |
deviceJobScheduleIds |
deviceJobScheduleIds |
< integer (int64) > array(multi) |
|
Query |
forDate |
forDate |
string |
|
Query |
fromDate |
fromDate |
string |
|
Query |
page |
page |
integer (int32) |
|
Query |
pageSize |
pageSize |
integer (int32) |
|
Query |
sortBy |
sortBy |
string |
|
Query |
sortDirection |
sortDirection |
string |
|
Query |
toDate |
toDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Search Device Jobs by PUT
PUT /papis/v1/projects/{projectId}/devices/beacons/jobs/_search
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Clone device job
POST /papis/v1/projects/{projectId}/devices/beacons/jobs/{deviceJobId}/_clone
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
deviceJobId |
deviceJobId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Clone device job
GET /papis/v1/projects/{projectId}/devices/beacons/jobs/{deviceJobId}/_clone
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
deviceJobId |
deviceJobId |
integer (int64) |
Path |
projectId |
projectId |
integer (int64) |
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
deviceJobs
Delete beacon metadata
PUT /papis/v1/projects/{projectId}/devices/beacons/metaData/_delete
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
beaconIds |
beaconIds |
< string > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Get BeaconReadReports
GET /papis/v1/projects/{projectId}/devices/beacons/reports/readdata
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
page |
page |
integer (int32) |
|
Query |
pageSize |
pageSize |
integer (int32) |
|
Query |
sortBy |
sortBy |
string |
|
Query |
sortDirection |
sortDirection |
string |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
Delete BeaconReadReport
GET /papis/v1/projects/{projectId}/devices/beacons/reports/readdata/_bulkDelete
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
from |
from |
integer (int64) |
Query |
reportIds |
reportIds |
< integer (int64) > array(multi) |
Query |
to |
to |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
Delete BeaconReadReport
DELETE /papis/v1/projects/{projectId}/devices/beacons/reports/readdata/_bulkDelete
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Query |
from |
from |
integer (int64) |
Query |
reportIds |
reportIds |
< integer (int64) > array(multi) |
Query |
to |
to |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
Run BeaconReadReports
PUT /papis/v1/projects/{projectId}/devices/beacons/reports/readdata/_run
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
Search BeaconReadReports
GET /papis/v1/projects/{projectId}/devices/beacons/reports/readdata/_search
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconIds |
beaconIds |
< string > array(multi) |
|
Query |
deviceJobIds |
deviceJobIds |
< integer (int64) > array(multi) |
|
Query |
deviceJobScheduleIds |
deviceJobScheduleIds |
< integer (int64) > array(multi) |
|
Query |
forDate |
forDate |
string |
|
Query |
fromDate |
fromDate |
string |
|
Query |
metricType |
metricType |
string |
|
Query |
page |
page |
integer (int32) |
|
Query |
pageSize |
pageSize |
integer (int32) |
|
Query |
reportType |
reportType |
string |
|
Query |
sortBy |
sortBy |
string |
|
Query |
sortDirection |
sortDirection |
string |
|
Query |
toDate |
toDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
Search BeaconReadReports by PUT
PUT /papis/v1/projects/{projectId}/devices/beacons/reports/readdata/_search
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
View BeaconReadReport
GET /papis/v1/projects/{projectId}/devices/beacons/reports/readdata/_view/{reportId}/{fileName}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
fileName |
fileName |
string |
Path |
projectId |
projectId |
integer (int64) |
Path |
reportId |
reportId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
Get BeaconReadReport
GET /papis/v1/projects/{projectId}/devices/beacons/reports/readdata/{reportId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
reportId |
reportId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
Delete BeaconReadReport
DELETE /papis/v1/projects/{projectId}/devices/beacons/reports/readdata/{reportId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
Path |
reportId |
reportId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beaconReadReports
Get beacon stats
POST /papis/v1/projects/{projectId}/devices/beacons/stats
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconIds |
beaconIds |
< string > array(multi) |
|
Query |
endDate |
endDate |
string |
|
Query |
fields |
fields |
< string > array(multi) |
|
Query |
forDate |
forDate |
string |
|
Query |
format |
format |
enum (json) |
|
Query |
isoDateTime |
isoDateTime |
boolean |
|
Query |
reportType |
reportType |
string |
|
Query |
rollupReports |
rollupReports |
boolean |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
deviceStatsReports
Get beacon stats
GET /papis/v1/projects/{projectId}/devices/beacons/stats
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
beaconIds |
beaconIds |
< string > array(multi) |
|
Query |
endDate |
endDate |
string |
|
Query |
fields |
fields |
< string > array(multi) |
|
Query |
forDate |
forDate |
string |
|
Query |
format |
format |
enum (json) |
|
Query |
isoDateTime |
isoDateTime |
boolean |
|
Query |
reportType |
reportType |
string |
|
Query |
rollupReports |
rollupReports |
boolean |
|
Query |
startDate |
startDate |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
deviceStatsReports
Get beacon stats by put
PUT /papis/v1/projects/{projectId}/devices/beacons/stats
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
format |
format |
enum (json) |
|
Body |
reportRequest |
reportRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
deviceStatsReports
Get beacon by beacon id
GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
beaconId |
beaconId |
string |
Path |
projectId |
projectId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon
PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
beaconId |
beaconId |
string |
Path |
projectId |
projectId |
integer (int64) |
Body |
beacon |
beacon |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon label values
PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/_labelValues
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
beaconId |
beaconId |
string |
|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
createValues |
createValues |
boolean |
|
Body |
labelValues |
labelValues |
< LabelValue > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< LabelValue > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon label values
PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/_labelValues/add
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
beaconId |
beaconId |
string |
|
Path |
projectId |
projectId |
integer (int64) |
|
Query |
createValues |
createValues |
boolean |
|
Body |
labelValue |
labelValue |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< LabelValue > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon name
PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/_rename
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
beaconId |
beaconId |
string |
Path |
projectId |
projectId |
integer (int64) |
Body |
beaconNameObject |
beaconNameObject |
< string, string > map |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
480 |
Error |
|
500 |
Server Error |
Consumes
-
application/json
Produces
-
*/*
Tags
-
beacons
Update beacon condition monitoring config
PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/conditionConfig
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
beaconId |