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
required

accountId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Account

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • accounts

Update Account

PUT /papis/v1/accounts/{accountId}

Parameters

Type Name Description Schema

Body

account
required

account

Account

Responses

HTTP Code Description Schema

200

OK

Account

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceTypes

Get device type

GET /papis/v1/deviceTypes/{code}

Parameters

Type Name Description Schema

Path

code
required

code

string

Responses

HTTP Code Description Schema

200

OK

DeviceType

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceTypes

Get system template

GET /papis/v1/deviceTypes/{code}/template

Parameters

Type Name Description Schema

Path

code
required

code

string

Responses

HTTP Code Description Schema

200

OK

BeaconTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

baseTemp
optional

baseTemp

number (float)

Query

beaconId
optional

beaconId

string

Query

details
optional

details

boolean

"false"

Query

endDate
optional

endDate

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

raw
optional

raw

boolean

"false"

Query

separator
optional

separator

string

"default"

Query

showClosed
optional

showClosed

boolean

"false"

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

baseTemp
optional

baseTemp

number (float)

Query

beaconId
optional

beaconId

string

Query

details
optional

details

boolean

"false"

Query

endDate
optional

endDate

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

raw
optional

raw

boolean

"false"

Query

separator
optional

separator

string

"default"

Query

showClosed
optional

showClosed

boolean

"false"

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

string

Query

dataType
required

dataType

string

Query

endDate
optional

endDate

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

rcmOnly
optional

rcmOnly

boolean

"false"

Query

separator
optional

separator

string

"default"

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

string

Query

dataType
required

dataType

string

Query

endDate
optional

endDate

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

rcmOnly
optional

rcmOnly

boolean

"false"

Query

separator
optional

separator

string

"default"

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

endDate
optional

endDate

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

interval
required

interval

string

Query

provider
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • history

getAllAggregateMetricHistoryByBeacon

GET /papis/v1/history/metric/aggregate/{projectId}

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

download
optional

download

boolean

"false"

Query

endDate
optional

endDate

string

Query

format
required

format

enum (json)

"json"

Query

interval
required

interval

string

Query

provider
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
required

beaconId

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

highRes
optional

highRes

boolean

"false"

Query

policyId
required

policyId

integer (int64)

Query

provider
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

separator
optional

separator

string

"default"

Query

xCluster
optional

xCluster

integer (int32)

-1

Query

yCluster
optional

yCluster

integer (int32)

-1

Query

zCluster
optional

zCluster

integer (int32)

-1

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
required

beaconId

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

highRes
optional

highRes

boolean

"false"

Query

policyId
required

policyId

integer (int64)

Query

provider
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

separator
optional

separator

string

"default"

Query

xCluster
optional

xCluster

integer (int32)

-1

Query

yCluster
optional

yCluster

integer (int32)

-1

Query

zCluster
optional

zCluster

integer (int32)

-1

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
required

beaconId

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

highRes
optional

highRes

boolean

"false"

Query

policyId
required

policyId

integer (int64)

Query

provider
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

separator
optional

separator

string

"default"

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
required

beaconId

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

highRes
optional

highRes

boolean

"false"

Query

policyId
required

policyId

integer (int64)

Query

provider
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

separator
optional

separator

string

"default"

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
optional

bz-page-token

string

Path

projectId
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

dataType
required

dataType

string

Query

deviceJobId
optional

deviceJobId

integer (int64)

Query

endDate
optional

endDate

string

Query

filters
optional

filters

< string > array(multi)

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

provider
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

separator
optional

separator

string

"default"

Query

sessionId
optional

sessionId

string

Query

startDate
optional

startDate

string

Query

storageType
optional

storageType

string

Responses

HTTP Code Description Schema

200

Raw Metric History Data
Headers :
bz-page-token (string)

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
optional

bz-page-token

string

Path

projectId
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

dataType
required

dataType

string

Query

deviceJobId
optional

deviceJobId

integer (int64)

Query

endDate
optional

endDate

string

Query

filters
optional

filters

< string > array(multi)

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

provider
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

separator
optional

separator

string

"default"

Query

sessionId
optional

sessionId

string

Query

startDate
optional

startDate

string

Query

storageType
optional

storageType

string

Responses

HTTP Code Description Schema

200

Raw Metric History Data
Headers :
bz-page-token (string)

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

request
required

request

HistoryMetricRequest

Responses

HTTP Code Description Schema

200

OK

< BeaconHistoryMetricValue > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

blufiId
optional

blufiId

< string > array(multi)

Query

download
optional

download

boolean

"true"

Query

endDate
optional

endDate

string

Query

format
required

format

enum (json)

"json"

Query

interval
required

interval

string

Query

metric
required

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
optional

provider

enum (LEGACY, SAMPLER)

"LEGACY"

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

request
required

request

HistoryMetricRequest

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

allowAll
optional

allowAll

boolean

Query

beaconId
optional

beaconId

< string > array(multi)

Query

download
optional

download

boolean

"false"

Query

endDate
optional

endDate

string

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

allowAll
optional

allowAll

boolean

Query

beaconId
optional

beaconId

< string > array(multi)

Query

download
optional

download

boolean

"false"

Query

endDate
optional

endDate

string

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

dataType
required

dataType

< string > array(multi)

Query

download
optional

download

boolean

"false"

Query

endDate
required

endDate

string

Query

startDate
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

dataType
required

dataType

< string > array(multi)

Query

endDate
required

endDate

string

Query

startDate
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • history

Get all manufacture data

GET /papis/v1/mfgdata

Responses

HTTP Code Description Schema

200

OK

CollectionOfDeviceMfgInfo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • manufactureData

Get manufacture data by id64

GET /papis/v1/mfgdata/devices/{id64}

Parameters

Type Name Description Schema

Path

id64
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • manufactureData

Create a project

POST /papis/v1/projects

Parameters

Type Name Description Schema

Body

project
required

project

Project

Responses

HTTP Code Description Schema

200

OK

Project

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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

PanicButtonDashboardView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • panicButtonDashboard

Get a project by its id

GET /papis/v1/projects/{projectId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Project

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Update a project

PUT /papis/v1/projects/{projectId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

project
required

project

Project

Responses

HTTP Code Description Schema

200

OK

Project

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Export complete project

POST /papis/v1/projects/{projectId}/_exports

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • */*

Produces

  • */*

Tags

  • exportimport

Post import Operations

POST /papis/v1/projects/{projectId}/_exports/{exportId}/_after

Parameters

Type Name Description Schema

Path

exportId
required

exportId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiRedirect
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • exportimport

Export status

GET /papis/v1/projects/{projectId}/_exports/{exportId}/status

Parameters

Type Name Description Schema

Path

exportId
required

exportId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • exportimport

Import complete project

POST /papis/v1/projects/{projectId}/_imports

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

exportInfo
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • exportimport

Import status

GET /papis/v1/projects/{projectId}/_imports

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • exportimport

Import status

GET /papis/v1/projects/{projectId}/_imports/{importId}/status

Parameters

Type Name Description Schema

Path

importId
required

importId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • exportimport

Create a installer test log

POST /papis/v1/projects/{projectId}/_installerTestLog

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

dto
required

dto

InstallerTestLog

Responses

HTTP Code Description Schema

200

OK

InstallerTestLog

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Update project name

PUT /papis/v1/projects/{projectId}/_rename

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

projectNameObject
required

projectNameObject

< string, string > map

Responses

HTTP Code Description Schema

200

OK

Project

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Request to enable Policy features

PUT /papis/v1/projects/{projectId}/_requestPolicyFeatures

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Request to enable RTLS features

PUT /papis/v1/projects/{projectId}/_requestRTLSFeatures

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

setProjectContext

PUT /papis/v1/projects/{projectId}/_set

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Project

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Get project api access

GET /papis/v1/projects/{projectId}/apiAccess

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Create assets

POST /papis/v1/projects/{projectId}/assets

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

assets
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • assets

Get all assets

GET /papis/v1/projects/{projectId}/assets

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • assets

Get an asset

GET /papis/v1/projects/{projectId}/assets/{assetId}

Parameters

Type Name Description Schema

Path

assetId
required

assetId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Asset

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • assets

update one asset

PUT /papis/v1/projects/{projectId}/assets/{assetId}

Parameters

Type Name Description Schema

Path

assetId
required

assetId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

asset
required

asset

Asset

Responses

HTTP Code Description Schema

200

OK

Asset

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • assets

Remove an asset

DELETE /papis/v1/projects/{projectId}/assets/{assetId}

Parameters

Type Name Description Schema

Path

assetId
required

assetId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

assetId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

assetId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beacons
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

assetId

integer (int64)

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BeaconLite

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

assetId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

notificationSubscriptions
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

assetId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

assetId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

notificationSubscriptionIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • notificationSubscriptions

Get NotificationSubscription

GET /papis/v1/projects/{projectId}/assets/{assetId}/notificationSubscriptions/{notificationSubscriptionId}

Parameters

Type Name Description Schema

Path

assetId
required

assetId

integer (int64)

Path

notificationSubscriptionId
required

notificationSubscriptionId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

NotificationSubscription

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

assetId

integer (int64)

Path

notificationSubscriptionId
required

notificationSubscriptionId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

notificationSubscription
required

notificationSubscription

NotificationSubscription

Responses

HTTP Code Description Schema

200

OK

NotificationSubscription

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • notificationSubscriptions

Remove NotificationSubscription

DELETE /papis/v1/projects/{projectId}/assets/{assetId}/notificationSubscriptions/{notificationSubscriptionId}

Parameters

Type Name Description Schema

Path

assetId
required

assetId

integer (int64)

Path

notificationSubscriptionId
required

notificationSubscriptionId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • notificationSubscriptions

Create beacon template

POST /papis/v1/projects/{projectId}/beaconTemplates

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

template
required

template

BeaconTemplate

Responses

HTTP Code Description Schema

200

OK

BeaconTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

templateIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Path

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BeaconTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Path

templateId
required

templateId

integer (int64)

Body

template
required

template

BeaconTemplate

Responses

HTTP Code Description Schema

200

OK

BeaconTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Path

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BeaconTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beaconTemplates

Bulk provision beacons

POST /papis/v1/projects/{projectId}/beacons/_bulkProvision

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

configType
optional

configType

string

Query

locationId
optional

locationId

integer (int64)

Query

skipDeviceJob
optional

skipDeviceJob

boolean

"false"

Query

templateId
optional

templateId

integer (int64)

FormData

file
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

beaconId

string

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ltxReadReport

Create blufi template

POST /papis/v1/projects/{projectId}/blufiTemplates

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiTemplate
required

blufiTemplate

BlufiTemplate

Responses

HTTP Code Description Schema

200

OK

BlufiTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiTemplates

Get all blufi templates

GET /papis/v1/projects/{projectId}/blufiTemplates

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

templateIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiTemplates

Import Encrypted Blufi Template

POST /papis/v1/projects/{projectId}/blufiTemplates/_importEncrypted

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

encodedPayload
required

encodedPayload

EncodedPayload

Responses

HTTP Code Description Schema

200

OK

BlufiTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

FormData

file
required

file

file

Responses

HTTP Code Description Schema

200

OK

BlufiTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BlufiTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiTemplates

Update blufi template

PUT /papis/v1/projects/{projectId}/blufiTemplates/{templateId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

templateId
required

templateId

integer (int64)

Body

blufiTemplate
required

blufiTemplate

BlufiTemplate

Responses

HTTP Code Description Schema

200

OK

BlufiTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Path

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

EncodedPayload

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BlufiTemplateLite

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiTemplates

Bulk provision blufis

POST /papis/v1/projects/{projectId}/blufis/_bulkProvision

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

locationId
optional

locationId

integer (int64)

Query

templateId
optional

templateId

integer (int64)

FormData

file
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • */*

Tags

  • blufiBulkProvisioning

Provision blufi

POST /papis/v1/projects/{projectId}/blufis/_provision

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

id64Hex
required

id64Hex

string

Query

locationId
required

locationId

integer (int64)

Query

name
optional

name

string

Query

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Blufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

blufiId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Get cloud user info

GET /papis/v1/projects/{projectId}/cloud/_user

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

CloudUser

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • portalCloud

Get project context

GET /papis/v1/projects/{projectId}/context

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

ProjectContext

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Get devices by device search

POST /papis/v1/projects/{projectId}/dashboard

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

deviceSearch
required

deviceSearch

DeviceSearch

Responses

HTTP Code Description Schema

200

OK

DashboardView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

DashboardView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • dashboard

Get search beacon view

GET /papis/v1/projects/{projectId}/dashboard/_search

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

value
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

tagIds
required

tagIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

DashboardOverviewDevicesOfBeaconView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

includeDevices
optional

includeDevices

boolean

"true"

Query

tagIds
optional

tagIds

< integer (int64) > array(multi)

Responses

HTTP Code Description Schema

200

OK

DashboardOverview

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

includeDevices
optional

includeDevices

boolean

"false"

Query

tagIds
optional

tagIds

< integer (int64) > array(multi)

Responses

HTTP Code Description Schema

200

OK

DashboardOverview

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

limit
optional

limit

integer (int32)

5

Query

tagIds
optional

tagIds

< integer (int64) > array(multi)

Responses

HTTP Code Description Schema

200

OK

DashboardRecent

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

tagIds
required

tagIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

Dashboard2OfBlufiView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • dashboard

Get blufi views

GET /papis/v1/projects/{projectId}/dashboard/blufiViews

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Dashboard2OfBlufiView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Path

tagId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • dashboard

Get device templates

GET /papis/v1/projects/{projectId}/deviceTemplates

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

beaconId

string

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacons

GET /papis/v1/projects/{projectId}/devices/beacons

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

parkingOnly
optional

parkingOnly

boolean

"false"

Query

rtlsOnly
optional

rtlsOnly

boolean

"false"

Responses

HTTP Code Description Schema

200

OK

< Beacon > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

configBeaconBulk
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Update beacon configuration

PUT /papis/v1/projects/{projectId}/devices/beacons/_config

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

configBeaconSingle
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

config
required

config

ConfigBeaconFirmware

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

config
required

config

ConfigBeaconFirmware

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

configBeaconConfigType
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

configBeaconTemplate
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Delete beacons

PUT /papis/v1/projects/{projectId}/devices/beacons/_delete

Parameters

Type Name Description Schema

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Beacon Inventory Report

GET /papis/v1/projects/{projectId}/devices/beacons/_inventory

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon map

GET /papis/v1/projects/{projectId}/devices/beacons/_map

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

endDate
optional

endDate

string

Query

minDuration
optional

minDuration

integer (int32)

0

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

request
required

request

BeaconConditionConfigRequest

Responses

HTTP Code Description Schema

200

OK

< string > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

request
required

request

BeaconBulkRequest

Responses

HTTP Code Description Schema

200

OK

< BeaconFirmwareUpdate > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

config
required

config

ConfigBeaconFirmware

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

config
required

config

ConfigBeaconFirmware

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

firmwareImageId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

config
required

config

ConfigBeaconFirmware

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

jobCancelBulk
required

jobCancelBulk

DeviceJobCancelBulk

Responses

HTTP Code Description Schema

200

OK

DeviceJobCancelBulk

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

jobBulk
required

jobBulk

DeviceJobBulk

Responses

HTTP Code Description Schema

200

OK

DeviceJobBulk

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

jobCancel
required

jobCancel

DeviceJobCancel

Responses

HTTP Code Description Schema

200

OK

DeviceJobCancel

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

deviceJobIds
required

deviceJobIds

< integer (int64) > array(multi)

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

deviceJobIds
required

deviceJobIds

< integer (int64) > array(multi)

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

job
required

job

DeviceJob

Responses

HTTP Code Description Schema

200

OK

DeviceJobDetail

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Body

request
required

request

DeviceJobFromSchedule

Responses

HTTP Code Description Schema

200

OK

< DeviceJob > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

deviceJobTemplate
required

deviceJobTemplate

DeviceJobTemplate

Responses

HTTP Code Description Schema

200

OK

DeviceJobTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconIds
optional

beaconIds

< string > array(multi)

Query

blufiIds
optional

blufiIds

< integer (int64) > array(multi)

Query

configTypes
optional

configTypes

< string > array(multi)

Query

currentStates
optional

currentStates

< string > array(multi)

Query

deviceJobScheduleIds
optional

deviceJobScheduleIds

< integer (int64) > array(multi)

Query

forDate
optional

forDate

string

Query

fromDate
optional

fromDate

string

Query

page
optional

page

integer (int32)

1

Query

pageSize
optional

pageSize

integer (int32)

2147483647

Query

sortBy
optional

sortBy

string

"deviceJobId"

Query

sortDirection
optional

sortDirection

string

"ASC"

Query

toDate
optional

toDate

string

Responses

HTTP Code Description Schema

200

OK

PageResponseOfDeviceJobLite

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

request
required

request

DeviceJobRequest

Responses

HTTP Code Description Schema

200

OK

PageResponseOfDeviceJobLite

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

deviceJobId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

DeviceJobDetail

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

deviceJobId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

DeviceJobDetail

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

page
optional

page

integer (int32)

1

Query

pageSize
optional

pageSize

integer (int32)

2147483647

Query

sortBy
optional

sortBy

string

"beaconReadReportId"

Query

sortDirection
optional

sortDirection

string

"ASC"

Responses

HTTP Code Description Schema

200

OK

PageResponseOfBeaconReadReport

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

from
optional

from

integer (int64)

Query

reportIds
optional

reportIds

< integer (int64) > array(multi)

Query

to
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

from
optional

from

integer (int64)

Query

reportIds
optional

reportIds

< integer (int64) > array(multi)

Query

to
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

request
required

request

BeaconReadRunReportRequest

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconIds
optional

beaconIds

< string > array(multi)

Query

deviceJobIds
optional

deviceJobIds

< integer (int64) > array(multi)

Query

deviceJobScheduleIds
optional

deviceJobScheduleIds

< integer (int64) > array(multi)

Query

forDate
optional

forDate

string

Query

fromDate
optional

fromDate

string

Query

metricType
optional

metricType

string

Query

page
optional

page

integer (int32)

1

Query

pageSize
optional

pageSize

integer (int32)

2147483647

Query

reportType
optional

reportType

string

Query

sortBy
optional

sortBy

string

"beaconReadReportId"

Query

sortDirection
optional

sortDirection

string

"ASC"

Query

toDate
optional

toDate

string

Responses

HTTP Code Description Schema

200

OK

PageResponseOfBeaconReadReport

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Body

request
required

request

BeaconReadReportRequest

Responses

HTTP Code Description Schema

200

OK

PageResponseOfBeaconReadReport

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

fileName

string

Path

projectId
required

projectId

integer (int64)

Path

reportId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Path

reportId
required

reportId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BeaconReadReport

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Path

reportId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconIds
optional

beaconIds

< string > array(multi)

Query

endDate
optional

endDate

string

Query

fields
optional

fields

< string > array(multi)

Query

forDate
optional

forDate

string

Query

format
required

format

enum (json)

"json"

Query

isoDateTime
optional

isoDateTime

boolean

"false"

Query

reportType
optional

reportType

string

Query

rollupReports
optional

rollupReports

boolean

"true"

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

beaconIds
optional

beaconIds

< string > array(multi)

Query

endDate
optional

endDate

string

Query

fields
optional

fields

< string > array(multi)

Query

forDate
optional

forDate

string

Query

format
required

format

enum (json)

"json"

Query

isoDateTime
optional

isoDateTime

boolean

"false"

Query

reportType
optional

reportType

string

Query

rollupReports
optional

rollupReports

boolean

"true"

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

projectId

integer (int64)

Query

format
required

format

enum (json)

"json"

Body

reportRequest
required

reportRequest

BeaconStatsReportRequest

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Beacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Update beacon

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Body

beacon
required

beacon

Beacon

Responses

HTTP Code Description Schema

200

OK

Beacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Query

createValues
optional

createValues

boolean

"false"

Body

labelValues
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Query

createValues
optional

createValues

boolean

"false"

Body

labelValue
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Body

beaconNameObject
required

beaconNameObject

< string, string > map

Responses

HTTP Code Description Schema

200

OK

Beacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

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
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Body

request
required

request

BeaconConditionConfigRequest

Responses

HTTP Code Description Schema

200

OK

Beacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Update beacon coordinates

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/coordinates

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Body

coordinates
required

coordinates

Coordinates

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon events

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/events

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

TokenPageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon events paged

POST /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/events/_query

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Body

query
required

query

TokenPageQuery

Responses

HTTP Code Description Schema

200

OK

TokenPageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get firmware images for beacon

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/firmware

Parameters

Type Name Description Schema Default

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Query

filterDefaults
optional

filterDefaults

boolean

"false"

Query

findAlternateImages
optional

findAlternateImages

boolean

"false"

Responses

HTTP Code Description Schema

200

OK

< FirmwareImage > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get default firmware revision for beacon

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/firmware/_defaultRevision

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

integer (int32)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get default firmware images for beacon

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/firmware/_defaults

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< FirmwareImageDefault > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • beacons

Get beacon jobs

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/jobs

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< DeviceJobLite > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobs

Get beacon jobs by beacon id and job id

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/jobs/{jobId}

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

jobId
required

jobId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

DeviceJobDetail

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobs

Get beacon job configuration

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/jobs/{jobId}/configData

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

jobId
required

jobId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobs

Get beacon job logs

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/jobs/{jobId}/logs

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

jobId
required

jobId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< DeviceJobLog > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobs

Update beacon metadata

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/metaData

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Body

metaData
required

metaData

object

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Create a Policy for this Beacon

POST /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/policies

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Body

policy
required

policy

Policy

Responses

HTTP Code Description Schema

200

OK

Policy

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get Beacon Policies

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/policies

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Policy > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Add this beacon to an existing policy

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/policies/{policyId}

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Policy

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon scan data

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/scanData

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BeaconScanData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon scan data any

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/scanData/_any

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

ScanData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon scan data closest

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/scanData/_closest

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

ScanData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon selfie view

POST /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon selfie view

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon selfie view

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon selfie view

DELETE /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon selfie view

PATCH /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon selfie view

HEAD /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon selfie view

OPTIONS /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get BeaconStats

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/stats

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BeaconStats

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon templates by beacon id

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/templates

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get beacon policy violations

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/violations

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< PolicyViolation > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • beacons

Get blufis

GET /papis/v1/projects/{projectId}/devices/blufis

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Blufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update Blufis

PUT /papis/v1/projects/{projectId}/devices/blufis

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufis
required

blufis

< Blufi > array

Responses

HTTP Code Description Schema

200

OK

< Blufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Reset blufi ble

PUT /papis/v1/projects/{projectId}/devices/blufis/_bleReset

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Apply blufi wifi configuration by template

PUT /papis/v1/projects/{projectId}/devices/blufis/_config/applyWifi

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

configBlufiTemplate
required

configBlufiTemplate

ConfigBlufiTemplate

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi hostnames

PUT /papis/v1/projects/{projectId}/devices/blufis/_config/hostnames

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

forced
optional

forced

boolean

"false"

Body

request
required

request

BlufiBulkRequest

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi reset interval

PUT /papis/v1/projects/{projectId}/devices/blufis/_config/resetInterval

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

configBlufiResetInterval
required

configBlufiResetInterval

ConfigBlufiResetInterval

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi configuration by template

PUT /papis/v1/projects/{projectId}/devices/blufis/_config/template

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

configBlufiTemplate
required

configBlufiTemplate

ConfigBlufiTemplate

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi wifi pm policy

PUT /papis/v1/projects/{projectId}/devices/blufis/_config/wifiPmPolicy

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

configBlufiPmPolicy
required

configBlufiPmPolicy

ConfigBlufiPmPolicy

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi wifi rates

PUT /papis/v1/projects/{projectId}/devices/blufis/_config/wifiRates

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

configBlufiWifiRates
required

configBlufiWifiRates

ConfigBlufiWifiRates

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufis in csv format

POST /papis/v1/projects/{projectId}/devices/blufis/_csv

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

request
required

request

FilterSortRequest

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • blufis

Get blufis in csv format

GET /papis/v1/projects/{projectId}/devices/blufis/_csv

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

filterOptions
required

filterOptions

string

Query

sortOptions
required

sortOptions

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • text/csv

Tags

  • blufis

Delete blufi

PUT /papis/v1/projects/{projectId}/devices/blufis/_delete

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

deleteChildPolicies
optional

deleteChildPolicies

boolean

"false"

Body

deviceIds
required

deviceIds

CollectionOfstring

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Factory reset blufis

PUT /papis/v1/projects/{projectId}/devices/blufis/_factoryReset

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Replace existing blufi with new blufi

POST /papis/v1/projects/{projectId}/devices/blufis/_replace

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

request
required

request

BlufiReplaceRequest

Responses

HTTP Code Description Schema

200

OK

Blufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Search blufis

GET /papis/v1/projects/{projectId}/devices/blufis/_search

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

value
optional

value

string

Responses

HTTP Code Description Schema

200

OK

< BlufiSearchView > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Search blufis connection status

POST /papis/v1/projects/{projectId}/devices/blufis/_status

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufis
required

blufis

< string > array

Responses

HTTP Code Description Schema

200

OK

< BlufiStatus > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi calibrations

POST /papis/v1/projects/{projectId}/devices/blufis/_updateCalibration

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufis
required

blufis

< Blufi > array

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufis tethering

POST /papis/v1/projects/{projectId}/devices/blufis/_updateTethering

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiTetheringRequest
required

blufiTetheringRequest

BlufiTetheringRequest

Responses

HTTP Code Description Schema

200

OK

< string > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufis tethering

GET /papis/v1/projects/{projectId}/devices/blufis/_updateTethering

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiTetheringRequest
required

blufiTetheringRequest

BlufiTetheringRequest

Responses

HTTP Code Description Schema

200

OK

< string > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufis tethering

PUT /papis/v1/projects/{projectId}/devices/blufis/_updateTethering

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiTetheringRequest
required

blufiTetheringRequest

BlufiTetheringRequest

Responses

HTTP Code Description Schema

200

OK

< string > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufis tethering

DELETE /papis/v1/projects/{projectId}/devices/blufis/_updateTethering

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiTetheringRequest
required

blufiTetheringRequest

BlufiTetheringRequest

Responses

HTTP Code Description Schema

200

OK

< string > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufis tethering

PATCH /papis/v1/projects/{projectId}/devices/blufis/_updateTethering

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiTetheringRequest
required

blufiTetheringRequest

BlufiTetheringRequest

Responses

HTTP Code Description Schema

200

OK

< string > array

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufis tethering

HEAD /papis/v1/projects/{projectId}/devices/blufis/_updateTethering

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiTetheringRequest
required

blufiTetheringRequest

BlufiTetheringRequest

Responses

HTTP Code Description Schema

200

OK

< string > array

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufis tethering

OPTIONS /papis/v1/projects/{projectId}/devices/blufis/_updateTethering

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiTetheringRequest
required

blufiTetheringRequest

BlufiTetheringRequest

Responses

HTTP Code Description Schema

200

OK

< string > array

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufis lite view

GET /papis/v1/projects/{projectId}/devices/blufis/_view

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< BlufiLite > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Create blufi sleep cycle

POST /papis/v1/projects/{projectId}/devices/blufis/blufis/{blufiId}/sleepCycles

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiSleepCycle
required

blufiSleepCycle

BlufiSleepCycle

Responses

HTTP Code Description Schema

200

OK

BlufiSleepCycle

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepCycles

Get blufi sleep cycle by id

GET /papis/v1/projects/{projectId}/devices/blufis/blufis/{blufiId}/sleepCycles/{cycleId}

Parameters

Type Name Description Schema

Path

cycleId
required

cycleId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BlufiSleepCycle

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepCycles

Update blufi sleep cycle by id

PUT /papis/v1/projects/{projectId}/devices/blufis/blufis/{blufiId}/sleepCycles/{cycleId}

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

cycleId
required

cycleId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiSleepCycle
required

blufiSleepCycle

BlufiSleepCycle

Responses

HTTP Code Description Schema

200

OK

BlufiSleepCycle

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepCycles

Delete blufi sleep cycle by id

DELETE /papis/v1/projects/{projectId}/devices/blufis/blufis/{blufiId}/sleepCycles/{cycleId}

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

cycleId
required

cycleId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepCycles

Get default firmware revisions for blufis

PUT /papis/v1/projects/{projectId}/devices/blufis/firmware/_defaultRevisions

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

request
required

request

BlufiBulkRequest

Responses

HTTP Code Description Schema

200

OK

< BlufiFirmwareUpdate > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Bulk clear blufi firmware updates

PUT /papis/v1/projects/{projectId}/devices/blufis/firmware/clear

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

request
required

request

BlufiBulkRequest

Responses

HTTP Code Description Schema

200

OK

BlufiBulkFirmwareUpdate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Bulk install blufi firmware images by id

PUT /papis/v1/projects/{projectId}/devices/blufis/firmware/config

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

update
required

update

BlufiBulkFirmwareUpdate

Responses

HTTP Code Description Schema

200

OK

BlufiBulkFirmwareUpdate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Bulk install default blufi firmware images

PUT /papis/v1/projects/{projectId}/devices/blufis/firmware/config/_default

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

update
required

update

BlufiBulkDefaultFirmwareUpdate

Responses

HTTP Code Description Schema

200

OK

BlufiBulkDefaultFirmwareUpdate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Mute blufi

PUT /papis/v1/projects/{projectId}/devices/blufis/mute

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi scan mode bulk

PUT /papis/v1/projects/{projectId}/devices/blufis/scanmode/{scanModeId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scanModeId
required

scanModeId

integer (int64)

Body

blufiIds
required

blufiIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Create blufi sleep schedule

POST /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiSleepSchedule
required

blufiSleepSchedule

BlufiSleepSchedule

Responses

HTTP Code Description Schema

200

OK

BlufiSleepSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Get blufi sleep schedules by project

GET /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< BlufiSleepSchedule > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Create blufi sleep timeframe

POST /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/timeframes

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiSleepTimeframe
required

blufiSleepTimeframe

BlufiSleepTimeframe

Responses

HTTP Code Description Schema

200

OK

BlufiSleepTimeframe

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Get blufi sleep timeframes by project

GET /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/timeframes

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< BlufiSleepTimeframe > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Get blufi sleep timeframe by id

GET /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/timeframes/{timeframeId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

timeframeId
required

timeframeId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BlufiSleepTimeframe

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Update blufi sleep timeframe by id

PUT /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/timeframes/{timeframeId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

timeframeId
required

timeframeId

integer (int64)

Body

blufiSleepTimeframe
required

blufiSleepTimeframe

BlufiSleepTimeframe

Responses

HTTP Code Description Schema

200

OK

BlufiSleepTimeframe

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Delete blufi sleep timeframe by id

DELETE /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/timeframes/{timeframeId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

timeframeId
required

timeframeId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Get blufi sleep schedule by id

GET /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/{scheduleId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BlufiSleepSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Update blufi sleep schedule by id

PUT /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/{scheduleId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Body

blufiSleepSchedule
required

blufiSleepSchedule

BlufiSleepSchedule

Responses

HTTP Code Description Schema

200

OK

BlufiSleepSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Delete blufi sleep schedule by id

DELETE /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/{scheduleId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Add timeframe to blufi sleep schedule by id

PUT /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/{scheduleId}/_addTimeframe

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Body

blufiSleepTimeframe
required

blufiSleepTimeframe

BlufiSleepTimeframe

Responses

HTTP Code Description Schema

200

OK

BlufiSleepSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Add timeframes to blufi sleep schedule by id

PUT /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/{scheduleId}/_addTimeframes

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Body

blufiSleepTimeframes
required

blufiSleepTimeframes

< BlufiSleepTimeframe > array

Responses

HTTP Code Description Schema

200

OK

BlufiSleepSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Set timeframes of blufi sleep schedule by id

PUT /papis/v1/projects/{projectId}/devices/blufis/sleepSchedules/{scheduleId}/_setTimeframes

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Body

blufiSleepTimeframes
required

blufiSleepTimeframes

< BlufiSleepTimeframe > array

Responses

HTTP Code Description Schema

200

OK

BlufiSleepSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Get blufi stats

POST /papis/v1/projects/{projectId}/devices/blufis/stats

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

blufiIds
optional

blufiIds

< integer (int64) > array(multi)

Query

endDate
optional

endDate

string

Query

fields
optional

fields

< string > array(multi)

Query

forDate
optional

forDate

string

Query

format
required

format

enum (json)

"json"

Query

isoDateTime
optional

isoDateTime

boolean

"false"

Query

reportType
optional

reportType

string

Query

rollupReports
optional

rollupReports

boolean

"true"

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • deviceStatsReports

Get blufi stats

GET /papis/v1/projects/{projectId}/devices/blufis/stats

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

blufiIds
optional

blufiIds

< integer (int64) > array(multi)

Query

endDate
optional

endDate

string

Query

fields
optional

fields

< string > array(multi)

Query

forDate
optional

forDate

string

Query

format
required

format

enum (json)

"json"

Query

isoDateTime
optional

isoDateTime

boolean

"false"

Query

reportType
optional

reportType

string

Query

rollupReports
optional

rollupReports

boolean

"true"

Query

startDate
optional

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • deviceStatsReports

Get blufi stats by put

PUT /papis/v1/projects/{projectId}/devices/blufis/stats

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

format
required

format

enum (json)

"json"

Body

reportRequest
required

reportRequest

BlufiStatsReportRequest

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • deviceStatsReports

Get Blufi factory template

GET /papis/v1/projects/{projectId}/devices/blufis/template/factory/{blufiSid64}

Parameters

Type Name Description Schema

Path

blufiSid64
required

blufiSid64

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BlufiTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Factory reset blufi

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/_factoryReset

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Blufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi name

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/_rename

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiNameObject
required

blufiNameObject

< string, string > map

Responses

HTTP Code Description Schema

200

OK

Blufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi coordinates

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/coordinates

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Body

coordinates
required

coordinates

Coordinates

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get firmware images for blufi

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/firmware

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< FirmwareImage > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get default firmware image for beacon

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/firmware/_defaults

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< FirmwareImageDefault > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • blufis

Update blufi ibeacon settings

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/ibeacon

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

iBeaconConfig
required

iBeaconConfig

BlufiIBeaconConfiguration

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Add PIR beacons to blufi

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/pirBeacons/_add

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Remove PIR beacons from blufi

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/pirBeacons/_remove

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi scan data

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/scanData

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BlufiScanData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi scan data any

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/scanData/_any

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

ScanData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi scan mode

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/scanmode

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

scanMode
required

scanMode

SystemScanMode

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi wifi config

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/setTemplate/{templateId}

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Path

templateId
required

templateId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi sleep schedule

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/sleepSchedule

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

sleepSchedule
required

sleepSchedule

BlufiSleepSchedule

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi sleep schedule by id

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/sleepSchedule/{scheduleId}

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Create blufi sleep schedule by blufi id

POST /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/sleepSchedules

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

sleepSchedule
required

sleepSchedule

BlufiSleepSchedule

Responses

HTTP Code Description Schema

200

OK

BlufiSleepSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Create blufi sleep timeframe by blufi id

POST /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/sleepTimeFrames

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

timeframe
required

timeframe

BlufiSleepTimeframe

Responses

HTTP Code Description Schema

200

OK

BlufiSleepTimeframe

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Get blufi sleep timeframes by blufi id

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/sleepTimeFrames

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< BlufiSleepTimeframe > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Update blufi sleep timeframe by blufi id

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/sleepTimeFrames/{timeframeId}

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Path

timeframeId
required

timeframeId

integer (int64)

Body

timeframe
required

timeframe

BlufiSleepTimeframe

Responses

HTTP Code Description Schema

200

OK

BlufiSleepTimeframe

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Delete blufi sleep timeframe by blufi id

DELETE /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/sleepTimeFrames/{timeframeId}

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Path

timeframeId
required

timeframeId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufiSleepSchedules

Get blufi

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Blufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Update blufi

PUT /papis/v1/projects/{projectId}/devices/blufis/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufi
required

blufi

Blufi

Responses

HTTP Code Description Schema

200

OK

Blufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi events

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/events

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

TokenPageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi events pages

POST /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/events/_query

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

query
required

query

TokenPageQuery

Responses

HTTP Code Description Schema

200

OK

TokenPageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi location

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/location

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi policies

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/policies

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Policy > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi selfie view

POST /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi selfie view

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi selfie view

PUT /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi selfie view

DELETE /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi selfie view

PATCH /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi selfie view

HEAD /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi selfie view

OPTIONS /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Get blufi policy violations

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/violations

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< PolicyViolation > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • blufis

Create virtual device

POST /papis/v1/projects/{projectId}/devices/virtualDevices

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

virtualDevice
required

virtualDevice

VirtualDevice

Responses

HTTP Code Description Schema

200

OK

VirtualDevice

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualDevice

Get all virtual devices

GET /papis/v1/projects/{projectId}/devices/virtualDevices

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< VirtualDevice > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualDevice

Delete virtual device by virtual device ids

PUT /papis/v1/projects/{projectId}/devices/virtualDevices/_delete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

virtualDeviceIds
required

virtualDeviceIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualDevice

Get virtual device

GET /papis/v1/projects/{projectId}/devices/virtualDevices/{virtualDeviceId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

virtualDeviceId
required

virtualDeviceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

VirtualDevice

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualDevice

Update virtual device

PUT /papis/v1/projects/{projectId}/devices/virtualDevices/{virtualDeviceId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

virtualDevice
required

virtualDevice

VirtualDevice

Responses

HTTP Code Description Schema

200

OK

VirtualDevice

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualDevice

Update virtual device coordinates

PUT /papis/v1/projects/{projectId}/devices/virtualDevices/{virtualDeviceId}/coordinates

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

virtualDeviceId
required

virtualDeviceId

integer (int64)

Body

coordinates
required

coordinates

Coordinates

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualDevice

adminClearPolicyEvent

PUT /papis/v1/projects/{projectId}/events/_clear

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

eventIds
required

eventIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

< PolicyEvent > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Get Blufi connection information

GET /papis/v1/projects/{projectId}/grafana/blufi/{blufiId}/connections

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Query

endTime
required

endTime

integer (int64)

Query

startTime
required

startTime

integer (int64)

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • grafana

Get Blufi received bytes

GET /papis/v1/projects/{projectId}/grafana/blufi/{blufiId}/receivedBytes

Parameters

Type Name Description Schema

Path

blufiId
required

blufiId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Query

endTime
required

endTime

integer (int64)

Query

startTime
required

startTime

integer (int64)

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • grafana

Get ScanData for PegoPanic service

GET /papis/v1/projects/{projectId}/grafana/pegoPanicScanData

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

endTime
required

endTime

integer (int64)

Query

startTime
required

startTime

integer (int64)

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • grafana

Get hotel loader jobs by projectId

GET /papis/v1/projects/{projectId}/hotelLoaderJobs

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< HotelLoaderJob > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hotelLoaderJobs

Upload hotel loader job

POST /papis/v1/projects/{projectId}/hotelLoaderJobs/create

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

address
required

address

string

Query

beaconTemplateId
optional

beaconTemplateId

integer (int64)

Query

blufiTemplateId
optional

blufiTemplateId

integer (int64)

Query

callbackUrl
optional

callbackUrl

string

Query

email
optional

email

string

Query

evaluateProject
optional

evaluateProject

boolean

Query

parentProjectId
optional

parentProjectId

integer (int64)

FormData

file
required

file

file

Responses

HTTP Code Description Schema

200

OK

HotelLoaderJob

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • */*

Tags

  • hotelLoaderJobs

Get hotel loader job

GET /papis/v1/projects/{projectId}/hotelLoaderJobs/{jobId}

Parameters

Type Name Description Schema

Path

jobId
required

jobId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

HotelLoaderJob

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hotelLoaderJobs

Retry hotel loader job

PUT /papis/v1/projects/{projectId}/hotelLoaderJobs/{jobId}/_retry

Parameters

Type Name Description Schema

Path

jobId
required

jobId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hotelLoaderJobs

Get hotel loader logs

GET /papis/v1/projects/{projectId}/hotelLoaderJobs/{jobId}/logs

Parameters

Type Name Description Schema

Path

jobId
required

jobId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< HotelLoaderJobLog > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hotelLoaderJobs

Get hoteling settings

GET /papis/v1/projects/{projectId}/hotelingSetting

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

HotelingSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Update hoteling setting

PUT /papis/v1/projects/{projectId}/hotelingSetting

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

setting
required

setting

HotelingSetting

Responses

HTTP Code Description Schema

200

OK

HotelingSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Delete hoteling setting

DELETE /papis/v1/projects/{projectId}/hotelingSetting

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

PUT /papis/v1/projects/{projectId}/hotelingSetting/logo

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

fileData
required

fileData

FileData

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

DELETE /papis/v1/projects/{projectId}/hotelingSetting/logo

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Create IBeacon Configuration

POST /papis/v1/projects/{projectId}/ibeaconconfigs

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

config
required

config

IBeaconConfiguration

Responses

HTTP Code Description Schema

200

OK

IBeaconConfiguration

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • iBeaconConfiguration

Bulk upload a list of ibeacon config

POST /papis/v1/projects/{projectId}/ibeaconconfigs/_bulkUpload

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

FormData

file
required

file

file

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • application/json

Tags

  • iBeaconConfiguration

Get information of a ibeacon config import job

GET /papis/v1/projects/{projectId}/ibeaconconfigs/_bulkUploadStatus

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

IBeaconConfigUploadJob

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • application/json

Tags

  • iBeaconConfiguration

Get ibeacon configuration in csv format

POST /papis/v1/projects/{projectId}/ibeaconconfigs/_csv

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

filterOptions
required

filterOptions

string

Query

sortOptions
required

sortOptions

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • text/csv

Tags

  • iBeaconConfiguration

Delete IBeacon Configuration

PUT /papis/v1/projects/{projectId}/ibeaconconfigs/_delete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

iBeaconConfigIds
required

iBeaconConfigIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • iBeaconConfiguration

Validate IBeacon Blufi

POST /papis/v1/projects/{projectId}/ibeaconconfigs/validateblufis

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

config
required

config

IBeaconConfiguration

Responses

HTTP Code Description Schema

200

OK

IBeaconConfiguration

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • iBeaconConfiguration

Get IBeacon Configuration

GET /papis/v1/projects/{projectId}/ibeaconconfigs/{iBeaconConfigId}

Parameters

Type Name Description Schema

Path

iBeaconConfigId
required

iBeaconConfigId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

IBeaconConfiguration

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • iBeaconConfiguration

Update IBeacon Configuration

PUT /papis/v1/projects/{projectId}/ibeaconconfigs/{iBeaconConfigId}

Parameters

Type Name Description Schema

Path

iBeaconConfigId
required

iBeaconConfigId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

config
required

config

IBeaconConfiguration

Responses

HTTP Code Description Schema

200

OK

IBeaconConfiguration

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • iBeaconConfiguration

Get device job schedules by project id

GET /papis/v1/projects/{projectId}/jobs/schedules

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< DeviceJobScheduleLite > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Create device job schedule

PUT /papis/v1/projects/{projectId}/jobs/schedules/_create

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

scheduleCreate
required

scheduleCreate

DeviceJobScheduleCreate

Responses

HTTP Code Description Schema

200

OK

DeviceJobSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Delete device job schedules by device job schedule ids

PUT /papis/v1/projects/{projectId}/jobs/schedules/_delete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

deviceJobScheduleIds
required

deviceJobScheduleIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Get device job schedules by project id and beacon id

GET /papis/v1/projects/{projectId}/jobs/schedules/beacons/{beaconId}

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< DeviceJobSchedule > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Add beacons to device job schedule

PUT /papis/v1/projects/{projectId}/jobs/schedules/{deviceJobScheduleId}/_add

Parameters

Type Name Description Schema

Path

deviceJobScheduleId
required

deviceJobScheduleId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Remove beacons from device job schedule

PUT /papis/v1/projects/{projectId}/jobs/schedules/{deviceJobScheduleId}/_remove

Parameters

Type Name Description Schema

Path

deviceJobScheduleId
required

deviceJobScheduleId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Get device job schedules by project id and schedule id

GET /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

DeviceJobSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Update device job schedule

PUT /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Body

schedule
required

schedule

DeviceJobSchedule

Responses

HTTP Code Description Schema

200

OK

DeviceJobSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Delete device job schedule by device job schedule id

DELETE /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Get device job schedule beacon ids by project id and schedule id

GET /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}/_beaconIds

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Set device job schedule beacon ids by project id and schedule id

PUT /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}/_beaconIds

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Body

beaconIds
required

beaconIds

< string > array

Responses

HTTP Code Description Schema

200

OK

< SimpleDevice > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Add device job schedule beacon ids by project id and schedule id

PUT /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}/_beaconIds/_add

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Body

beaconIds
required

beaconIds

< string > array

Responses

HTTP Code Description Schema

200

OK

< SimpleDevice > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Disable device job schedule

PUT /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}/_disable

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Enable device job schedule

PUT /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}/_enable

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Get device job schedule job ids by project id and schedule id

GET /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}/_jobIds

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< integer (int64) > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Get device job schedule jobs by project id and schedule id

GET /papis/v1/projects/{projectId}/jobs/schedules/{scheduleId}/_jobs

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

scheduleId
required

scheduleId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< DeviceJobLite > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceJobSchedules

Create labelValue object

POST /papis/v1/projects/{projectId}/labelValues

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

labelValues
required

labelValues

< LabelValue > array

Responses

HTTP Code Description Schema

201

Created

< LabelValue > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • labelValue

Get all LabelValue objects

GET /papis/v1/projects/{projectId}/labelValues

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< LabelValue > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • labelValue

find LabelValue objects by projectId and LabelId

GET /papis/v1/projects/{projectId}/labelValues/labels/{labelId1}

Parameters

Type Name Description Schema

Path

labelId1
required

labelId1

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< LabelValue > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • labelValue

Get one LabelValue

GET /papis/v1/projects/{projectId}/labelValues/{labelValueId}

Parameters

Type Name Description Schema

Path

labelValueId
required

labelValueId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

LabelValue

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • labelValue

update one

PUT /papis/v1/projects/{projectId}/labelValues/{labelValueId}

Parameters

Type Name Description Schema

Path

labelValueId
required

labelValueId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

labelValue
required

labelValue

LabelValue

Responses

HTTP Code Description Schema

200

OK

LabelValue

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • labelValue

Remove one LabelValue

DELETE /papis/v1/projects/{projectId}/labelValues/{labelValueId}

Parameters

Type Name Description Schema

Path

labelValueId
required

labelValueId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • labelValue

Create label object

POST /papis/v1/projects/{projectId}/labels

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

labels
required

labels

< Label > array

Responses

HTTP Code Description Schema

201

Created

< Label > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • label

Get all Label objects

GET /papis/v1/projects/{projectId}/labels

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Label > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • label

Remove bulk Labels

DELETE /papis/v1/projects/{projectId}/labels/_bulk

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

labelIds
required

labelIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • label

Get one Label

GET /papis/v1/projects/{projectId}/labels/{labelId}

Parameters

Type Name Description Schema

Path

labelId
required

labelId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Label

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • label

update one

PUT /papis/v1/projects/{projectId}/labels/{labelId}

Parameters

Type Name Description Schema

Path

labelId
required

labelId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

label
required

label

Label

Responses

HTTP Code Description Schema

200

OK

Label

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • label

Remove one Label

DELETE /papis/v1/projects/{projectId}/labels/{labelId}

Parameters

Type Name Description Schema

Path

labelId
required

labelId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • label

Create an LdapConnector

POST /papis/v1/projects/{projectId}/ldapConnectors

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

ldapConnector
required

ldapConnector

LdapConnector

Responses

HTTP Code Description Schema

200

OK

LdapConnector

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ldapConnectors

Get all Ldap Connectors for this project

GET /papis/v1/projects/{projectId}/ldapConnectors

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< LdapConnector > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ldapConnectors

Get an Ldap Connector

GET /papis/v1/projects/{projectId}/ldapConnectors/{ldapConnectorId}

Parameters

Type Name Description Schema

Path

ldapConnectorId
required

ldapConnectorId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

LdapConnector

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ldapConnectors

Update LdapConnector

PUT /papis/v1/projects/{projectId}/ldapConnectors/{ldapConnectorId}

Parameters

Type Name Description Schema

Path

ldapConnectorId
required

ldapConnectorId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

ldapConnector
required

ldapConnector

LdapConnector

Responses

HTTP Code Description Schema

200

OK

LdapConnector

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ldapConnectors

Delete LdapConnector

DELETE /papis/v1/projects/{projectId}/ldapConnectors/{ldapConnectorId}

Parameters

Type Name Description Schema

Path

ldapConnectorId
required

ldapConnectorId

integer (int64)

Path

projectId
required

projectId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ldapConnectors

Test an Ldap Connection

POST /papis/v1/projects/{projectId}/ldapQueries/_test

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

ldapConnector
required

ldapConnector

LdapConnectorEntity

Responses

HTTP Code Description Schema

200

OK

boolean

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ldapQueries

Test an Ldap Connection

GET /papis/v1/projects/{projectId}/ldapQueries/{ldapConnectorId}/_test

Parameters

Type Name Description Schema

Path

ldapConnectorId
required

ldapConnectorId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

boolean

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ldapQueries

Create location

POST /papis/v1/projects/{projectId}/locations

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

location
required

location

Location

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get locations

GET /papis/v1/projects/{projectId}/locations

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

hoteling
optional

hoteling

boolean

Query

mapProviderType
optional

mapProviderType

string

Responses

HTTP Code Description Schema

200

OK

< Location > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Delete Locations

PUT /papis/v1/projects/{projectId}/locations/_delete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

locationIds
required

locationIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Import locations

PUT /papis/v1/projects/{projectId}/locations/_import

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

locations
required

locations

< Location > array

Responses

HTTP Code Description Schema

200

OK

< Location > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get location

GET /papis/v1/projects/{projectId}/locations/{locationId}

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Update location

PUT /papis/v1/projects/{projectId}/locations/{locationId}

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

location
required

location

Location

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get beacons in location

GET /papis/v1/projects/{projectId}/locations/{locationId}/beacons

Parameters

Type Name Description Schema Default

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Query

identityEnabled
optional

identityEnabled

boolean

"false"

Responses

HTTP Code Description Schema

200

OK

< Beacon > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get blufis in location

GET /papis/v1/projects/{projectId}/locations/{locationId}/blufis

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Blufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get location data

GET /papis/v1/projects/{projectId}/locations/{locationId}/data
Caution

operation.deprecated

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< string (byte) > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Update location data

PUT /papis/v1/projects/{projectId}/locations/{locationId}/data

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

fileData
required

fileData

FileData

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Delete location data

DELETE /papis/v1/projects/{projectId}/locations/{locationId}/data

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Update location data layers

PUT /papis/v1/projects/{projectId}/locations/{locationId}/data-layers

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

dataLayers
required

dataLayers

LocationDataLayers

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get devices/beacons views with server pagination

GET /papis/v1/projects/{projectId}/locations/{locationId}/devices/beacons/_view/server

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Query

tagIds
optional

tagIds

string

Body

request
optional

request

ServerPagingRequest

Responses

HTTP Code Description Schema

200

OK

ServerPagingResponseOfBaseDevice

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get devices/blufis views with server pagination

GET /papis/v1/projects/{projectId}/locations/{locationId}/devices/blufis/_view/server

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Query

tagIds
optional

tagIds

string

Body

request
optional

request

ServerPagingRequest

Responses

HTTP Code Description Schema

200

OK

ServerPagingResponseOfBaseDevice

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Create a new hoteling location setting

POST /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

hotelingSetting
required

hotelingSetting

HotelingLocationSetting

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Update a hoteling location setting

PUT /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

hotelingSetting
required

hotelingSetting

HotelingLocationSetting

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Delete a single hoteling location setting

DELETE /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Get available blufis

GET /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/availableBlufis

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< BlufiLite > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Upload custom marker

PUT /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/customMarker

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

fileData
required

fileData

FileData

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Remove watermark

DELETE /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/customMarker

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Get setting ignore blufis

GET /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/ignoreBlufis

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< BlufiLite > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Get setting ignore blufis

PUT /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/ignoreBlufis

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Get setting meeting blufis

GET /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/meetingBlufis

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< BlufiLite > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Get setting meeting blufis

PUT /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/meetingBlufis

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

Location

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Upload watermark

PUT /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/watermark

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

fileData
required

fileData

FileData

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Remove watermark

DELETE /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSetting/watermark

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Get project zones summary

GET /papis/v1/projects/{projectId}/locations/{locationId}/hotelingSummary

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

HotelingSummary

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • hoteling

Get location policies

GET /papis/v1/projects/{projectId}/locations/{locationId}/policies

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Policy > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get location policies by type

GET /papis/v1/projects/{projectId}/locations/{locationId}/policies/{metricType}

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

metricType
required

metricType

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Policy > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get location summary

GET /papis/v1/projects/{projectId}/locations/{locationId}/summary

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

LocationSummary

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get a list of virtual blufis for a given location

GET /papis/v1/projects/{projectId}/locations/{locationId}/virtualBlufis

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< VirtualBlufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get a list of available virtual blufis for a given location

GET /papis/v1/projects/{projectId}/locations/{locationId}/virtualBlufis/_available

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< VirtualBlufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get virtual devices in location

GET /papis/v1/projects/{projectId}/locations/{locationId}/virtualDevices

Parameters

Type Name Description Schema

Path

locationId
required

locationId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< VirtualDevice > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • locations

Get project read reports

GET /papis/v1/projects/{projectId}/ltxReadReports

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • ltxReadReport

Create settings for a project

POST /papis/v1/projects/{projectId}/mls

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

count
optional

count

integer (int32)

Query

generateUuids
optional

generateUuids

boolean

"false"

Body

setting
required

setting

MlsSetting

Responses

HTTP Code Description Schema

200

OK

MlsSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mls

Get the mls settings for a project

GET /papis/v1/projects/{projectId}/mls

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

MlsSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mls

Update the mls settings for a project

PUT /papis/v1/projects/{projectId}/mls

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

count
optional

count

integer (int32)

Query

generateUuids
optional

generateUuids

boolean

"false"

Body

setting
required

setting

MlsSetting

Responses

HTTP Code Description Schema

200

OK

MlsSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mls

Create a zone

POST /papis/v1/projects/{projectId}/mustering/zones

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

zone
required

zone

MusteringZone

Responses

HTTP Code Description Schema

200

OK

MusteringZone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get the zones for a project

GET /papis/v1/projects/{projectId}/mustering/zones

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< MusteringZone > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Update a mustering zone

PUT /papis/v1/projects/{projectId}/mustering/zones

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

musteringZone
required

musteringZone

MusteringZone

Responses

HTTP Code Description Schema

200

OK

MusteringZone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Bulk delete zones

PUT /papis/v1/projects/{projectId}/mustering/zones/_delete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

ids
required

ids

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get project zones summary

GET /papis/v1/projects/{projectId}/mustering/zones/summary

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< ZonesSummary > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get a specific zone

POST /papis/v1/projects/{projectId}/mustering/zones/{musteringZoneId}

Parameters

Type Name Description Schema

Path

musteringZoneId
required

musteringZoneId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

MusteringZone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get a specific zone

GET /papis/v1/projects/{projectId}/mustering/zones/{musteringZoneId}

Parameters

Type Name Description Schema

Path

musteringZoneId
required

musteringZoneId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

MusteringZone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get a specific zone

PUT /papis/v1/projects/{projectId}/mustering/zones/{musteringZoneId}

Parameters

Type Name Description Schema

Path

musteringZoneId
required

musteringZoneId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

MusteringZone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get a specific zone

DELETE /papis/v1/projects/{projectId}/mustering/zones/{musteringZoneId}

Parameters

Type Name Description Schema

Path

musteringZoneId
required

musteringZoneId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

MusteringZone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get a specific zone

PATCH /papis/v1/projects/{projectId}/mustering/zones/{musteringZoneId}

Parameters

Type Name Description Schema

Path

musteringZoneId
required

musteringZoneId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

MusteringZone

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get a specific zone

HEAD /papis/v1/projects/{projectId}/mustering/zones/{musteringZoneId}

Parameters

Type Name Description Schema

Path

musteringZoneId
required

musteringZoneId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

MusteringZone

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get a specific zone

OPTIONS /papis/v1/projects/{projectId}/mustering/zones/{musteringZoneId}

Parameters

Type Name Description Schema

Path

musteringZoneId
required

musteringZoneId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

MusteringZone

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • mustering

Get panic button dashboard by project id

GET /papis/v1/projects/{projectId}/panicButtonDashboard

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

PanicButtonDashboardView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • panicButtonDashboard

Create policy

POST /papis/v1/projects/{projectId}/policies

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

policy
required

policy

Policy

Responses

HTTP Code Description Schema

200

OK

Policy

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get policies

GET /papis/v1/projects/{projectId}/policies

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Policy > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Delete policy

PUT /papis/v1/projects/{projectId}/policies/_delete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

policyIds
required

policyIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Export with labels as CSV

POST /papis/v1/projects/{projectId}/policies/_exportWithLabels

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

format
required

enum (csv)

"csv"

Query

policyId
required

policyId

< integer (int64) > array(multi)

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • policies

Export with labels as CSV

GET /papis/v1/projects/{projectId}/policies/_exportWithLabels

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

format
required

enum (csv)

"csv"

Query

policyId
required

policyId

< integer (int64) > array(multi)

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • policies

Get all PolicyDeviceStatus by project

GET /papis/v1/projects/{projectId}/policies/_latest

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

beaconIds
optional

beaconIds

string

Query

blufiIds
optional

blufiIds

string

Query

metric
optional

metric

enum (PRESENCE, BATTERY, TEMPERATURE, AMBIENT_TEMPERATURE, MOTION, GEOFENCE, DISTANCE, WEAKCONNECTION, WIFIPROBEQUEUE, MOTION_TRIGGER, PROXIMITY_ALERT, ENTER_EXIT, LOCATION_CHANGE, MOTION_CONDITION, MAGNETOMETER, TAMPER, PANIC_BUTTON, PARKING, ENTERPRISE_PRESENCE, VIBRATION_THRESHOLD, DISTANCE_VIOLATION, UNKNOWN)

Query

policyIds
optional

policyIds

string

Responses

HTTP Code Description Schema

200

OK

< PolicyDeviceStatusEnhanced > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get all PolicyDeviceStatus by metric

GET /papis/v1/projects/{projectId}/policies/_metric/{metric}/{namespace}/devices/{deviceId}/status

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Path

metric
required

metric

string

Path

namespace
required

namespace

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< PolicyDeviceStatus > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get all PolicyDeviceStatus for project

GET /papis/v1/projects/{projectId}/policies/_metric/{metric}/{namespace}/status

Parameters

Type Name Description Schema

Path

metric
required

metric

string

Path

namespace
required

namespace

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< PolicyDeviceStatus > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get dwell monitor view

GET /papis/v1/projects/{projectId}/policies/_reports/dwellMonitor

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

aggregate
optional

aggregate

boolean

"true"

Query

beaconId
optional

beaconId

string

Query

blufiId
optional

blufiId

integer (int64)

Query

endDate
optional

endDate

string

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

< DwellMonitorView > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Search policy events for policy ids

POST /papis/v1/projects/{projectId}/policies/_search

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

endDate
optional

endDate

string

Query

format
required

enum (csv)

"csv"

Query

policyId
required

policyId

< integer (int64) > array(multi)

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • policies

Search policy events for policy ids

GET /papis/v1/projects/{projectId}/policies/_search

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

endDate
optional

endDate

string

Query

format
required

enum (csv)

"csv"

Query

policyId
required

policyId

< integer (int64) > array(multi)

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • policies

Get policy views

GET /papis/v1/projects/{projectId}/policies/_view

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< PolicyView > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get all PolicyDeviceStatus by project

GET /papis/v1/projects/{projectId}/policies/_violations

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< PolicyDeviceStatus > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Search policy events for policy ids V2

POST /papis/v1/projects/{projectId}/policies/v2/_search

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

endDate
optional

endDate

string

Query

format
required

enum (csv)

"csv"

Query

policyId
required

policyId

< integer (int64) > array(multi)

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • policies

Search policy events for policy ids V2

GET /papis/v1/projects/{projectId}/policies/v2/_search

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

endDate
optional

endDate

string

Query

format
required

enum (csv)

"csv"

Query

policyId
required

policyId

< integer (int64) > array(multi)

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • policies

Get policy views by metric type

GET /papis/v1/projects/{projectId}/policies/{metricType}/_view

Parameters

Type Name Description Schema

Path

metricType
required

metricType

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< PolicyView > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get policy

GET /papis/v1/projects/{projectId}/policies/{policyId}

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Policy

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Update policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

policy
required

policy

Policy

Responses

HTTP Code Description Schema

200

OK

Policy

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get available beacons

GET /papis/v1/projects/{projectId}/policies/{policyId}/_availableBeacons

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Beacon > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get available blufis

GET /papis/v1/projects/{projectId}/policies/{policyId}/_availableBlufis

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Blufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get available blufis in Geofence

GET /papis/v1/projects/{projectId}/policies/{policyId}/_availableGeofenceBlufi

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< BlufiLite > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Reset individual beacon condition models

POST /papis/v1/projects/{projectId}/policies/{policyId}/_resetConditionModels

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Reset motion condition models

PUT /papis/v1/projects/{projectId}/policies/{policyId}/_resetConditionModels

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Add ambient beacons to policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}/ambientbeacons/_add

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Remove ambient beacons from policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}/ambientbeacons/_remove

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Add anchor blufis to policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}/anchorblufis/_add

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Remove anchor blufis from policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}/anchorblufis/_remove

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get policies for beacon

GET /papis/v1/projects/{projectId}/policies/{policyId}/beacons

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Update policies for beacon

PUT /papis/v1/projects/{projectId}/policies/{policyId}/beacons

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

beaconIds

< string > array

Responses

HTTP Code Description Schema

200

OK

< SimpleDevice > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Add beacons to policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}/beacons/_add

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Remove beacons from policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}/beacons/_remove

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

beaconIds
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get policies for blufi

GET /papis/v1/projects/{projectId}/policies/{policyId}/blufis

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Update policies for blufi

PUT /papis/v1/projects/{projectId}/policies/{policyId}/blufis

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

< SimpleDevice > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Add blufis to policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}/blufis/_add

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Remove blufis from policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}/blufis/_remove

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get policy events

GET /papis/v1/projects/{projectId}/policies/{policyId}/events

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

TokenPageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get policy events paged

POST /papis/v1/projects/{projectId}/policies/{policyId}/events/_query

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

query
required

query

TokenPageQuery

Responses

HTTP Code Description Schema

200

OK

TokenPageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Update policy label values

PUT /papis/v1/projects/{projectId}/policies/{policyId}/labelValues

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

labelValueIds
required

labelValueIds

< integer (int64) > 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get SMSs for projectId/policyId

GET /papis/v1/projects/{projectId}/policies/{policyId}/sms

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Sms > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Update sms for projectId/policyId

PUT /papis/v1/projects/{projectId}/policies/{policyId}/sms

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

smsIds
required

smsIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

< Sms > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get policy violations for policy

GET /papis/v1/projects/{projectId}/policies/{policyId}/violations

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< PolicyViolation > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Clear policy violations

DELETE /papis/v1/projects/{projectId}/policies/{policyId}/violations

Parameters

Type Name Description Schema

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get device policy violation

GET /papis/v1/projects/{projectId}/policies/{policyId}/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Path

policyId
required

policyId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

PolicyStateChangeEvent

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get policy event details using event uuid

GET /papis/v1/projects/{projectId}/policyevents/{eventUuid}

Parameters

Type Name Description Schema

Path

eventUuid
required

eventUuid

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

PolicyEventDetail

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Get all products

GET /papis/v1/projects/{projectId}/products

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Product > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • product

Request products

PUT /papis/v1/projects/{projectId}/products

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

product
required

product

Product

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • product

Add rcm data

PUT /papis/v1/projects/{projectId}/rcm

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

data
required

data

< RCMPacket > 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Get rcm imports by project

GET /papis/v1/projects/{projectId}/rcm/imports

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< RcmImport > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Apply rcm imports by id

POST /papis/v1/projects/{projectId}/rcm/imports/_apply

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

from
optional

from

integer (int64)

Query

rcmImportIds
optional

rcmImportIds

< integer (int64) > array(multi)

Query

to
optional

to

integer (int64)

Responses

HTTP Code Description Schema

200

OK

integer (int32)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Apply rcm imports by id

GET /papis/v1/projects/{projectId}/rcm/imports/_apply

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

from
optional

from

integer (int64)

Query

rcmImportIds
optional

rcmImportIds

< integer (int64) > array(multi)

Query

to
optional

to

integer (int64)

Responses

HTTP Code Description Schema

200

OK

integer (int32)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Delete rcm imports by id

GET /papis/v1/projects/{projectId}/rcm/imports/_bulkDelete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

from
optional

from

integer (int64)

Query

rcmImportIds
optional

rcmImportIds

< integer (int64) > array(multi)

Query

to
optional

to

integer (int64)

Responses

HTTP Code Description Schema

200

OK

integer (int32)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Delete rcm imports by id

DELETE /papis/v1/projects/{projectId}/rcm/imports/_bulkDelete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

from
optional

from

integer (int64)

Query

rcmImportIds
optional

rcmImportIds

< integer (int64) > array(multi)

Query

to
optional

to

integer (int64)

Responses

HTTP Code Description Schema

200

OK

integer (int32)

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Get rcm import by id

GET /papis/v1/projects/{projectId}/rcm/imports/{rcmImportId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

rcmImportId
required

rcmImportId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

RcmImport

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Delete rcm import by id

DELETE /papis/v1/projects/{projectId}/rcm/imports/{rcmImportId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

rcmImportId
required

rcmImportId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Add rcm data two

PUT /papis/v1/projects/{projectId}/rcm2

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

rcmMessage
required

rcmMessage

RCMMessage

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Add raw rcm data

PUT /papis/v1/projects/{projectId}/rcmraw

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

msg
required

msg

RCMRawMessage

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • rcm

Get device registry

GET /papis/v1/projects/{projectId}/registry/devices

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

deviceId
optional

deviceId

string

"%"

Query

deviceType
optional

deviceType

string

"%"

Query

mac
optional

mac

string

"%"

Query

major
optional

major

string

"%"

Query

minor
optional

minor

string

"%"

Query

name
optional

name

string

"%"

Query

uuid
optional

uuid

string

"%"

Responses

HTTP Code Description Schema

200

OK

< DeviceRegistry > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceRegistry

Create remote consumer config

POST /papis/v1/projects/{projectId}/remoteConsumerConfigs

Parameters

Type Name Description Schema

Body

config
required

config

RemoteConsumerConfig

Responses

HTTP Code Description Schema

200

OK

RemoteConsumerConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteConsumerConfig

Get all remote consumer configs

GET /papis/v1/projects/{projectId}/remoteConsumerConfigs

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< RemoteConsumerConfigView > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteConsumerConfig

Delete remote consumer config

PUT /papis/v1/projects/{projectId}/remoteConsumerConfigs/_delete

Parameters

Type Name Description Schema

Body

configIds
required

configIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteConsumerConfig

Get remote consumer configs

GET /papis/v1/projects/{projectId}/remoteConsumerConfigs/{configId}

Parameters

Type Name Description Schema

Path

configId
required

configId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

RemoteConsumerConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteConsumerConfig

Update remote consumer config

PUT /papis/v1/projects/{projectId}/remoteConsumerConfigs/{configId}

Parameters

Type Name Description Schema

Body

config
required

config

RemoteConsumerConfig

Responses

HTTP Code Description Schema

200

OK

RemoteConsumerConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteConsumerConfig

Create remote storage config

POST /papis/v1/projects/{projectId}/remoteStorageConfigs

Parameters

Type Name Description Schema

Body

config
required

config

RemoteStorageConfig

Responses

HTTP Code Description Schema

200

OK

RemoteStorageConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteStorageConfig

Get all remote storage configs

GET /papis/v1/projects/{projectId}/remoteStorageConfigs

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< RemoteStorageConfigView > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteStorageConfig

Delete remote storage config

PUT /papis/v1/projects/{projectId}/remoteStorageConfigs/_delete

Parameters

Type Name Description Schema

Body

configIds
required

configIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteStorageConfig

Get remote storage configs

GET /papis/v1/projects/{projectId}/remoteStorageConfigs/{configId}

Parameters

Type Name Description Schema

Path

configId
required

configId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

RemoteStorageConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteStorageConfig

Update remote storage config

PUT /papis/v1/projects/{projectId}/remoteStorageConfigs/{configId}

Parameters

Type Name Description Schema

Body

config
required

config

RemoteStorageConfig

Responses

HTTP Code Description Schema

200

OK

RemoteStorageConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • remoteStorageConfig

Get project RtlsSetting

GET /papis/v1/projects/{projectId}/rtlsSetting

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

download
optional

download

boolean

"false"

Responses

HTTP Code Description Schema

200

OK

RtlsSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Update Project Rtls Setting

PUT /papis/v1/projects/{projectId}/rtlsSetting

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

rtlsSetting
required

rtlsSetting

RtlsSetting

Responses

HTTP Code Description Schema

200

OK

RtlsSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Stream save asset selfie

POST /papis/v1/projects/{projectId}/selfies/assets/{assetId}

Parameters

Type Name Description Schema

Path

assetId
required

assetId

integer (int64)

FormData

image
required

image

file

FormData

selfieInfo
required

selfieInfo

string

Responses

HTTP Code Description Schema

200

OK

DeviceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • */*

Tags

  • deviceSelfie

Stream save beacon selfie

POST /papis/v1/projects/{projectId}/selfies/beacons/stream/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

FormData

image
required

image

file

FormData

selfieInfo
required

selfieInfo

string

Responses

HTTP Code Description Schema

200

OK

DeviceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • */*

Tags

  • deviceSelfie

Update beacon selfie

PUT /papis/v1/projects/{projectId}/selfies/beacons/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Body

selfie
required

selfie

DeviceSelfie

Responses

HTTP Code Description Schema

200

OK

DeviceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceSelfie

Stream save blufi selfie

POST /papis/v1/projects/{projectId}/selfies/blufis/stream/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

FormData

image
required

image

file

FormData

selfieInfo
required

selfieInfo

string

Responses

HTTP Code Description Schema

200

OK

DeviceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • */*

Tags

  • deviceSelfie

Update blufi selfie

PUT /papis/v1/projects/{projectId}/selfies/blufis/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

integer (int64)

Body

selfie
required

selfie

DeviceSelfie

Responses

HTTP Code Description Schema

200

OK

DeviceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceSelfie

Update workplace selfie

PUT /papis/v1/projects/{projectId}/selfies/workplaces/{workplaceId}

Parameters

Type Name Description Schema

Path

workplaceId
required

workplaceId

integer (int64)

Body

selfie
required

selfie

WorkplaceSelfie

Responses

HTTP Code Description Schema

200

OK

WorkplaceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplaceSelfie

Get workplace selfie

GET /papis/v1/projects/{projectId}/selfies/workplaces/{workplaceSelfieId}

Parameters

Type Name Description Schema

Path

workplaceSelfieId
required

workplaceSelfieId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

WorkplaceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplaceSelfie

Get device selfie

GET /papis/v1/projects/{projectId}/selfies/{deviceSelfieId}

Parameters

Type Name Description Schema

Path

deviceSelfieId
required

deviceSelfieId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

DeviceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • deviceSelfie

Update a projects show intro flag

PUT /papis/v1/projects/{projectId}/showIntro

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

status
required

status

BooleanStatus

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Find tags by project id

GET /papis/v1/projects/{projectId}/tags

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Tag > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • tags

Get all additional features and their status for target team invitation

GET /papis/v1/projects/{projectId}/team/features/invitations/{teamInvitationId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

teamInvitationId
required

teamInvitationId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< ConfigurableFeature > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamFeatures

Get all additional features provision-able by requester

GET /papis/v1/projects/{projectId}/team/features/me

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< ConfigurableFeature > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamFeatures

Get the features available to be enabled for this team member.

GET /papis/v1/projects/{projectId}/team/features/members/{teamMemberId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

teamMemberId
required

teamMemberId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< ConfigurableFeature > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamFeatures

Find TeamMemberInvitation objects (still pending) by project id

GET /papis/v1/projects/{projectId}/team/invitations

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< TeamInvitation > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamInvitations

Create invitation for a team member

POST /papis/v1/projects/{projectId}/team/invitations/_invite

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

teamInvitation
required

teamInvitation

TeamInvitation

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamInvitations

Resend a TeamMember invitation email

POST /papis/v1/projects/{projectId}/team/invitations/_resend

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

teamInvitation
required

teamInvitation

TeamInvitation

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamInvitations

Remove a team invitation by token

DELETE /papis/v1/projects/{projectId}/team/invitations/{token}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

token
required

token

string

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamInvitations

Find TeamMember objects by project id

GET /papis/v1/projects/{projectId}/team/members

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< TeamMember > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamMembers

Change permissions for a team member

POST /papis/v1/projects/{projectId}/team/members/{teamMemberId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

teamMemberId
required

teamMemberId

integer (int64)

Body

updateTeamMemberRequest
required

updateTeamMemberRequest

UpdateTeamMemberRequest

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamMembers

Remove a team member

DELETE /papis/v1/projects/{projectId}/team/members/{teamMemberId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

teamMemberId
required

teamMemberId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamMembers

Change role for a team member

PUT /papis/v1/projects/{projectId}/team/members/{teamMemberId}/role

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

teamMemberId
required

teamMemberId

integer (int64)

Body

teamMemberType
required

teamMemberType

enum (ROLE_ADMIN, ROLE_USER)

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamMembers

Get all additional products and their status for target team invitation

GET /papis/v1/projects/{projectId}/team/products/invitations/{teamInvitationId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

teamInvitationId
required

teamInvitationId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Product > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamProducts

Get all additional products provision-able by requester

GET /papis/v1/projects/{projectId}/team/products/me

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Product > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamProducts

Get the products available to be enabled for this team member.

GET /papis/v1/projects/{projectId}/team/products/members/{teamMemberId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

teamMemberId
required

teamMemberId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Product > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • teamProducts

Create third party gateway

POST /papis/v1/projects/{projectId}/thirdPartyDevices/gateways

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

thirdPartyGateway
required

thirdPartyGateway

ThirdPartyGatewayUpdate

Responses

HTTP Code Description Schema

200

OK

ThirdPartyGateway

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Get third party gateways

GET /papis/v1/projects/{projectId}/thirdPartyDevices/gateways

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< ThirdPartyGateway > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Delete third party gateways

DELETE /papis/v1/projects/{projectId}/thirdPartyDevices/gateways/_bulkDelete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

deviceIds
required

deviceIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Get third party gateway

GET /papis/v1/projects/{projectId}/thirdPartyDevices/gateways/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

ThirdPartyGateway

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Update third party gateway

PUT /papis/v1/projects/{projectId}/thirdPartyDevices/gateways/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Path

projectId
required

projectId

integer (int64)

Body

thirdPartyGateway
required

thirdPartyGateway

ThirdPartyGatewayUpdate

Responses

HTTP Code Description Schema

200

OK

ThirdPartyGateway

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Create third party iBeacon

POST /papis/v1/projects/{projectId}/thirdPartyDevices/iBeacons

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

thirdPartyIBeacon
required

thirdPartyIBeacon

ThirdPartyIBeacon

Responses

HTTP Code Description Schema

200

OK

ThirdPartyIBeacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Get third party iBeacons

GET /papis/v1/projects/{projectId}/thirdPartyDevices/iBeacons

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< ThirdPartyIBeacon > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Delete third party iBeacons

DELETE /papis/v1/projects/{projectId}/thirdPartyDevices/iBeacons/_bulkClear

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

thirdPartyIBeaconIds
required

thirdPartyIBeaconIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Get third party iBeacon

GET /papis/v1/projects/{projectId}/thirdPartyDevices/iBeacons/{thirdPartyIbeaconId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

thirdPartyIbeaconId
required

thirdPartyIbeaconId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

ThirdPartyIBeacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Update third party iBeacon

PUT /papis/v1/projects/{projectId}/thirdPartyDevices/iBeacons/{thirdPartyIbeaconId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

thirdPartyIbeaconId
required

thirdPartyIbeaconId

integer (int64)

Body

thirdPartyIBeacon
required

thirdPartyIBeacon

ThirdPartyIBeacon

Responses

HTTP Code Description Schema

200

OK

ThirdPartyIBeacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • thirdPartyDevices

Assign beacons in tray to project/template/location

PUT /papis/v1/projects/{projectId}/tray/{trayId}/_assign

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

trayId
required

trayId

string

Query

locationId
required

locationId

integer (int64)

Query

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

TrayCreateResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • trays

Get all policy violations

GET /papis/v1/projects/{projectId}/violations

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

namespace
optional

namespace

string

Responses

HTTP Code Description Schema

200

OK

< PolicyViolation > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • projects

Clear project violations

DELETE /papis/v1/projects/{projectId}/violations

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Clear project policy violations

DELETE /papis/v1/projects/{projectId}/violations/_bulkClear

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

policyViolations
required

policyViolations

< PolicyViolationDevice > 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • policies

Create a list of virtual blufis

POST /papis/v1/projects/{projectId}/virtualBlufis

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

virtualBlufis
required

virtualBlufis

< VirtualBlufi > array

Responses

HTTP Code Description Schema

200

OK

< VirtualBlufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Update a virtual blufi entity

PUT /papis/v1/projects/{projectId}/virtualBlufis

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

virtualBlufi
required

virtualBlufi

VirtualBlufi

Responses

HTTP Code Description Schema

200

OK

VirtualBlufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Assign a virtual blufi to register a blufi

POST /papis/v1/projects/{projectId}/virtualBlufis/_assign

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

virtualBlufiAssignRequest
required

virtualBlufiAssignRequest

VirtualBlufiAssignRequest

Responses

HTTP Code Description Schema

200

OK

VirtualBlufiAssignResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Bulk upload a list of virtual blufis

POST /papis/v1/projects/{projectId}/virtualBlufis/_bulkUpload

Parameters

Type Name Description Schema Default

Path

projectId
required

projectId

integer (int64)

Query

locationId
optional

locationId

integer (int64)

Query

powerSourceType
optional

powerSourceType

enum (UNKNOWN, AC, DC, POE)

"UNKNOWN"

Query

templateId
optional

templateId

integer (int64)

FormData

file
required

file

file

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • multipart/form-data

Produces

  • */*

Tags

  • virtualBlufis

Get information of a virtual blufis import job

GET /papis/v1/projects/{projectId}/virtualBlufis/_bulkUploadStatus

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

VirtualBlufiUploadJob

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Create virtual blufis from blufis by id

POST /papis/v1/projects/{projectId}/virtualBlufis/_cloneBlufiById

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< integer (int64) > array

Responses

HTTP Code Description Schema

200

OK

< VirtualBlufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Create virtual blufis from blufis by sid64

POST /papis/v1/projects/{projectId}/virtualBlufis/_cloneBlufiBySid64

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

blufiIds
required

blufiIds

< string > array

Responses

HTTP Code Description Schema

200

OK

< VirtualBlufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Bulk delete a list of virtual blufis

PUT /papis/v1/projects/{projectId}/virtualBlufis/_delete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

ids
required

ids

< string > array

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Get a virtual blufi

GET /papis/v1/projects/{projectId}/virtualBlufis/{virtualBlufiId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

virtualBlufiId
required

virtualBlufiId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

VirtualBlufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Delete a virtual blufi

DELETE /papis/v1/projects/{projectId}/virtualBlufis/{virtualBlufiId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

virtualBlufiId
required

virtualBlufiId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Create a virtual blufi log

POST /papis/v1/projects/{projectId}/virtualBlufis/{virtualBlufiId}/log

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

virtualBlufiId
required

virtualBlufiId

integer (int64)

Body

virtualBlufiLog
required

virtualBlufiLog

VirtualBlufiLog

Responses

HTTP Code Description Schema

200

OK

VirtualBlufiLog

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Get a list virtual blufi logs by project and virtual blufi

GET /papis/v1/projects/{projectId}/virtualBlufis/{virtualBlufiId}/log

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

virtualBlufiId
required

virtualBlufiId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< VirtualBlufiLog > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • virtualBlufis

Create webhook

POST /papis/v1/projects/{projectId}/webhook

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

webhook
required

webhook

Webhook

Responses

HTTP Code Description Schema

200

OK

Webhook

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • webhooks

Get webhook

GET /papis/v1/projects/{projectId}/webhook

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Webhook

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • webhooks

Update webhook

PUT /papis/v1/projects/{projectId}/webhook

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

webhook
required

webhook

Webhook

Responses

HTTP Code Description Schema

200

OK

Webhook

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • webhooks

Delete webhook

DELETE /papis/v1/projects/{projectId}/webhook

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • webhooks

Disable webhook

PUT /papis/v1/projects/{projectId}/webhook/_disable

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • webhooks

Enable webhook

PUT /papis/v1/projects/{projectId}/webhook/_enable

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • webhooks

Test webhook

PUT /papis/v1/projects/{projectId}/webhook/_test

Parameters

Type Name Description Schema

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • webhooks

Create WifiScanReportPlan

POST /papis/v1/projects/{projectId}/wifiScanReportPlans

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

wifiScanReportPlan
required

wifiScanReportPlan

WifiScanReportPlan

Responses

HTTP Code Description Schema

200

OK

WifiScanReportPlan

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Get WifiScanReportPlans

GET /papis/v1/projects/{projectId}/wifiScanReportPlans

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< WifiScanReportPlan > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Run WifiScanReports

PUT /papis/v1/projects/{projectId}/wifiScanReportPlans/_runReports

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

request
required

request

WifiScanRunReportRequest

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Get WifiScanReportPlan

GET /papis/v1/projects/{projectId}/wifiScanReportPlans/{planId}

Parameters

Type Name Description Schema

Path

planId
required

planId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

WifiScanReportPlan

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Update WifiScanReportPlan

PUT /papis/v1/projects/{projectId}/wifiScanReportPlans/{planId}

Parameters

Type Name Description Schema

Path

planId
required

planId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Body

wifiScanReportPlan
required

wifiScanReportPlan

WifiScanReportPlan

Responses

HTTP Code Description Schema

200

OK

WifiScanReportPlan

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Delete WifiScanReportPlan

DELETE /papis/v1/projects/{projectId}/wifiScanReportPlans/{planId}

Parameters

Type Name Description Schema

Path

planId
required

planId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Get WifiScanReportsByPlan

GET /papis/v1/projects/{projectId}/wifiScanReportPlans/{planId}/_reports

Parameters

Type Name Description Schema

Path

planId
required

planId

integer (int64)

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< WifiScanReport > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Delete WifiScanReportsByPlan

DELETE /papis/v1/projects/{projectId}/wifiScanReportPlans/{planId}/_reports

Parameters

Type Name Description Schema

Path

planId
required

planId

integer (int64)

Path

projectId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Get WifiScanReports

GET /papis/v1/projects/{projectId}/wifiScanReports

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< WifiScanReport > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Search WifiScanReports

GET /papis/v1/projects/{projectId}/wifiScanReports/_search

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Query

endDate
optional

endDate

string

Query

forDate
optional

forDate

string

Query

metricType
optional

metricType

string

Query

planId
optional

planId

integer (int64)

Query

reportType
optional

reportType

string

Query

startDate
optional

startDate

string

Responses

HTTP Code Description Schema

200

OK

< WifiScanReport > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

View WifiScanReport

GET /papis/v1/projects/{projectId}/wifiScanReports/_view/{reportId}/{fileName}

Parameters

Type Name Description Schema

Path

fileName
required

fileName

string

Path

projectId
required

projectId

integer (int64)

Path

reportId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Get WifiScanReport

GET /papis/v1/projects/{projectId}/wifiScanReports/{reportId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

reportId
required

reportId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

WifiScanReport

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Delete WifiScanReport

DELETE /papis/v1/projects/{projectId}/wifiScanReports/{reportId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

reportId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiScanReports

Create a WorkZoneBlufi

POST /papis/v1/projects/{projectId}/workZoneBlufis

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

workZoneBlufi
required

workZoneBlufi

WorkZoneBlufi

Responses

HTTP Code Description Schema

200

OK

WorkZoneBlufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workZoneBlufi

Get WorkZoneBlufis for project

GET /papis/v1/projects/{projectId}/workZoneBlufis

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< WorkZoneBlufi > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workZoneBlufi

Delete WorkZoneBlufis by supplied ids

PUT /papis/v1/projects/{projectId}/workZoneBlufis/_delete

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

workZoneBlufiIds
required

workZoneBlufiIds

< 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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workZoneBlufi

Get a WorkZoneBlufi

GET /papis/v1/projects/{projectId}/workZoneBlufis/{workZoneBlufiId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workZoneBlufiId
required

workZoneBlufiId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

WorkZoneBlufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workZoneBlufi

Update a WorkZoneBlufi

PUT /papis/v1/projects/{projectId}/workZoneBlufis/{workZoneBlufiId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workZoneBlufiId
required

workZoneBlufiId

integer (int64)

Body

workZoneBlufi
required

workZoneBlufi

WorkZoneBlufi

Responses

HTTP Code Description Schema

200

OK

WorkZoneBlufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workZoneBlufi

Create a Workplace

POST /papis/v1/projects/{projectId}/workplaces

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Body

workplace
required

workplace

Workplace

Responses

HTTP Code Description Schema

200

OK

Workplace

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplace

Get All Workplaces for Project

GET /papis/v1/projects/{projectId}/workplaces

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Workplace > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplace

Get a Workplace

GET /papis/v1/projects/{projectId}/workplaces/{workplaceId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Workplace

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplace

Update a Workplace

PUT /papis/v1/projects/{projectId}/workplaces/{workplaceId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Body

workplace
required

workplace

Workplace

Responses

HTTP Code Description Schema

200

OK

Workplace

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplace

Delete a Workplace

DELETE /papis/v1/projects/{projectId}/workplaces/{workplaceId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplace

Get available locations by workplace

GET /papis/v1/projects/{projectId}/workplaces/{workplaceId}/_getAvailableLocations

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Location > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplace

Get available policies by workplace

GET /papis/v1/projects/{projectId}/workplaces/{workplaceId}/_getAvailablePolicies

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Policy > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplace

Get all zones in a workplace

GET /papis/v1/projects/{projectId}/workplaces/{workplaceId}/_zones

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Zone > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • workplace

Create a WpoLocation

POST /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Body

wpoLocation
required

wpoLocation

WpoLocation

Responses

HTTP Code Description Schema

200

OK

WpoLocation

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoLocation

Get All WpoLocations for Workplace

GET /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< WpoLocation > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoLocation

Get a WpoLocation

GET /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations/{wpoLocationId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Path

wpoLocationId
required

wpoLocationId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

WpoLocation

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoLocation

Update a WpoLocation

PUT /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations/{wpoLocationId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Path

wpoLocationId
required

wpoLocationId

integer (int64)

Body

wpoLocation
required

wpoLocation

WpoLocation

Responses

HTTP Code Description Schema

200

OK

WpoLocation

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoLocation

Delete a WpoLocation

DELETE /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations/{wpoLocationId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Path

wpoLocationId
required

wpoLocationId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoLocation

Create a Zone

POST /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations/{wpoLocationId}/zones

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Path

wpoLocationId
required

wpoLocationId

integer (int64)

Body

wpoZone
required

wpoZone

Zone

Responses

HTTP Code Description Schema

200

OK

Zone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoZone

Get all Zones for Location

GET /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations/{wpoLocationId}/zones

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Path

wpoLocationId
required

wpoLocationId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Zone > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoZone

Get a Zone

GET /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations/{wpoLocationId}/zones/{zoneId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Path

wpoLocationId
required

wpoLocationId

integer (int64)

Path

zoneId
required

zoneId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Zone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoZone

Update a Zone

PUT /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations/{wpoLocationId}/zones/{zoneId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Path

wpoLocationId
required

wpoLocationId

integer (int64)

Path

zoneId
required

zoneId

integer (int64)

Body

wpoZone
required

wpoZone

Zone

Responses

HTTP Code Description Schema

200

OK

Zone

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoZone

Delete a Zone

DELETE /papis/v1/projects/{projectId}/workplaces/{workplaceId}/wpoLocations/{wpoLocationId}/zones/{zoneId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

workplaceId
required

workplaceId

integer (int64)

Path

wpoLocationId
required

wpoLocationId

integer (int64)

Path

zoneId
required

zoneId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wpoZone

Get Beacon Config view csv

GET /papis/v1/reports/devices/beacons/configuration

Parameters

Type Name Schema Default

Query

format
required

enum (csv)

"csv"

Responses

HTTP Code Description Schema

200

OK

CSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • text/csv

Tags

  • reports

View RTLS history report

GET /papis/v1/reports/projects/{projectId}/history/rtls/{reportId}

Parameters

Type Name Description Schema

Path

projectId
required

projectId

integer (int64)

Path

reportId
required

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • reports

Create tag

POST /papis/v1/tags

Parameters

Type Name Description Schema

Body

tag
optional

tag

Tag

Responses

HTTP Code Description Schema

200

OK

Tag

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • tags

Get tags

GET /papis/v1/tags

Parameters

Type Name Description Schema Default

Query

value
optional

value

string

"%"

Responses

HTTP Code Description Schema

200

OK

< Tag > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • tags

Validate a uuid

GET /papis/v1/validations/uuid

Parameters

Type Name Description Schema

Query

uuidValue
required

uuidValue

string

Responses

HTTP Code Description Schema

200

OK

Valid

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • validations

Get all wifi security types

GET /papis/v1/wifiSecurityTypes

Responses

HTTP Code Description Schema

200

OK

< WifiSecurityType > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiSecurityType

Get wifi security type

GET /papis/v1/wifiSecurityTypes/{key}

Parameters

Type Name Description Schema

Path

key
required

key

string

Responses

HTTP Code Description Schema

200

OK

WifiSecurityType

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • wifiSecurityType

Get beacon template tags

GET /sapis/v1/provisioning/beaconTemplates/{templateId}/tags

Parameters

Type Name Description Schema

Path

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Tag > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Register beacon

POST /sapis/v1/provisioning/beacons

Parameters

Type Name Description Schema Default

Query

bulkProvision
optional

bulkProvision

boolean

"false"

Query

encrKey
optional

encrKey

string

Query

skipDeviceJob
optional

skipDeviceJob

boolean

"false"

Query

timeout
optional

timeout

integer (int64)

Body

beacon
required

beacon

Beacon

Responses

HTTP Code Description Schema

200

OK

Beacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get beacon signal

POST /sapis/v1/provisioning/beacons/signal

Parameters

Type Name Description Schema

Body

beaconSignal
required

beaconSignal

BeaconBulkRequest

Responses

HTTP Code Description Schema

200

OK

BeaconSignalResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get provisioning beacon

GET /sapis/v1/provisioning/beacons/{beaconId}

Parameters

Type Name Description Schema

Path

beaconId
required

beaconId

string

Responses

HTTP Code Description Schema

200

OK

Beacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Update provisioning beacon

PUT /sapis/v1/provisioning/beacons/{deviceId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Body

beacon
required

beacon

Beacon

Responses

HTTP Code Description Schema

200

OK

Beacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get beacon selfie

GET /sapis/v1/provisioning/beacons/{deviceId}/selfie

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Responses

HTTP Code Description Schema

200

OK

DeviceSelfie

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get beacon selfie view

GET /sapis/v1/provisioning/beacons/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Delete beacon selfie

DELETE /sapis/v1/provisioning/beacons/{deviceId}/selfies/{deviceSelfieId}

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Path

deviceSelfieId
required

deviceSelfieId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get beacon templates

GET /sapis/v1/provisioning/beacons/{deviceId}/templates

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

string

Responses

HTTP Code Description Schema

200

OK

< ViewDeviceTemplate > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get all blufi templates

GET /sapis/v1/provisioning/blufiTemplates

Responses

HTTP Code Description Schema

200

OK

< BlufiTemplate > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get blufi template scan mode

GET /sapis/v1/provisioning/blufiTemplates/{templateId}/scanMode

Parameters

Type Name Description Schema

Path

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

SystemScanMode

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get blufi template sleep schedule

GET /sapis/v1/provisioning/blufiTemplates/{templateId}/sleepSchedule

Parameters

Type Name Description Schema

Path

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

BlufiSleepSchedule

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get blufi template tags

GET /sapis/v1/provisioning/blufiTemplates/{templateId}/tags

Parameters

Type Name Description Schema

Path

templateId
required

templateId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

< Tag > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get blufi selfie view

GET /sapis/v1/provisioning/blufis/{deviceId}/selfie/_view

Parameters

Type Name Description Schema

Path

deviceId
required

deviceId

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
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get blufi status by id

GET /sapis/v1/provisioning/blufis/{sid64}

Parameters

Type Name Description Schema

Path

sid64
required

sid64

string

Responses

HTTP Code Description Schema

200

OK

Blufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Update blufi

PUT /sapis/v1/provisioning/blufis/{sid64}

Parameters

Type Name Description Schema

Path

sid64
required

sid64

string

Body

blufi
required

blufi

Blufi

Responses

HTTP Code Description Schema

200

OK

Blufi

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get all system scan modes

GET /sapis/v1/provisioning/systemScanModes

Responses

HTTP Code Description Schema

200

OK

< SystemScanMode > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Start transaction

POST /sapis/v1/provisioning/transactions

Parameters

Type Name Description Schema

Header

User-Agent
required

User-Agent

string

Body

transaction
required

transaction

ProvisionTransaction

Responses

HTTP Code Description Schema

200

OK

ProvisionTransaction

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Start Blufi Recovery Transaction

POST /sapis/v1/provisioning/transactions/_blufiRecovery

Parameters

Type Name Description Schema

Header

User-Agent
required

User-Agent

string

Body

transaction
required

transaction

ProvisionTransaction

Responses

HTTP Code Description Schema

200

OK

ProvisionTransaction

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get transaction

GET /sapis/v1/provisioning/transactions/{transactionId}

Parameters

Type Name Description Schema

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

ProvisionTransaction

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Acknowledge command

POST /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}

Parameters

Type Name Description Schema

Path

seq
required

seq

string

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

AckCommand

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Acknowledge command

GET /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}

Parameters

Type Name Description Schema

Path

seq
required

seq

string

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

AckCommand

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Acknowledge command

PUT /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}

Parameters

Type Name Description Schema

Path

seq
required

seq

string

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

AckCommand

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Acknowledge command

DELETE /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}

Parameters

Type Name Description Schema

Path

seq
required

seq

string

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

AckCommand

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Acknowledge command

PATCH /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}

Parameters

Type Name Description Schema

Path

seq
required

seq

string

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

AckCommand

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Acknowledge command

HEAD /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}

Parameters

Type Name Description Schema

Path

seq
required

seq

string

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

AckCommand

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Acknowledge command

OPTIONS /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}

Parameters

Type Name Description Schema

Path

seq
required

seq

string

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

AckCommand

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Cancel transaction

PUT /sapis/v1/provisioning/transactions/{transactionId}/cancel

Parameters

Type Name Description Schema

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

ProvisionTransaction

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Setup encryption

POST /sapis/v1/provisioning/transactions/{transactionId}/setup

Parameters

Type Name Description Schema

Path

transactionId
required

transactionId

integer (int64)

Body

setup
required

setup

EncryptionSetup

Responses

HTTP Code Description Schema

200

OK

EncryptionResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Get transaction status

GET /sapis/v1/provisioning/transactions/{transactionId}/status

Parameters

Type Name Description Schema

Path

transactionId
required

transactionId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Status

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Bind beacon

GET /sapis/v1/provisioning/virtualDevices/{virtualDeviceId}/beacon/{id64}

Parameters

Type Name Description Schema

Path

id64
required

id64

string

Path

virtualDeviceId
required

virtualDeviceId

integer (int64)

Responses

HTTP Code Description Schema

200

OK

Beacon

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

500

Server Error
Headers :
X-BZ-Error (string)
X-BZ-SysMsg (string)
X-BZ-ErrorMessage (string)

ErrorMessage

Consumes

  • application/json

Produces

  • */*

Tags

  • provisioning

Definitions

AbstractAdvancedAdapter

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

AbstractPacket

Name Schema

adapterId
optional

string

adapterType
optional

string

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

AccelReadConfig

Name Schema

durationMillis
optional

integer (int64)

filteringFactor
optional

number (float)

filteringType
optional

enum (HIGH_PASS, LOW_PASS, MEDIAN, NONE)

fullScale
optional

integer (int32)

medianWindowSize
optional

integer (int32)

rateIndex
optional

integer (int32)

requireMovement
optional

boolean

summaryMillis
optional

integer (int64)

Account

Name Schema

accountId
optional

integer (int64)

authProvider
optional

string

dateCreated
optional

integer (int64)

dateFormat
optional

string

dateTosAccepted
optional

integer (int64)

dateUpdated
optional

integer (int64)

email
optional

string

landingPage
optional

string

language
optional

string

password
optional

string

roles
optional

< Role > array

temperatureFormat
optional

string

timezone
optional

string

username
optional

string

vibrationAccelerationFormat
optional

string

vibrationVelocityFormat
optional

string

AccountContext

Name Schema

accountId
optional

integer (int64)

cloudHost
optional

string

dateFormat
optional

string

email
optional

string

enableDebugExceptions
optional

boolean

features
optional

< string > array

forceEmailValidation
optional

boolean

landingPage
optional

string

language
optional

string

products
optional

< string > array

projectId
optional

integer (int64)

projectMigratedEndpoint
optional

string

projectName
optional

string

roles
optional

< string > array

serviceProviderId
optional

integer (int64)

sessionToken
optional

string

showIntro
optional

boolean

staticEndpoint
optional

string

temperatureFormat
optional

string

timezone
optional

string

tosUpdateFlag
optional

boolean

username
optional

string

vibrationAccelerationFormat
optional

string

vibrationVelocityFormat
optional

string

AckCommand

Name Schema

gid
optional

string

seq
optional

string

Adapter

Name Schema

ad128bit
optional

string

ad128bitMore
optional

string

ad16bit
optional

string

ad16bitMore
optional

string

ad32bit
optional

string

ad32bitMore
optional

string

adFlags
optional

< < string > array > array

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

integer (int32)

adType
optional

string

bdId
optional

string

extraRssi
optional

< number (float) > array

gid
optional

string

macAddr
optional

integer (int64)

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

rssiNoiseSweep
optional

< number (float) > array

rssiSignalSweep
optional

< number (float) > array

seq
optional

integer (int32)

sweepId
optional

integer (int32)

timestamp
optional

integer (int64)

type
optional

string

AdvancedEddystoneTlm

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

batt
optional

integer (int32)

bdId
optional

string

frameCount
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

revision
optional

integer (int32)

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int64)

timestamp
optional

string

uptime
optional

integer (int32)

version
optional

string

AdvancedEddystoneUid

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

gid
optional

string

id
optional

string

instanceIdentifier
optional

string

measuredPower
optional

integer (int32)

namespaceIdentifier
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

AdvancedEddystoneUrl

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

gid
optional

string

id
optional

string

measuredPower
optional

integer (int32)

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

url
optional

string

version
optional

string

AdvancedHeartrate

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

bpm
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

AdvancedIBeacon

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

gid
optional

string

id
optional

string

major
optional

integer (int32)

measuredPower
optional

integer (int32)

minor
optional

integer (int32)

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

uuid
optional

string

version
optional

string

AdvancedMag

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

flags
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

xMag
optional

number (double)

yMag
optional

number (double)

zMag
optional

number (double)

AdvancedMotion

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

flags
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

AdvancedPacket

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adFlags
optional

< < string > array > array

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

battery
optional

integer (int32)

bdId
optional

string

bpm
optional

integer (int32)

eventCounter
optional

< integer (int32) > array

gid
optional

string

id
optional

string

lums
optional

integer (int32)

mac
optional

string

major
optional

integer (int32)

measuredPower
optional

integer (int32)

minor
optional

integer (int32)

motion
optional

< < string (byte) > array > array

packetType
optional

string

projectId
optional

integer (int64)

raw
optional

< integer (int32) > array

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

sdc
optional

integer (int32)

serverTimestamp
optional

integer (int64)

temp
optional

number (float)

time
optional

integer (int32)

timestamp
optional

string

txChn
optional

integer (int32)

txPower
optional

integer (int32)

type
optional

string

uuid
optional

string

version
optional

string

xAccel
optional

integer (int32)

yAccel
optional

integer (int32)

zAccel
optional

integer (int32)

AdvancedProbe

Name Schema

adapterId
optional

string

adapterType
optional

string

addr1
optional

string

addr2
optional

string

addr3
optional

string

channel
optional

integer (int32)

durationId
optional

integer (int32)

frameControl
optional

integer (int32)

gid
optional

string

id
optional

string

length
optional

integer (int32)

packetType
optional

string

projectId
optional

integer (int64)

rate
optional

integer (int32)

rssi
optional

integer (int32)

seq
optional

integer (int32)

ssid
optional

string

staticHash
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

ts
optional

integer (int64)

version
optional

string

AdvancedSBv2

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

battery
optional

integer (int32)

bdId
optional

string

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int64)

timestamp
optional

string

txChn
optional

integer (int32)

txPower
optional

integer (int32)

version
optional

string

AdvancedSLight

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

gid
optional

string

id
optional

string

lums
optional

integer (int32)

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

AdvancedSSns

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

battery
optional

integer (int32)

bdId
optional

string

eventCounter
optional

< integer (int32) > array

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

AdvancedSSnsNano

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

base
optional

integer (int32)

bdId
optional

string

deviceJobId
optional

integer (int64)

fullScale
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

sessionId
optional

string

time
optional

integer (int64)

timeNano
optional

integer (int64)

timestamp
optional

string

version
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

AdvancedSSnsSummary

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

adv
optional

boolean

bdId
optional

string

gid
optional

string

highRes
optional

boolean

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

started
optional

integer (int64)

temp
optional

number (double)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

xPeak
optional

number (double)

xPeakToPeak
optional

number (double)

xRms
optional

number (double)

xVPeak
optional

number (double)

xVPeakToPeak
optional

number (double)

xVRms
optional

number (double)

yPeak
optional

number (double)

yPeakToPeak
optional

number (double)

yRms
optional

number (double)

yVPeak
optional

number (double)

yVPeakToPeak
optional

number (double)

yVRms
optional

number (double)

zPeak
optional

number (double)

zPeakToPeak
optional

number (double)

zRms
optional

number (double)

zVPeak
optional

number (double)

zVPeakToPeak
optional

number (double)

zVRms
optional

number (double)

AdvancedSSpec

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

battery
optional

integer (int32)

bdId
optional

string

gid
optional

string

id
optional

string

motion
optional

< < string (byte) > array > array

packetType
optional

string

projectId
optional

integer (int64)

rssiCh
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

AdvancedTracking

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

extraRssi
optional

< number (double) > array

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

txChn
optional

integer (int32)

txPower
optional

integer (int32)

version
optional

string

AdvancedUnknown

Name Schema

ad128Bit
optional

string

ad128bBtMore
optional

string

ad16Bit
optional

string

ad16BitMore
optional

string

ad32Bit
optional

string

ad32BitMore
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

adapterId
optional

string

adapterType
optional

string

bdId
optional

string

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

raw
optional

< integer (int32) > array

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

AdvertisementPropertyWrapper

Name Schema

advData
optional

object

blufiId
optional

string

environment_name
optional

string

projectId
optional

integer (int64)

serverTimestamp
optional

integer (int64)

type
optional

string

Agent

Name Schema

accountId
optional

integer (int64)

hostname
optional

string

projectId
optional

integer (int64)

threadId
optional

integer (int64)

threadName
optional

string

userAgent
optional

string

username
optional

string

Aggregator

Name Schema

maxBufferSize
optional

integer (int32)

maxTimeInMs
optional

integer (int32)

AmbientBeacon

Name Schema

deviceId
optional

string

name
optional

string

ApiAccess

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

owner
optional

boolean

projectId
optional

integer (int64)

projectName
optional

string

token
optional

string

type
optional

string

Asset

Name Schema

assetId
optional

integer (int64)

beaconIds
optional

< string > array

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

name
optional

string

projectId
optional

integer (int64)

selfie
optional

DeviceSelfie

AssetTypeRtlsSetting

Name Schema

assetTypeRtlsSettingId
optional

integer (int64)

bucketMilliseconds
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enablePfrac
optional

boolean

pfracInitializationFrac
optional

number (float)

pfracInstMaxMarginThreshold
optional

number (float)

pfracMaxCurrentValueWeight
optional

number (float)

pfracMovAvgDecayRate
optional

number (float)

pfracMovAvgLowThreshold
optional

number (float)

pfracMovAvgMaxMarginThreshold
optional

number (float)

pfracTau
optional

number (float)

projectId
optional

integer (int64)

rtlsAssetType
optional

string

BaseDevice

Name Schema

altitude
optional

number (float)

autoLocationName
optional

string

bleFirmware
optional

Firmware

configuration
optional

BeaconTemplate

dateCreated
optional

integer (int64)

dateProvisioned
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

deviceType
optional

DeviceType

latitude
optional

number (double)

locationId
optional

integer (int64)

longitude
optional

number (double)

macAddress
optional

string

name
optional

string

notes
optional

string

projectId
optional

integer (int64)

scanData
optional

ScanData

selfie
optional

DeviceSelfie

status
optional

string

tags
optional

< Tag > array

virtualDeviceId
optional

integer (int64)

BasicEddystoneTlm

Name Schema

adapterId
optional

string

adapterType
optional

string

batt
optional

integer (int32)

frameCount
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

revision
optional

integer (int32)

rssi
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int64)

timestamp
optional

string

uptime
optional

integer (int32)

version
optional

string

BasicEddystoneUid

Name Schema

adapterId
optional

string

adapterType
optional

string

gid
optional

string

id
optional

string

instanceIdentifier
optional

string

measuredPower
optional

integer (int32)

namespaceIdentifier
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

BasicEddystoneUrl

Name Schema

adapterId
optional

string

adapterType
optional

string

gid
optional

string

id
optional

string

measuredPower
optional

integer (int32)

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

url
optional

string

version
optional

string

BasicHeartrate

Name Schema

adapterId
optional

string

adapterType
optional

string

bpm
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

BasicIBeacon

Name Schema

adapterId
optional

string

adapterType
optional

string

gid
optional

string

id
optional

string

major
optional

integer (int32)

measuredPower
optional

integer (int32)

minor
optional

integer (int32)

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

uuid
optional

string

version
optional

string

BasicMag

Name Schema

adapterId
optional

string

adapterType
optional

string

flags
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

xMag
optional

number (double)

yMag
optional

number (double)

zMag
optional

number (double)

BasicMotion

Name Schema

adapterId
optional

string

adapterType
optional

string

flags
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

BasicPacket

Name Schema

adapterId
optional

string

adapterType
optional

string

battery
optional

integer (int32)

eventCounter
optional

< integer (int32) > array

gid
optional

string

id
optional

string

lums
optional

integer (int32)

major
optional

integer (int32)

measuredPower
optional

integer (int32)

minor
optional

integer (int32)

packetType
optional

string

projectId
optional

integer (int64)

raw
optional

< integer (int32) > array

rssi
optional

integer (int32)

serverTimestamp
optional

integer (int64)

temp
optional

number (float)

time
optional

integer (int32)

timestamp
optional

string

type
optional

string

uuid
optional

string

version
optional

string

xAccel
optional

integer (int32)

yAccel
optional

integer (int32)

zAccel
optional

integer (int32)

BasicProbe

Name Schema

adapterId
optional

string

adapterType
optional

string

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

BasicSBv2

Name Schema

adapterId
optional

string

adapterType
optional

string

battery
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

BasicSLight

Name Schema

adapterId
optional

string

adapterType
optional

string

gid
optional

string

id
optional

string

lums
optional

integer (int32)

packetType
optional

string

projectId
optional

integer (int64)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

BasicSSns

Name Schema

adapterId
optional

string

adapterType
optional

string

battery
optional

integer (int32)

eventCounter
optional

< integer (int32) > array

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

temp
optional

number (float)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

BasicSSnsNano

Name Schema

adapterId
optional

string

adapterType
optional

string

base
optional

integer (int32)

deviceJobId
optional

integer (int64)

fullScale
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

sessionId
optional

string

time
optional

integer (int64)

timeNano
optional

integer (int64)

timestamp
optional

string

version
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

BasicSSnsSummary

Name Schema

adapterId
optional

string

adapterType
optional

string

adv
optional

boolean

gid
optional

string

highRes
optional

boolean

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

started
optional

integer (int64)

temp
optional

number (double)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

xPeak
optional

number (double)

xPeakToPeak
optional

number (double)

xRms
optional

number (double)

xVPeak
optional

number (double)

xVPeakToPeak
optional

number (double)

xVRms
optional

number (double)

yPeak
optional

number (double)

yPeakToPeak
optional

number (double)

yRms
optional

number (double)

yVPeak
optional

number (double)

yVPeakToPeak
optional

number (double)

yVRms
optional

number (double)

zPeak
optional

number (double)

zPeakToPeak
optional

number (double)

zRms
optional

number (double)

zVPeak
optional

number (double)

zVPeakToPeak
optional

number (double)

zVRms
optional

number (double)

BasicSSpec

Name Schema

adapterId
optional

string

adapterType
optional

string

battery
optional

integer (int32)

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

temp
optional

number (float)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

BasicTracking

Name Schema

adapterId
optional

string

adapterType
optional

string

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

rssi
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

BasicUnknown

Name Schema

adapterId
optional

string

adapterType
optional

string

gid
optional

string

id
optional

string

packetType
optional

string

projectId
optional

integer (int64)

raw
optional

< integer (int32) > array

rssi
optional

integer (int32)

time
optional

integer (int64)

timestamp
optional

string

version
optional

string

Beacon

Name Schema

accelReadInterval
optional

integer (int32)

accelReadRate
optional

integer (int32)

accelReadSummaryInterval
optional

integer (int32)

altitude
optional

number (float)

ambient
optional

boolean

assetMaterialType
optional

enum (HUMAN, METAL, BOX, ALL, DEFAULT, FAST, SLOW)

assetTrackAltitude
optional

number (float)

assetTrackLatitude
optional

number (double)

assetTrackLongitude
optional

number (double)

assetTrackable
optional

boolean

autoLocationName
optional

string

batteryVoltage
optional

integer (int64)

bleFirmware
optional

Firmware

blufi
optional

Blufi

calibrationRssiOffset
optional

number (double)

channelMigrationComplete
optional

boolean

conditionSummaryInterval
optional

integer (int32)

configData
optional

string

configType
optional

enum (CM, CM_AI, CM_AI_VELOCITY, CM_AV, CM_HIGH_SENSITIVITY, CM_LOW_POWER, CM_TRACKING, CM_TRACKING_LOW_POWER, DEFAULT, DEFAULT_LOW_POWER, LOGGING, PARKING, PANIC_BUTTON, TRACKING, TRACKING_LOW_POWER, TRACKING_ULTRA_LOW_POWER, TRACKING_CAL, TRACKING_CAL_LOW_POWER, TRACKING_IDENTITY, MLS, USER, DISTANCE_TRACKING, CM_TEMPERATURE_LOGGING)

configVersion
optional

integer (int32)

configuration
optional

BeaconTemplate

dateCreated
optional

integer (int64)

dateProvisioned
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

deviceType
optional

DeviceType

dynamicUrl
optional

string

effectiveFullScale
optional

integer (int32)

id64Hex
optional

string

identityEnabled
optional

boolean

labelValues
optional

< LabelValue > array

latitude
optional

number (double)

locationId
optional

integer (int64)

locations
optional

< Location > array

longitude
optional

number (double)

macAddress
optional

string

managerType
optional

string

metaData
optional

object

motionCalApplied
optional

integer (int32)

motionCalEnabled
optional

boolean

motionInterval
optional

number (double)

name
optional

string

notes
optional

string

onlineCalibrationReference
optional

boolean

parkingEnabled
optional

boolean

parkingStatusChange
optional

integer (int64)

parkingTrainingTimeInSec
optional

integer (int32)

projectId
optional

integer (int64)

rtlsUseSbv2
optional

boolean

scanData
optional

ScanData

scanDataMap
optional

BeaconScanData

selfie
optional

DeviceSelfie

sensorFlags
optional

integer (int64)

stats
optional

BeaconStats

status
optional

string

systemParkingTrainingTimeInSec
optional

integer (int32)

tags
optional

< Tag > array

templateId
optional

integer (int64)

templateName
optional

string

templateVersion
optional

integer (int32)

unixTimeOffset
optional

integer (int32)

virtualDeviceId
optional

integer (int64)

BeaconAccel

Name Schema

base
optional

integer (int32)

fullScale
optional

integer (int32)

mac
optional

string

timestamp
optional

integer (int64)

x
optional

integer (int32)

y
optional

integer (int32)

z
optional

integer (int32)

BeaconAccelEvent

Name Schema

entries
optional

< BeaconAccel > array

timeStamp
optional

integer (int64)

uuid
optional

string

BeaconAccelSummary

Name Schema

count
optional

integer (int32)

duration
optional

integer (int64)

mac
optional

string

tsEnd
optional

integer (int64)

tsStart
optional

integer (int64)

xPeak
optional

number (double)

xPeakPeak
optional

number (double)

xRms
optional

number (double)

yPeak
optional

number (double)

yPeakPeak
optional

number (double)

yRms
optional

number (double)

zPeak
optional

number (double)

zPeakPeak
optional

number (double)

zRms
optional

number (double)

BeaconBulkRequest

Name Schema

deviceIds
optional

< string > array

BeaconConditionConfigRequest

Name Schema

accelReadInterval
optional

integer (int32)

accelReadRate
optional

integer (int32)

accelReadSummaryInterval
optional

integer (int32)

accelReadUpdate
optional

boolean

conditionModelUpdate
optional

ConditionModelUpdate

conditionSummaryInterval
optional

integer (int32)

deviceIds
optional

< string > array

motionCalibrationUpdate
optional

string

policyId
optional

integer (int64)

BeaconConfigInner

Name Schema

intervalDayInSeconds
optional

number (float)

intervalNightInSeconds
optional

number (float)

num
optional

integer (int32)

txPowerDay
optional

integer (int32)

txPowerNight
optional

integer (int32)

type
optional

integer (int32)

BeaconConfigLite

Name Schema

configType
optional

enum (CM, CM_AI, CM_AI_VELOCITY, CM_AV, CM_HIGH_SENSITIVITY, CM_LOW_POWER, CM_TRACKING, CM_TRACKING_LOW_POWER, DEFAULT, DEFAULT_LOW_POWER, LOGGING, PARKING, PANIC_BUTTON, TRACKING, TRACKING_LOW_POWER, TRACKING_ULTRA_LOW_POWER, TRACKING_CAL, TRACKING_CAL_LOW_POWER, TRACKING_IDENTITY, MLS, USER, DISTANCE_TRACKING, CM_TEMPERATURE_LOGGING)

kmxMotionConfiguration
optional

KmxConfig

mcMotionConfiguration
optional

McMotionConfig

motion
optional

boolean

motionConditionConfiguration
optional

MotionConditionConfig

motionConfiguration
optional

LeMotionConfig

motionInterval
optional

number (float)

motionNightInterval
optional

number (float)

motionNightPower
optional

integer (int32)

motionPower
optional

integer (int32)

sBeacon
optional

boolean

sBeaconInterval
optional

number (float)

sBeaconNightInterval
optional

number (float)

sBeaconNightPower
optional

integer (int32)

sBeaconPower
optional

integer (int32)

sBeaconTracking
optional

boolean

sBeaconTrackingInterval
optional

number (float)

sBeaconTrackingNightInterval
optional

number (float)

sBeaconTrackingNightPower
optional

integer (int32)

sBeaconTrackingPower
optional

integer (int32)

useSwMotionConfig
optional

boolean

BeaconConfigView

Name Schema

assetTrackable
optional

boolean

bleFirmwareId
optional

integer (int64)

bleFirmwareType
optional

string

bleFirmwareVer
optional

integer (int32)

configType
optional

string

configVersion
optional

integer (int32)

dataFountainEnabled
optional

boolean

dataFountainInterval
optional

number (float)

dataFountainPower
optional

integer (int32)

datalog
optional

boolean

datalogAccelInterval
optional

integer (int32)

datalogLightInterval
optional

integer (int32)

datalogMagInterval
optional

integer (int32)

datalogTemperatureInterval
optional

integer (int32)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceTypeCode
optional

string

deviceTypeName
optional

string

eddystoneTlmEnabled
optional

boolean

eddystoneTlmInterval
optional

number (float)

eddystoneTlmPower
optional

integer (int32)

eddystoneUidEnabled
optional

boolean

eddystoneUidInstance
optional

string

eddystoneUidInstanceAuto
optional

boolean

eddystoneUidInterval
optional

number (float)

eddystoneUidNamespace
optional

string

eddystoneUidPower
optional

integer (int32)

eddystoneUrlEnabled
optional

boolean

eddystoneUrlInterval
optional

number (float)

eddystoneUrlPower
optional

integer (int32)

eddystoneUrlUrl
optional

string

iBeaconEnabled
optional

boolean

iBeaconInterval
optional

number (float)

iBeaconMajor
optional

integer (int32)

iBeaconMinor
optional

integer (int32)

iBeaconPower
optional

integer (int32)

iBeaconUuid
optional

string

id64
optional

string

identityEnabled
optional

boolean

identityInterval
optional

number (float)

identityPower
optional

integer (int32)

latitude
optional

number (double)

lightEnabled
optional

boolean

lightInterval
optional

number (float)

lightPower
optional

integer (int32)

longitude
optional

number (double)

macAddress
optional

string

motionEnabled
optional

boolean

motionInterval
optional

number (float)

motionPower
optional

integer (int32)

name
optional

string

notes
optional

string

pairingRssi
optional

integer (int32)

pirEnabled
optional

boolean

pirInterval
optional

number (float)

pirPower
optional

integer (int32)

rawSensorEnabled
optional

boolean

rawSensorInterval
optional

number (float)

rawSensorPower
optional

integer (int32)

sBeaconEnabled
optional

boolean

sBeaconInterval
optional

number (float)

sBeaconPower
optional

integer (int32)

sBeaconTrackingEnabled
optional

boolean

sBeaconTrackingInterval
optional

number (float)

sBeaconTrackingPower
optional

integer (int32)

scanDataEnabled
optional

boolean

scanDataInterval
optional

number (float)

scanDataPower
optional

integer (int32)

templog
optional

boolean

templogInterval
optional

integer (int32)

templogReadLimit
optional

integer (int32)

templogReset
optional

boolean

templogUpdateInterval
optional

integer (int32)

uartDataEnabled
optional

boolean

uartDataInterval
optional

number (float)

uartDataPower
optional

integer (int32)

BeaconFirmwareUpdate

Name Schema

deviceId
optional

string

firmwareVersion
optional

integer (int32)

id64Hex
optional

string

name
optional

string

nextFirmwareVersion
optional

integer (int32)

projectId
optional

integer (int64)

systemDefault
optional

boolean

BeaconHistoryMetricGroup

Name Schema

batteryAvg
optional

number (double)

batteryCount
optional

number (double)

batteryPeak
optional

number (double)

batterySum
optional

number (double)

id
optional

string

key
optional

integer (int64)

keyAsString
optional

string

lumsAvg
optional

number (double)

lumsCount
optional

number (double)

lumsPeak
optional

number (double)

lumsSum
optional

number (double)

magStateAvg
optional

number (double)

magStateCount
optional

number (double)

magStatePeak
optional

number (double)

magstateSum
optional

number (double)

rssiAvg
optional

number (double)

rssiCount
optional

number (double)

rssiPeak
optional

number (double)

rssiSum
optional

number (double)

tempAvg
optional

number (double)

tempCount
optional

number (double)

tempPeak
optional

number (double)

tempSum
optional

number (double)

xaccelAvg
optional

number (double)

xaccelCount
optional

number (double)

xaccelMin
optional

number (double)

xaccelPeak
optional

number (double)

xaccelPeakToPeak
optional

number (double)

xaccelSum
optional

number (double)

xhsCount
optional

number (double)

xhsPeak
optional

number (double)

xhsPeakToPeak
optional

number (double)

xhsRmsAvg
optional

number (double)

xhsRmsPeak
optional

number (double)

xhsRmsSum
optional

number (double)

xmagAvg
optional

number (double)

xmagCount
optional

number (double)

xmagPeak
optional

number (double)

xmagSum
optional

number (double)

xvpeak
optional

number (double)

xvpeakToPeak
optional

number (double)

xvrmsAvg
optional

number (double)

xvrmsCount
optional

number (double)

xvrmsPeak
optional

number (double)

xvrmsSum
optional

number (double)

yaccelAvg
optional

number (double)

yaccelCount
optional

number (double)

yaccelMin
optional

number (double)

yaccelPeak
optional

number (double)

yaccelPeakToPeak
optional

number (double)

yaccelSum
optional

number (double)

yhsCount
optional

number (double)

yhsPeak
optional

number (double)

yhsPeakToPeak
optional

number (double)

yhsRmsAvg
optional

number (double)

yhsRmsPeak
optional

number (double)

yhsRmsSum
optional

number (double)

ymagAvg
optional

number (double)

ymagCount
optional

number (double)

ymagPeak
optional

number (double)

ymagSum
optional

number (double)

yvpeak
optional

number (double)

yvpeakToPeak
optional

number (double)

yvrmsAvg
optional

number (double)

yvrmsCount
optional

number (double)

yvrmsPeak
optional

number (double)

yvrmsSum
optional

number (double)

zaccelAvg
optional

number (double)

zaccelCount
optional

number (double)

zaccelMin
optional

number (double)

zaccelPeak
optional

number (double)

zaccelPeakToPeak
optional

number (double)

zaccelSum
optional

number (double)

zhsCount
optional

number (double)

zhsPeak
optional

number (double)

zhsPeakToPeak
optional

number (double)

zhsRmsAvg
optional

number (double)

zhsRmsPeak
optional

number (double)

zhsRmsSum
optional

number (double)

zmagAvg
optional

number (double)

zmagCount
optional

number (double)

zmagPeak
optional

number (double)

zmagSum
optional

number (double)

zvpeak
optional

number (double)

zvpeakToPeak
optional

number (double)

zvrmsAvg
optional

number (double)

zvrmsCount
optional

number (double)

zvrmsPeak
optional

number (double)

zvrmsSum
optional

number (double)

BeaconHistoryMetricValue

Name Schema

avg
optional

number (double)

count
optional

integer (int64)

id
optional

string

key
optional

integer (int64)

keyAsString
optional

string

metric
optional

string

min
optional

number (double)

peak
optional

number (double)

peakToPeak
optional

number (double)

rms
optional

number (double)

rmsPeak
optional

number (double)

sum
optional

number (double)

BeaconHistoryView

Name Schema

avg
optional

number (double)

count
optional

integer (int64)

key
optional

Number

keyAsString
optional

string

max
optional

number (double)

metric
optional

string

min
optional

number (double)

stdDeviation
optional

number (double)

stdDeviationLowerBound
optional

number (double)

stdDeviationUpperBound
optional

number (double)

sum
optional

number (double)

sumOfSquares
optional

number (double)

variance
optional

number (double)

BeaconLite

Name Schema

assetTrackable
optional

boolean

bleFirmware
optional

Firmware

conditionSummaryInterval
optional

integer (int32)

configType
optional

enum (CM, CM_AI, CM_AI_VELOCITY, CM_AV, CM_HIGH_SENSITIVITY, CM_LOW_POWER, CM_TRACKING, CM_TRACKING_LOW_POWER, DEFAULT, DEFAULT_LOW_POWER, LOGGING, PARKING, PANIC_BUTTON, TRACKING, TRACKING_LOW_POWER, TRACKING_ULTRA_LOW_POWER, TRACKING_CAL, TRACKING_CAL_LOW_POWER, TRACKING_IDENTITY, MLS, USER, DISTANCE_TRACKING, CM_TEMPERATURE_LOGGING)

configVersion
optional

integer (int32)

configuration
optional

BeaconConfigLite

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

deviceType
optional

DeviceType

firmwareVersion
optional

integer (int32)

id64Hex
optional

string

latitude
optional

number (double)

locationId
optional

integer (int64)

locationName
optional

string

longitude
optional

number (double)

macAddress
optional

string

metaData
optional

object

motionCalApplied
optional

integer (int32)

motionCalEnabled
optional

boolean

name
optional

string

projectId
optional

integer (int64)

selfieUrl
optional

string

status
optional

string

tags
optional

< Tag > array

templateId
optional

string

templateName
optional

string

templateVersion
optional

string

unixTimeOffset
optional

integer (int32)

BeaconLocation

Name Description Schema

altitude
optional

Example : "null"

number (double)

averageSourceDelayMillis
optional

Example : "null"

integer (int64)

battery
optional

Example : "null"

integer (int32)

beaconId
optional

Example : "null"

string

blufiPeriodStats
optional

Example : "null"

< BeaconLocationStat > array

boundaryCorrected
optional

Example : false

boolean

boundaryExclusionCorrected
optional

Example : false

boolean

cellId
optional

Example : "null"

integer (int64)

deviceName
optional

Example : "null"

string

direction
optional

Example : "null"

string

displayRadius
optional

Example : "null"

number (double)

error
optional

Example : "null"

string

errorDescription
optional

Example : "null"

string

fingerprintEstimate
optional

BeaconLocation

fingerprintLocations
optional

Example : "null"

< BeaconLocation > array

floorNumber
optional

Example : "null"

integer (int32)

generatorType
optional

Example : "null"

string

geoJsonMap
optional

Example : "null"

string

gt
optional

Example : "null"

enum (UNKNOWN, BLUZONE, MATLAB, TEST_SERVER, IOS, ANDROID, TEND)

intersectionGroup
optional

Example : "null"

< IntersectionGroup > array

jobModeBlufis
optional

Example : "null"

< string > array

latitude
optional

Example : "null"

number (double)

locationId
optional

Example : "null"

integer (int64)

longitude
optional

Example : "null"

number (double)

mac
optional

Example : "null"

string

maxTimestamp
optional

Example : "null"

integer (int64)

meterChangeEstimate
optional

Example : "null"

number (double)

motionStatic
optional

Example : false

boolean

projectId
optional

Example : "null"

integer (int64)

sunstoneDelayMillis
optional

Example : "null"

integer (int64)

thresholdCorrected
optional

Example : false

boolean

timestamp
optional

Example : "null"

integer (int64)

type
optional

Example : "null"

string

varianceX
optional

Example : "null"

number (double)

varianceY
optional

Example : "null"

number (double)

varianceZ
optional

Example : "null"

number (double)

windowCalculationRange
optional

Example : "null"

integer (int64)

windowCount
optional

Example : "null"

integer (int64)

BeaconLocationStat

Name Description Schema

averageLatencyMillis
optional

Example : "null"

number (double)

behindTrigger
optional

Example : "null"

integer (int64)

blufiId
optional

Example : "null"

string

blufiInsertMillis
optional

The time this blufi was added to this calculation.
Example : "null"

integer (int64)

enhanceDropped
optional

Example : "null"

integer (int64)

globalThresholdViolated
optional

Example : false

boolean

maxLatencyMillis
optional

Example : "null"

number (double)

maxTimestamp
optional

Example : "null"

integer (int64)

meterToLocation
optional

Example : "null"

number (double)

minTimestamp
optional

Example : "null"

integer (int64)

minimumSampleCountViolated
optional

Example : false

boolean

name
optional

Example : "null"

string

newInBucket
optional

Example : "null"

integer (int64)

remainingInBucket
optional

on global bucket this will show old values.
Example : "null"

integer (int64)

rssiAverage
optional

Example : "null"

number (double)

rssiCount
optional

Example : "null"

integer (int32)

rssiHistorical
optional

Example : false

boolean

sid64
optional

Example : "null"

string

BeaconMacAddressView

Name Schema

beaconId
optional

string

macAddress
optional

string

BeaconMapItem

Name Schema

next
optional

string

prev
optional

string

BeaconReadReport

Name Schema

beaconId
optional

string

beaconName
optional

string

beaconReadReportId
optional

integer (int64)

bucket
optional

string

dateEnd
optional

integer (int64)

dateReported
optional

integer (int64)

dateStart
optional

integer (int64)

description
optional

string

deviceJobId
optional

integer (int64)

deviceJobScheduleId
optional

integer (int64)

fileName
optional

string

keyName
optional

string

metricType
optional

enum (MOTION, UNKNOWN)

projectId
optional

integer (int64)

reportType
optional

enum (RAW, XTOOLS_RAW, PEAK, PEAK_TO_PEAK, RMS, CONDITION_SUMMARY, UNKNOWN)

reportUrl
optional

string

BeaconReadReportRequest

Name Schema

beaconIds
optional

< string > array

deviceJobIds
optional

< integer (int64) > array

deviceJobScheduleIds
optional

< integer (int64) > array

forDate
optional

string

fromDate
optional

string

metricType
optional

string

page
optional

integer (int32)

pageSize
optional

integer (int32)

reportType
optional

string

sortBy
optional

string

sortDirection
optional

string

toDate
optional

string

BeaconReadRunReportRequest

Name Schema

beaconIds
optional

< string > array

description
optional

string

endDate
optional

string

metricTypes
optional

< string > array

projectId
optional

integer (int64)

reportTypes
optional

< string > array

startDate
optional

string

BeaconScanConfig

Name Schema

beaconScanConfigId
optional

integer (int64)

channels
optional

< integer (int32) > array

cycles
optional

< integer (int32) > array

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

idleDutyCycle
optional

integer (int32)

scanInterval
optional

integer (int32)

scanMode
optional

integer (int32)

scanWindow
optional

integer (int32)

BeaconScanData

Name Schema

data
optional

< string, ScanData > map

deviceId
optional

string

BeaconSearchView

Name Schema

beaconId
optional

string

macAddress
optional

string

name
optional

string

status
optional

string

BeaconSignalResponse

Name Schema

devices
optional

< Device > array

BeaconStats

Name Schema

batteryVoltage
optional

number (float)

batteryVoltageMax
optional

number (float)

beaconId
optional

string

blufiId
optional

integer (int64)

dateBatteryVoltage
optional

integer (int64)

dateConditionSummary
optional

integer (int64)

dateCreated
optional

integer (int64)

dateIllegalPacket
optional

integer (int64)

dateSeen
optional

integer (int64)

dateTemperature
optional

integer (int64)

dateTemperatureMax
optional

integer (int64)

dateTemperatureMin
optional

integer (int64)

dateUpdated
optional

integer (int64)

dateViolated
optional

integer (int64)

dutyCycleDuration
optional

integer (int64)

dutyCyclesTotal
optional

integer (int32)

illegalPackets
optional

integer (int32)

pkX
optional

number (double)

pkY
optional

number (double)

pkZ
optional

number (double)

pkpkX
optional

number (double)

pkpkY
optional

number (double)

pkpkZ
optional

number (double)

projectId
optional

integer (int64)

rmsX
optional

number (double)

rmsY
optional

number (double)

rmsZ
optional

number (double)

rssi
optional

integer (int32)

temperature
optional

number (float)

temperatureMax
optional

number (float)

temperatureMin
optional

number (float)

violationDuration
optional

integer (int64)

violationsActive
optional

integer (int32)

violationsTotal
optional

integer (int32)

BeaconStatsReportRequest

Name Schema

beaconIds
optional

< string > array

endDate
optional

string

fields
optional

< string > array

forDate
optional

string

isoDateTime
optional

boolean

projectId
optional

integer (int64)

reportType
optional

string

rollupReports
optional

boolean

startDate
optional

string

BeaconTemplate

Name Description Schema

accelReadConfig
optional

AccelReadConfig

assetMaterialType
optional

enum (HUMAN, METAL, BOX, ALL, DEFAULT, FAST, SLOW)

assetTrackingEnabled
optional

boolean

autoCreateGeofencePolicy
optional

boolean

beaconLock
optional

boolean

buttonConfiguration
optional

ButtonConfig

configType
optional

enum (CM, CM_AI, CM_AI_VELOCITY, CM_AV, CM_HIGH_SENSITIVITY, CM_LOW_POWER, CM_TRACKING, CM_TRACKING_LOW_POWER, DEFAULT, DEFAULT_LOW_POWER, LOGGING, PARKING, PANIC_BUTTON, TRACKING, TRACKING_LOW_POWER, TRACKING_ULTRA_LOW_POWER, TRACKING_CAL, TRACKING_CAL_LOW_POWER, TRACKING_IDENTITY, MLS, USER, DISTANCE_TRACKING, CM_TEMPERATURE_LOGGING)

csTamperConfig
optional

CsTamperConfig

dataFountain
optional

boolean

dataFountainInterval
optional

number (float)

dataFountainNightInterval
optional

number (float)

dataFountainNightPower
optional

integer (int32)

dataFountainPower
optional

integer (int32)

datalog
optional

boolean

datalogAccelInterval
optional

integer (int32)

datalogLightInterval
optional

integer (int32)

datalogMagInterval
optional

integer (int32)

datalogReadConfig
optional

DatalogReadConfig

datalogTemperatureInterval
optional

integer (int32)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

eddystoneTlm
optional

boolean

eddystoneTlmInterval
optional

number (float)

eddystoneTlmNightInterval
optional

number (float)

eddystoneTlmNightPower
optional

integer (int32)

eddystoneTlmPower
optional

integer (int32)

eddystoneUid
optional

boolean

eddystoneUidInstance
optional

string

eddystoneUidInstanceAuto
optional

boolean

eddystoneUidInterval
optional

number (float)

eddystoneUidNamespace
optional

string

eddystoneUidNightInterval
optional

number (float)

eddystoneUidNightPower
optional

integer (int32)

eddystoneUidPower
optional

integer (int32)

eddystoneUrl
optional

boolean

eddystoneUrlInterval
optional

number (float)

eddystoneUrlNightInterval
optional

number (float)

eddystoneUrlNightPower
optional

integer (int32)

eddystoneUrlPower
optional

integer (int32)

eddystoneUrlUrl
optional

string

filterConfiguration
optional

CmFilterConfig

filterConfigurationKmx
optional

CmFilterConfig

firmwareConfig
optional

FirmwareConfig

geofencePeriod
optional

integer (int64)

geofenceWidth
optional

integer (int32)

iBeacon
optional

boolean

iBeaconInterval
optional

number (float)

iBeaconMajor
optional

integer (int32)

iBeaconMajorAuto
optional

boolean

iBeaconMajorValue
optional

integer (int32)

iBeaconMinor
optional

integer (int32)

iBeaconMinorAuto
optional

boolean

iBeaconMinorValue
optional

integer (int32)

iBeaconNightInterval
optional

number (float)

iBeaconNightPower
optional

integer (int32)

iBeaconPower
optional

integer (int32)

iBeaconRssiCalibration
optional

boolean

iBeaconRssiOffset
required

Minimum value : -100
Maximum value : 0
Example : -10

integer (int32)

iBeaconUuid
optional

string

iBeaconUuidAssignmentType
optional

string

iBeaconUuidValue
optional

string

identityEnabled
optional

boolean

identityInterval
optional

number (float)

identityNightInterval
optional

number (float)

identityNightPower
optional

integer (int32)

identityPower
optional

integer (int32)

identityUseAlternateChannel
optional

boolean

kmxMotionConfiguration
optional

KmxConfig

kmxReadConfig
optional

KmxReadConfig

light
optional

boolean

lightInterval
optional

number (float)

lightNightInterval
optional

number (float)

lightNightPower
optional

integer (int32)

lightPower
optional

integer (int32)

ltxScanConfiguration
optional

LtxScanConfig

mcMotionConfiguration
optional

McMotionConfig

metaData
optional

object

motion
optional

boolean

motionConditionConfiguration
optional

MotionConditionConfig

motionConditionConfigurationKmx
optional

MotionConditionConfig

motionConfiguration
optional

LeMotionConfig

motionInterval
optional

number (float)

motionNightInterval
optional

number (float)

motionNightPower
optional

integer (int32)

motionPower
optional

integer (int32)

name
optional

string

networkSelectorType
optional

enum (ANY, WIFI, ETHERNET)

pairingRssi
optional

integer (int32)

parkingEnabled
optional

boolean

parkingTrainingTimeInSec
optional

integer (int32)

pir
optional

boolean

pirConfiguration
optional

PirConfig

pirInterval
optional

number (float)

pirNightInterval
optional

number (float)

pirNightPower
optional

integer (int32)

pirPower
optional

integer (int32)

policies
optional

< PolicyView > array

projectId
optional

integer (int64)

rawCommandConfig
optional

RawCommandConfig

rawSensor
optional

boolean

rawSensorInterval
optional

number (float)

rawSensorNightInterval
optional

number (float)

rawSensorNightPower
optional

integer (int32)

rawSensorPower
optional

integer (int32)

rtlsUseSbv2
optional

boolean

sBeacon
optional

boolean

sBeaconInterval
optional

number (float)

sBeaconNightInterval
optional

number (float)

sBeaconNightPower
optional

integer (int32)

sBeaconPower
optional

integer (int32)

sBeaconTracking
optional

boolean

sBeaconTrackingInterval
optional

number (float)

sBeaconTrackingNightInterval
optional

number (float)

sBeaconTrackingNightPower
optional

integer (int32)

sBeaconTrackingPower
optional

integer (int32)

scanData
optional

boolean

scanDataInterval
optional

number (float)

scanDataNightInterval
optional

number (float)

scanDataNightPower
optional

integer (int32)

scanDataPower
optional

integer (int32)

spectrum
optional

boolean

spectrumInterval
optional

number (float)

spectrumNightInterval
optional

number (float)

spectrumNightPower
optional

integer (int32)

spectrumPower
optional

integer (int32)

swMotionConfiguration
optional

SwMotionConfig

systemCreated
optional

boolean

tags
optional

< Tag > array

templateId
optional

integer (int64)

templog
optional

boolean

templogInterval
optional

integer (int32)

templogReadLimit
optional

integer (int32)

templogReset
optional

boolean

templogUpdateInterval
optional

integer (int32)

tracingConfiguration
optional

TracingConfig

uartData
optional

boolean

uartDataInterval
optional

number (float)

uartDataNightInterval
optional

number (float)

uartDataNightPower
optional

integer (int32)

uartDataPower
optional

integer (int32)

unixTimeOffset
optional

integer (int32)

useSwMotionConfig
optional

boolean

version
optional

integer (int32)

BeaconView

Name Schema

bleFirmwareId
optional

integer (int64)

bleFirmwareType
optional

string

bleFirmwareVersion
optional

integer (int32)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

deviceTypeId
optional

integer (int64)

deviceTypeName
optional

string

history
optional

< BeaconHistoryView > array

id64
optional

string

latitude
optional

number (double)

locationId
optional

integer (int64)

locationName
optional

string

longitude
optional

number (double)

macAddress
optional

string

managingBlufiId
optional

integer (int64)

mostRecentViolation
optional

integer (int64)

motionFrames
optional

< MotionData > array

name
optional

string

projectId
optional

integer (int64)

scanData
optional

ScanData

selfieId
optional

integer (int64)

selfieUrl
optional

string

status
optional

string

violationCount
optional

integer (int32)

violations
optional

< PolicyViolation > array

BleFirmware

Name Schema

checksum
optional

< string (byte) > array

checksumInternal
optional

< string (byte) > array

data
optional

< string (byte) > array

dataInternal
optional

< string (byte) > array

revision
optional

integer (int32)

useInternal
optional

boolean

BluFiProvisionRequest

Name Schema

cloudCert
optional

string

cloudCertData
optional

string

cloudUnSecureUrl
optional

string

cloudUrl
optional

string

encrKey
optional

string

profileData
optional

ProfileData

reconnectConfig
optional

WifiReconnectConfig

recovery
optional

boolean

recoveryConfig
optional

BlufiRecoveryFirmwareConfig

registration
optional

boolean

sid64
optional

string

udpConfigurationType
optional

enum (DISABLED, BROADCAST_ADDRESS_PANIC_ONLY, MANUAL_ADDRESS_PANIC_ONLY, BROADCAST_ADDRESS_ALL_PACKETS, MANUAL_ADDRESS_ALL_PACKETS)

udpHost
optional

string

udpPort
optional

integer (int32)

wifiProfileId
optional

string

Blufi

Name Schema

allowDataCompression
optional

boolean

alloyVersion
optional

string

altitude
optional

number (float)

assetTrackAltitude
optional

number (float)

assetTrackLatitude
optional

number (double)

assetTrackLongitude
optional

number (double)

assetTrackRssiOffset
optional

number (double)

assetTrackable
optional

boolean

autoLocationName
optional

string

batteryBlufi
optional

boolean

batteryBlufiAntenna
optional

enum (HORIZONTAL, VERTICAL, OMNI)

bleFirmware
optional

Firmware

bleMac
optional

string

blufiTemplateApplied
optional

boolean

blufiTemplateId
optional

integer (int64)

blufiTemplateName
optional

string

boxCalibrationOffset
optional

number (double)

boxCalibrationOffsetOriginal
optional

number (double)

boxCalibrationScale
optional

number (double)

boxCalibrationScaleOriginal
optional

number (double)

boxCalibrationVariance
optional

number (double)

boxCalibrationVarianceOriginal
optional

number (double)

bssid
optional

string

childPolicyId
optional

integer (int64)

cloudAddress
optional

string

configData
optional

string

configVersion
optional

integer (int32)

configuration
optional

BeaconTemplate

dateCreated
optional

integer (int64)

dateProvisioned
optional

integer (int64)

dateUpdated
optional

integer (int64)

defaultOffset
optional

number (double)

defaultScale
optional

number (double)

defaultVariance
optional

number (double)

deviceId
optional

string

deviceJobsEnabled
optional

boolean

deviceType
optional

DeviceType

dnsAddress
optional

string

enableMls
optional

boolean

enableTethering
optional

boolean

ethDnsAddress
optional

string

ethGwAddress
optional

string

ethIpAddress
optional

string

ethMacAddress
optional

string

factoryResetApplied
optional

boolean

factoryResetOnDelete
optional

boolean

factoryResetPending
optional

boolean

goVersion
optional

string

gwAddress
optional

string

hostname
optional

string

humanCalibrationOffset
optional

number (double)

humanCalibrationOffsetOriginal
optional

number (double)

humanCalibrationScale
optional

number (double)

humanCalibrationScaleOriginal
optional

number (double)

humanCalibrationVariance
optional

number (double)

humanCalibrationVarianceOriginal
optional

number (double)

iBeaconConfiguration
optional

BlufiIBeaconConfiguration

identityConfiguration
optional

BlufiIdentityConfiguration

ipAddress
optional

string

jobScanMode
optional

SystemScanMode

latitude
optional

number (double)

locationId
optional

integer (int64)

locations
optional

< Location > array

longitude
optional

number (double)

macAddress
optional

string

metalCalibrationOffset
optional

number (double)

metalCalibrationOffsetOriginal
optional

number (double)

metalCalibrationScale
optional

number (double)

metalCalibrationScaleOriginal
optional

number (double)

metalCalibrationVariance
optional

number (double)

metalCalibrationVarianceOriginal
optional

number (double)

muted
optional

boolean

name
optional

string

networkSelectorType
optional

enum (ANY, WIFI, ETHERNET)

notes
optional

string

nwpVersion
optional

string

pirBeacons
optional

< SimpleDevice > array

powerSourceType
optional

enum (UNKNOWN, AC, DC, POE)

projectId
optional

integer (int64)

resetConfiguration
optional

BlufiResetConfiguration

rxGainEnabled
optional

boolean

scanData
optional

ScanData

scanDataMap
optional

BlufiScanData

scanMode
optional

SystemScanMode

selfie
optional

DeviceSelfie

sid128
optional

string

sid64
optional

string

sid64Hex
optional

string

sleepCycle
optional

BlufiSleepCycle

sleepSchedule
optional

BlufiSleepSchedule

stat
optional

BlufiStat

statsInterval
optional

integer (int64)

status
optional

string

streamProduceEnabled
optional

boolean

tags
optional

< Tag > array

udpConfiguration
optional

BlufiUdpConfiguration

virtualDeviceId
optional

integer (int64)

websocketSessionHostname
optional

string

websocketSessionId
optional

string

wifiFirmwareRev
optional

integer (int32)

wifiPmConfiguration
optional

BlufiWifiPmConfiguration

wifiReconnectConfiguration
optional

WifiReconnectConfig

wifiSsid
optional

string

wifiTemplateSecurityType
optional

string

wifiTemplateSsid
optional

string

wsEndpoint
optional

string

BlufiBulkDefaultFirmwareUpdate

Name Schema

blufis
optional

BlufiBulkRequest

forceBleFirmwareUpgrade
optional

boolean

forceServicePackUpgrade
optional

boolean

forceWifiFirmwareUpgrade
optional

boolean

updateBleFirmware
optional

boolean

updateServicePack
optional

boolean

updateWifiFirmware
optional

boolean

BlufiBulkFirmwareUpdate

Name Schema

alloyFirmwareName
optional

string

bleFirmwareImageId
optional

integer (int64)

blufis
optional

BlufiBulkRequest

forceAlloyUpgrade
optional

boolean

forceBleFirmwareUpgrade
optional

boolean

forceServicePackUpgrade
optional

boolean

forceWifiFirmwareUpgrade
optional

boolean

servicePackImageId
optional

integer (int64)

wifiFirmwareImageId
optional

integer (int64)

BlufiBulkRequest

Name Schema

deviceIds
optional

< string > array

empty
optional

boolean

macAddresses
optional

< string > array

sid64s
optional

< string > array

BlufiConfig

Name Schema

aggregator
optional

Aggregator

antenna
optional

integer (int32)

beacon
optional

BeaconConfigInner

cloudCert
optional

string

cloudUnSecureUrl
optional

string

cloudUrl
optional

string

enabledWifiRates
optional

integer (int32)

iBeacon
optional

boolean

iBeaconInterval
optional

number (float)

iBeaconMajor
optional

integer (int32)

iBeaconMajorAuto
optional

boolean

iBeaconMajorValue
optional

integer (int32)

iBeaconMinor
optional

integer (int32)

iBeaconMinorAuto
optional

boolean

iBeaconMinorValue
optional

integer (int32)

iBeaconNightInterval
optional

number (float)

iBeaconNightPower
optional

integer (int32)

iBeaconPower
optional

integer (int32)

iBeaconRssiCalibration
optional

boolean

iBeaconRssiOffset
optional

integer (int32)

iBeaconUuidAssignmentType
optional

string

iBeaconUuidValue
optional

string

identity
optional

boolean

identityInterval
optional

number (float)

identityNightInterval
optional

number (float)

identityNightPower
optional

integer (int32)

identityPower
optional

integer (int32)

identityUseAlternateChannel
optional

boolean

pairingRssi
optional

integer (int32)

profileData
optional

BlufiConfigProfileData

resetInterval
optional

integer (int64)

rttEnabled
optional

boolean

rxGain
optional

integer (int32)

statsInterval
optional

integer (int64)

udpConfigurationType
optional

enum (DISABLED, BROADCAST_ADDRESS_PANIC_ONLY, MANUAL_ADDRESS_PANIC_ONLY, BROADCAST_ADDRESS_ALL_PACKETS, MANUAL_ADDRESS_ALL_PACKETS)

udpHost
optional

string

udpPort
optional

integer (int32)

wifiPmPolicyType
optional

enum (NORMAL, ALWAYS_ON)

wifiReconnectConfig
optional

WifiReconnectConfig

BlufiConfigProfileData

Name Schema

channels
optional

string

description
optional

string

dnsAddress
optional

string

gatewayAddress
optional

string

ipAddress
optional

string

name
optional

string

netMask
optional

string

networkProtocolType
optional

enum (DHCP, STATIC)

ntpDisabled
optional

boolean

ntpServers
optional

string

passphrase
optional

string

proxyUrl
optional

string

rssiThreshold
optional

integer (int32)

securityType
optional

string

ssid
optional

string

user
optional

string

verifyCert
optional

boolean

wifiCertName
optional

string

wifiProfileId
optional

string

BlufiConnectionProperties

Name Schema

status
optional

string

type
optional

string

BlufiFirmwareUpdate

Name Schema

bleFirmwareUpdate
optional

FirmwareUpdate

deviceId
optional

integer (int64)

id64Hex
optional

string

name
optional

string

projectId
optional

integer (int64)

servicePackUpdate
optional

FirmwareUpdateStrings

sid64
optional

string

wifiFirmwareUpdate
optional

FirmwareUpdate

BlufiIBeaconConfiguration

Name Schema

iBeacon
optional

boolean

iBeaconInterval
optional

number (float)

iBeaconMajorAuto
optional

boolean

iBeaconMajorValue
optional

integer (int32)

iBeaconMinorAuto
optional

boolean

iBeaconMinorValue
optional

integer (int32)

iBeaconNightInterval
optional

number (float)

iBeaconNightPower
optional

integer (int32)

iBeaconPower
optional

integer (int32)

iBeaconRssiCalibration
optional

boolean

iBeaconRssiOffset
optional

integer (int32)

iBeaconUuidAssignmentType
optional

string

iBeaconUuidValue
optional

string

BlufiIdentityConfiguration

Name Schema

identity
optional

boolean

identityInterval
optional

number (float)

identityNightInterval
optional

number (float)

identityNightPower
optional

integer (int32)

identityPower
optional

integer (int32)

identityUseAlternateChannel
optional

boolean

BlufiLite

Name Schema

blufiTemplateId
optional

integer (int64)

blufiTemplateVersion
optional

integer (int32)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

integer (int64)

deviceTypeId
optional

integer (int64)

ethIpAddress
optional

string

ethMacAddress
optional

string

firmwareVersion
optional

integer (int32)

ipAddress
optional

string

latitude
optional

number (double)

locationId
optional

integer (int64)

locationName
optional

string

longitude
optional

number (double)

macAddress
optional

string

name
optional

string

networkSelectorType
optional

enum (ANY, WIFI, ETHERNET)

powerSourceType
optional

enum (UNKNOWN, AC, DC, POE)

projectId
optional

integer (int64)

selfieUrl
optional

string

sid64
optional

string

status
optional

string

tags
optional

< Tag > array

wifiFirmwareRev
optional

integer (int32)

wifiSsid
optional

string

BlufiProperties

Name Schema

bssid
optional

string

dnsAddr
optional

integer (int32)

enabledWifiRates
optional

integer (int32)

fwRevisionLe
optional

integer (int32)

fwRevisionWifi
optional

integer (int32)

fwStringWifi
optional

string

gwAddr
optional

integer (int32)

id128
optional

< integer (int64) > array

id64
optional

integer (int64)

ipAddr
optional

integer (int32)

leHwAddr
optional

integer (int64)

nwpVersion
optional

string

srvAddr
optional

integer (int32)

ssid
optional

string

type
optional

string

wifiHwAddr
optional

integer (int64)

BlufiPropertiesAdData

Name Schema

alloyVersion
optional

string

dnsAddr
optional

integer (int32)

ethDnsAddr
optional

integer (int32)

ethGwAddr
optional

integer (int32)

ethIpAddr
optional

integer (int32)

ethMacAddr
optional

integer (int64)

fwRevisionLe
optional

integer (int32)

fwRevisionWifi
optional

integer (int32)

fwStringWifi
optional

string

goArch
optional

string

goOs
optional

string

goVersion
optional

string

gwAddr
optional

integer (int32)

id128
optional

< integer (int64) > array

id64
optional

integer (int64)

ipAddr
optional

integer (int32)

leHwAddr
optional

integer (int64)

srvAddr
optional

integer (int32)

ssid
optional

string

type
optional

string

wifiHwAddr
optional

integer (int64)

BlufiRecoveryFirmwareConfig

Name Schema

bleFirmwareImageId
optional

integer (int64)

servicePackImageId
optional

integer (int64)

wifiFirmwareImageId
optional

integer (int64)

BlufiRedirect

Name Schema

blufiRedirectId
optional

integer (int64)

certificateData
optional

string

certificateName
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enabled
optional

boolean

forced
optional

boolean

globalScope
optional

boolean

host
optional

string

managedBlufiIds
optional

< integer (int64) > array

projectId
optional

integer (int64)

BlufiReplaceRequest

Name Schema

didProvision
optional

boolean

existingBlufiSid64
optional

string

replacementBlufiSid64
optional

string

BlufiResetConfiguration

Name Schema

resetInterval
optional

integer (int64)

BlufiScanData

Name Schema

data
optional

< string, ScanData > map

deviceId
optional

integer (int64)

BlufiSearchView

Name Schema

deviceId
optional

integer (int64)

macAddress
optional

string

name
optional

string

status
optional

string

BlufiSleepCycle

Name Schema

blufiSleepCycleId
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

name
optional

string

projectId
optional

integer (int64)

sleepTimeSeconds
optional

integer (int32)

wakeTimeSeconds
optional

integer (int32)

BlufiSleepSchedule

Name Schema

blufiSleepScheduleId
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

name
optional

string

projectId
optional

integer (int64)

timeFrames
optional

< BlufiSleepTimeframe > array

timezone
optional

string

BlufiSleepTimeframe

Name Schema

blufiSleepTimeFrameId
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

days
optional

string

hourOfDay
optional

integer (int32)

intervalMinutes
optional

integer (int32)

minuteOfHour
optional

integer (int32)

projectId
optional

integer (int64)

BlufiStat

Name Schema

avgDataCtrlRssi
optional

integer (int32)

avgMgmtRssi
optional

integer (int32)

batteryCharging
optional

boolean

batteryVoltage
optional

number (float)

binaryMessageBytes
optional

integer (int64)

conFail
optional

integer (int64)

conSuccess
optional

integer (int64)

connectionRTT
optional

integer (int64)

ethRxBytes
optional

integer (int32)

ethRxDropped
optional

integer (int32)

ethRxErrors
optional

integer (int32)

ethRxPackets
optional

integer (int32)

ethTxBytes
optional

integer (int32)

ethTxDropped
optional

integer (int32)

ethTxErrors
optional

integer (int32)

ethTxPackets
optional

integer (int32)

ethUptime
optional

integer (int32)

fcsErrorPackets
optional

integer (int32)

lightLevels
optional

< number (float) > array

packetReceived
optional

integer (int32)

packetsDropped
optional

integer (int32)

packetsLost
optional

integer (int32)

plcpErrorPackets
optional

integer (int32)

rateHistogram
optional

< BlufiStatHistogram > array

recvBytes
optional

integer (int64)

recvPackets
optional

integer (int64)

rssiHistogram
optional

< BlufiStatHistogram > array

sendBytes
optional

integer (int64)

sendPackets
optional

integer (int64)

temperature
optional

number (float)

type
optional

string

validPackets
optional

integer (int32)

wifiRxBytes
optional

integer (int32)

wifiRxDropped
optional

integer (int32)

wifiRxErrors
optional

integer (int32)

wifiRxPackets
optional

integer (int32)

wifiTxBytes
optional

integer (int32)

wifiTxDropped
optional

integer (int32)

wifiTxErrors
optional

integer (int32)

wifiTxPackets
optional

integer (int32)

wifiUptime
optional

integer (int32)

BlufiStatHistogram

Name Schema

count
optional

integer (int32)

index
optional

integer (int32)

BlufiStats

Name Schema

avgDataCtrlRssi
optional

integer (int32)

avgMgmtRssi
optional

integer (int32)

batteryCharging
optional

boolean

batteryVoltage
optional

number (float)

batteryVoltageMax
optional

number (float)

blufiId
optional

integer (int64)

bytesReceived
optional

integer (int64)

bytesSent
optional

integer (int64)

connectedDuration
optional

integer (int64)

connectsTotal
optional

integer (int32)

dateBatteryVoltage
optional

integer (int64)

dateConnected
optional

integer (int64)

dateCreated
optional

integer (int64)

dateDisconnected
optional

integer (int64)

dateSeen
optional

integer (int64)

dateTemperature
optional

integer (int64)

dateTemperatureMax
optional

integer (int64)

dateTemperatureMin
optional

integer (int64)

dateUpdated
optional

integer (int64)

dateViolated
optional

integer (int64)

datesConnected
optional

< string (date-time) > array

datesDisconnected
optional

< string (date-time) > array

disconnectsTotal
optional

integer (int32)

dnsAddress
optional

string

failedConnections
optional

integer (int64)

fwRevisionLe
optional

string

fwRevisionWifi
optional

string

gwAddress
optional

string

ipAddress
optional

string

leHwAddress
optional

string

packetsDropped
optional

integer (int32)

packetsFcsError
optional

integer (int32)

packetsLost
optional

integer (int32)

packetsPlcpError
optional

integer (int32)

packetsReceived
optional

integer (int64)

packetsSent
optional

integer (int64)

packetsValid
optional

integer (int32)

projectId
optional

integer (int64)

sid64
optional

string

ssid
optional

string

successfulConnections
optional

integer (int64)

temperature
optional

number (float)

temperatureMax
optional

number (float)

temperatureMin
optional

number (float)

violationDuration
optional

integer (int64)

violationsActive
optional

integer (int32)

violationsTotal
optional

integer (int32)

wifiHwAddress
optional

string

wsAddress
optional

string

BlufiStatsReportRequest

Name Schema

blufiIds
optional

< integer (int64) > array

endDate
optional

string

fields
optional

< string > array

forDate
optional

string

isoDateTime
optional

boolean

projectId
optional

integer (int64)

reportType
optional

string

rollupReports
optional

boolean

startDate
optional

string

BlufiStatus

Name Description Schema

sid64
optional

Example : "null"

string

status
optional

Example : "null"

string

BlufiTemplate

Name Schema

allowDataCompression
optional

boolean

antennaSel
optional

enum (HORIZONTAL, VERTICAL, OMNI)

assetTrackingEnabled
optional

boolean

autoCreateGeofencePolicy
optional

boolean

autoCreatePLSPolicy
optional

boolean

certData
optional

< string (byte) > array

certFileName
optional

string

channels
optional

string

clientCertData
optional

< string (byte) > array

clientCertFileName
optional

string

clientPrivateKeyData
optional

< string (byte) > array

clientPrivateKeyFileName
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

dnsAddress
optional

string

enableAlternativeTrackingChannels
optional

boolean

enableMls
optional

boolean

enableStaticEndpoint
optional

boolean

gatewayAddress
optional

string

geofencePeriod
optional

integer (int64)

geofenceWidth
optional

integer (int32)

identityEnabled
optional

boolean

identityInterval
optional

number (float)

identityNightInterval
optional

number (float)

identityNightPower
optional

integer (int32)

identityPower
optional

integer (int32)

identityUseAlternateChannel
optional

boolean

ipAddress
optional

string

name
optional

string

netMask
optional

string

networkProtocolType
optional

enum (DHCP, STATIC)

networkSelectorType
optional

enum (ANY, WIFI, ETHERNET)

ntpDisabled
optional

boolean

ntpServers
optional

string

passphrase
optional

string

policies
optional

< PolicyView > array

projectId
optional

integer (int64)

proxyHost
optional

string

proxyPassword
optional

string

proxyPort
optional

integer (int32)

proxyUsername
optional

string

rssiThreshold
optional

integer (int32)

rxGainEnabled
optional

boolean

scanMode
optional

SystemScanMode

securityType
optional

WifiSecurityType

sleepSchedule
optional

BlufiSleepSchedule

ssid
optional

string

tags
optional

< Tag > array

templateId
optional

integer (int64)

udpConfigurationType
optional

enum (DISABLED, BROADCAST_ADDRESS_PANIC_ONLY, MANUAL_ADDRESS_PANIC_ONLY, BROADCAST_ADDRESS_ALL_PACKETS, MANUAL_ADDRESS_ALL_PACKETS)

udpHost
optional

string

udpPort
optional

integer (int32)

username
optional

string

verifyCert
optional

boolean

version
optional

integer (int32)

wifiBackoffFactor
optional

integer (int32)

wifiBssid
optional

string

wifiConChangeMaxTime
optional

integer (int32)

wifiConKeptTime
optional

integer (int32)

wifiConMaxRetries
optional

integer (int32)

wifiDeltaScanTime
optional

integer (int32)

wifiMaxScanTime
optional

integer (int32)

wifiMaxWaitTime
optional

integer (int32)

wifiMinScanTime
optional

integer (int32)

wifiMinWaitTime
optional

integer (int32)

wifiPmPolicyType
optional

enum (NORMAL, ALWAYS_ON)

wifiProfileId
optional

integer (int64)

wsEndpoint
optional

string

BlufiTemplateLite

Name Schema

allowDataCompression
optional

boolean

assetTrackingEnabled
optional

boolean

autoCreateGeofencePolicy
optional

boolean

autoCreatePLSPolicy
optional

boolean

certFileName
optional

string

channels
optional

string

clientCertFileName
optional

string

clientPrivateKeyFileName
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

dnsAddress
optional

string

enableMls
optional

boolean

gatewayAddress
optional

string

geofencePeriod
optional

integer (int64)

geofenceWidth
optional

integer (int32)

identityEnabled
optional

boolean

identityInterval
optional

number (float)

identityNightInterval
optional

number (float)

identityNightPower
optional

integer (int32)

identityPower
optional

integer (int32)

identityUseAlternateChannel
optional

boolean

ipAddress
optional

string

name
optional

string

netMask
optional

string

networkProtocolType
optional

enum (DHCP, STATIC)

networkSelectorType
optional

enum (ANY, WIFI, ETHERNET)

ntpDisabled
optional

boolean

ntpServers
optional

string

passphrase
optional

string

policies
optional

< PolicyView > array

projectId
optional

integer (int64)

proxyHost
optional

string

proxyPort
optional

integer (int32)

rssiThreshold
optional

integer (int32)

scanMode
optional

SystemScanMode

securityType
optional

WifiSecurityType

sleepSchedule
optional

BlufiSleepSchedule

ssid
optional

string

tags
optional

< Tag > array

templateId
optional

integer (int64)

udpConfigurationType
optional

enum (DISABLED, BROADCAST_ADDRESS_PANIC_ONLY, MANUAL_ADDRESS_PANIC_ONLY, BROADCAST_ADDRESS_ALL_PACKETS, MANUAL_ADDRESS_ALL_PACKETS)

udpHost
optional

string

udpPort
optional

integer (int32)

username
optional

string

verifyCert
optional

boolean

version
optional

integer (int32)

wifiBackoffFactor
optional

integer (int32)

wifiBssid
optional

string

wifiConChangeMaxTime
optional

integer (int32)

wifiConKeptTime
optional

integer (int32)

wifiConMaxRetries
optional

integer (int32)

wifiDeltaScanTime
optional

integer (int32)

wifiMaxScanTime
optional

integer (int32)

wifiMaxWaitTime
optional

integer (int32)

wifiMinScanTime
optional

integer (int32)

wifiMinWaitTime
optional

integer (int32)

wifiPmPolicyType
optional

enum (NORMAL, ALWAYS_ON)

wifiProfileId
optional

integer (int64)

BlufiTetheringRequest

Name Schema

enableTethering
optional

boolean

sid64s
optional

< string > array

BlufiUdpConfiguration

Name Schema

udpConfigurationType
optional

enum (DISABLED, BROADCAST_ADDRESS_PANIC_ONLY, MANUAL_ADDRESS_PANIC_ONLY, BROADCAST_ADDRESS_ALL_PACKETS, MANUAL_ADDRESS_ALL_PACKETS)

udpHost
optional

string

udpPort
optional

integer (int32)

BlufiView

Name Schema

bleFirmwareId
optional

integer (int64)

bleFirmwareType
optional

string

bleFirmwareVersion
optional

integer (int32)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

integer (int64)

deviceTypeId
optional

integer (int64)

deviceTypeName
optional

string

id64
optional

string

latitude
optional

number (double)

locationId
optional

integer (int64)

locationName
optional

string

longitude
optional

number (double)

mostRecentViolation
optional

integer (int64)

name
optional

string

projectId
optional

integer (int64)

scanData
optional

ScanData

selfieId
optional

integer (int64)

selfieUrl
optional

string

status
optional

string

violationCount
optional

integer (int32)

BlufiWifiPmConfiguration

Name Schema

wifiPmPolicyType
optional

enum (NORMAL, ALWAYS_ON)

BooleanStatus

Name Schema

status
optional

boolean

ButtonConfig

Name Schema

advDuration
optional

integer (int32)

advInterval
optional

number (float)

advTxPower
optional

integer (int32)

buttonConfigId
optional

integer (int64)

cancelDuration
optional

integer (int32)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

duressEnabled
optional

boolean

enableBuzzer
optional

boolean

enableDuration
optional

integer (int32)

enableLed
optional

boolean

iBeacon
optional

boolean

useAlternateScanChannel
optional

boolean

CSVAdProperty

Name Schema

@timestamp
optional

integer (int64)

ad128bit
optional

string

ad128bitMore
optional

string

ad16bit
optional

string

ad16bitMore
optional

string

ad32bit
optional

string

ad32bitMore
optional

string

adFlags
optional

string

adNameLong
optional

string

adNameShort
optional

string

adPower
optional

string

adType
optional

string

addr2
optional

string

bat
optional

integer (int32)

batt
optional

integer (int32)

bdId
optional

string

blufiId
optional

string

bpm
optional

integer (int32)

eventCounter
optional

string

flags
optional

integer (int32)

frameCount
optional

integer (int32)

gid
optional

string

id
optional

string

instanceIdentifier
optional

string

length
optional

integer (int32)

lums
optional

integer (int32)

major
optional

integer (int32)

measuredPower
optional

integer (int32)

minor
optional

integer (int32)

motion
optional

string

namespaceIdentifier
optional

string

projectId
optional

integer (int64)

raw
optional

string

revision
optional

integer (int32)

rssi
optional

integer (int32)

rssiCh
optional

integer (int32)

sdc
optional

integer (int32)

serverTimestamp
optional

integer (int64)

ssid
optional

string

started
optional

integer (int64)

staticHash
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int32)

timeNano
optional

integer (int64)

txChn
optional

integer (int32)

txPower
optional

integer (int32)

type
optional

enum (TEST, sSpec, unknown, hearRate, sBv1, sBv2, tracking, sLight, sSns, sSnsNano, sSnsSummary, motion, mag, iBeacon, eddystoneUid, eddystoneUrl, eddystoneTlm, deviceStat, blufiProps, blufiCon, probe, df)

uptime
optional

integer (int32)

url
optional

string

uuid
optional

string

xAccel
optional

number (double)

xMag
optional

integer (int32)

xPeak
optional

number (double)

xPeakToPeak
optional

number (double)

xRms
optional

number (double)

yAccel
optional

number (double)

yMag
optional

integer (int32)

yPeak
optional

number (double)

yPeakToPeak
optional

number (double)

yRms
optional

number (double)

zAccel
optional

number (double)

zMag
optional

integer (int32)

zPeak
optional

number (double)

zPeakToPeak
optional

number (double)

zRms
optional

number (double)

CSVResponse

Name Schema

columns
optional

CollectionOfstring

filename
optional

string

includeHeader
optional

boolean

omitTailColumns
optional

boolean

quoteStrings
optional

boolean

response
optional

object

schemaSeparator
optional

string

CloudUser

Name Schema

account
optional

string

arn
optional

string

cloudProvider
optional

string

createDate
optional

integer (int64)

passwordLastUsed
optional

integer (int64)

path
optional

string

userId
optional

string

userName
optional

string

ClusterDataResponse

Name Schema

adv
optional

boolean

beaconId
optional

string

blufiId
optional

integer (int64)

dateKey
optional

integer (int64)

dateStringKey
optional

string

highRes
optional

boolean

projectId
optional

integer (int64)

sourceTime
optional

integer (int64)

started
optional

integer (int64)

xClusterIndex
optional

integer (int32)

xPeak
optional

number (double)

xPeakToPeak
optional

number (double)

xRms
optional

number (double)

xVPeak
optional

number (double)

xVPeakToPeak
optional

number (double)

xVRms
optional

number (double)

yClusterIndex
optional

integer (int32)

yPeak
optional

number (double)

yPeakToPeak
optional

number (double)

yRms
optional

number (double)

yVPeak
optional

number (double)

yVPeakToPeak
optional

number (double)

yVRms
optional

number (double)

zClusterIndex
optional

integer (int32)

zPeak
optional

number (double)

zPeakToPeak
optional

number (double)

zRms
optional

number (double)

zVPeak
optional

number (double)

zVPeakToPeak
optional

number (double)

zVRms
optional

number (double)

CmFilter

Name Schema

a0
optional

number (double)

a1
optional

number (double)

b0
optional

number (double)

b1
optional

number (double)

b2
optional

number (double)

cmFilterId
optional

integer (int64)

CmFilterChannel

Name Schema

cmFilterChannelId
optional

integer (int64)

filter1
optional

CmFilter

filter2
optional

CmFilter

filter3
optional

CmFilter

filter4
optional

CmFilter

filter5
optional

CmFilter

CmFilterConfig

Name Schema

accelX
optional

CmFilterChannel

accelY
optional

CmFilterChannel

accelZ
optional

CmFilterChannel

cmFilterConfigId
optional

integer (int64)

downsamplingFactor
optional

integer (int32)

legacyX
optional

CmFilterChannel

legacyY
optional

CmFilterChannel

legacyZ
optional

CmFilterChannel

preX
optional

CmFilterChannel

preY
optional

CmFilterChannel

preZ
optional

CmFilterChannel

velocityX
optional

CmFilterChannel

velocityY
optional

CmFilterChannel

velocityZ
optional

CmFilterChannel

CollectionOfBaseDevice

Type : object

CollectionOfDeviceMfgInfo

Type : object

CollectionOfFilterParameters

Type : object

CollectionOfPanicButtonViolationHistView

Type : object

CollectionOfstring

Type : object

ConditionModelTemplate

Name Schema

clusterType
optional

enum (GMEANS)

conditionModelTemplateId
optional

integer (int64)

dateCreated
optional

integer (int64)

dateStarted
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

duration
optional

integer (int64)

maxClusterDeviation
optional

number (float)

maxClusters
optional

integer (int32)

maxDeviation
optional

number (float)

metricType
optional

enum (ACCELERATION, VELOCITY)

modelType
optional

enum (CLUSTERED)

pkCutoffHs
optional

number (double)

pkPkCutoffHs
optional

number (double)

retryCount
optional

integer (int32)

rmsCutoffHs
optional

number (double)

timeout
optional

integer (int32)

windowClearThreshold
optional

number (float)

windowSize
optional

integer (int32)

windowThreshold
optional

number (float)

ConditionModelUpdate

Name Schema

duration
optional

integer (int64)

forceHighRes
optional

boolean

startDate
optional

string

updateType
optional

string

ConditionSummary

Name Schema

beaconId
optional

string

dateEnd
optional

string

dateStart
optional

string

metricType
optional

enum (MOTION, UNKNOWN)

projectId
optional

integer (int64)

reportType
optional

enum (RAW, XTOOLS_RAW, PEAK, PEAK_TO_PEAK, RMS, CONDITION_SUMMARY, UNKNOWN)

xPeak
optional

number (double)

xPeakToPeak
optional

number (double)

xRms
optional

number (double)

yPeak
optional

number (double)

yPeakToPeak
optional

number (double)

yRms
optional

number (double)

zPeak
optional

number (double)

zPeakToPeak
optional

number (double)

zRms
optional

number (double)

ConfigBeaconBulk

Name Schema

beaconLock
optional

boolean

beaconLockMod
optional

boolean

datalog
optional

boolean

datalogAccelInterval
optional

integer (int32)

datalogLightInterval
optional

integer (int32)

datalogMagInterval
optional

integer (int32)

datalogTemperatureInterval
optional

integer (int32)

deviceIds
optional

< string > array

eddystoneTlmInterval
optional

number (float)

eddystoneTlmIntervalMod
optional

boolean

eddystoneTlmPower
optional

integer (int32)

eddystoneTlmPowerMod
optional

boolean

eddystoneUidInstance
optional

string

eddystoneUidInstanceAuto
optional

boolean

eddystoneUidInterval
optional

number (float)

eddystoneUidIntervalMod
optional

boolean

eddystoneUidMod
optional

boolean

eddystoneUidNamespace
optional

string

eddystoneUidPower
optional

integer (int32)

eddystoneUidPowerMod
optional

boolean

eddystoneUrlInterval
optional

number (float)

eddystoneUrlIntervalMod
optional

boolean

eddystoneUrlMod
optional

boolean

eddystoneUrlPower
optional

integer (int32)

eddystoneUrlPowerMod
optional

boolean

eddystoneUrlUrl
optional

string

iBeaconInterval
optional

number (float)

iBeaconIntervalMod
optional

boolean

iBeaconMajorAuto
optional

boolean

iBeaconMajorValue
optional

integer (int32)

iBeaconPower
optional

integer (int32)

iBeaconPowerMod
optional

boolean

iBeaconUuidAssignmentType
optional

string

iBeaconUuidValue
optional

string

lightInterval
optional

number (float)

lightIntervalMod
optional

boolean

lightPower
optional

integer (int32)

lightPowerMod
optional

boolean

majorMod
optional

boolean

motionInterval
optional

number (float)

motionIntervalMod
optional

boolean

motionPower
optional

integer (int32)

motionPowerMod
optional

boolean

notes
optional

string

pairingRssi
optional

integer (int32)

pairingRssiMod
optional

boolean

sBeaconInterval
optional

number (float)

sBeaconIntervalMod
optional

boolean

sBeaconPower
optional

integer (int32)

sBeaconPowerMod
optional

boolean

sBeaconTrackingInterval
optional

number (float)

sBeaconTrackingIntervalMod
optional

boolean

sBeaconTrackingPower
optional

integer (int32)

sBeaconTrackingPowerMod
optional

boolean

uuidMod
optional

boolean

ConfigBeaconConfigType

Name Schema

configType
optional

enum (CM, CM_AI, CM_AI_VELOCITY, CM_AV, CM_HIGH_SENSITIVITY, CM_LOW_POWER, CM_TRACKING, CM_TRACKING_LOW_POWER, DEFAULT, DEFAULT_LOW_POWER, LOGGING, PARKING, PANIC_BUTTON, TRACKING, TRACKING_LOW_POWER, TRACKING_ULTRA_LOW_POWER, TRACKING_CAL, TRACKING_CAL_LOW_POWER, TRACKING_IDENTITY, MLS, USER, DISTANCE_TRACKING, CM_TEMPERATURE_LOGGING)

deviceIds
optional

< string > array

notes
optional

string

ConfigBeaconFirmware

Name Schema

deviceIds
optional

< string > array

forced
optional

boolean

notes
optional

string

revision
optional

integer (int32)

version
optional

integer (int32)

ConfigBeaconSingle

Name Schema

config
optional

BeaconTemplate

deviceIds
optional

< string > array

notes
optional

string

ConfigBeaconTemplate

Name Schema

deviceIds
optional

< string > array

notes
optional

string

templateId
optional

integer (int64)

ConfigBlufiPmPolicy

Name Schema

deviceIds
optional

< string > array

wifiPmPolicyType
optional

enum (NORMAL, ALWAYS_ON)

ConfigBlufiResetInterval

Name Schema

deviceIds
optional

< string > array

resetInterval
optional

integer (int64)

ConfigBlufiTemplate

Name Schema

deviceIds
optional

< string > array

notes
optional

string

templateId
optional

integer (int64)

ConfigBlufiWifiRates

Name Schema

blufis
optional

BlufiBulkRequest

wifiRates
optional

integer (int32)

ConfigurableFeature

Name Schema

enabled
optional

boolean

featureName
optional

string

Coordinates

Name Schema

latitude
optional

number (double)

longitude
optional

number (double)

Crs

Name Schema

properties
optional

object

type
optional

enum (name, link)

CsTamperConfig

Name Schema

allowTriggerDecrement
optional

boolean

enabled
optional

boolean

intervalMillis
optional

integer (int32)

maxTriggerIncrement
optional

integer (int32)

maxValue
optional

integer (int32)

minValue
optional

integer (int32)

skipValues
optional

integer (int32)

CsvConfiguration

Name Schema

filename
optional

string

format
optional

string

header
optional

boolean

omitEmptyTailColumns
optional

boolean

quoteStrings
optional

boolean

separator
optional

string

Dashboard2OfBlufiView

Name Schema

devices
optional

< BlufiView > array

totalActive
optional

integer (int32)

totalDevices
optional

integer (int32)

totalInactive
optional

integer (int32)

totalViewActive
optional

integer (int32)

totalViewDevices
optional

integer (int32)

totalViewInactive
optional

integer (int32)

totalViewViolations
optional

integer (int32)

totalViolations
optional

integer (int32)

type
optional

string

DashboardOverview

Name Schema

totalActive
optional

integer (int32)

totalActiveBeacons
optional

integer (int32)

totalActiveBlufis
optional

integer (int32)

totalBeacons
optional

integer (int32)

totalBlufis
optional

integer (int32)

totalDevices
optional

integer (int32)

totalInactive
optional

integer (int32)

totalInactiveBeacons
optional

integer (int32)

totalInactiveBlufis
optional

integer (int32)

totalViewActive
optional

integer (int32)

totalViewActiveBeacon
optional

integer (int32)

totalViewActiveBlufi
optional

integer (int32)

totalViewDevices
optional

integer (int32)

totalViewDevicesBeacon
optional

integer (int32)

totalViewDevicesBlufi
optional

integer (int32)

totalViewInactive
optional

integer (int32)

totalViewInactiveBeacon
optional

integer (int32)

totalViewInactiveBlufi
optional

integer (int32)

totalViewViolations
optional

integer (int32)

totalViewViolationsBeacon
optional

integer (int32)

totalViewViolationsBlufi
optional

integer (int32)

totalViolatingBeacons
optional

integer (int32)

totalViolatingBlufis
optional

integer (int32)

totalViolations
optional

integer (int32)

totalViolationsBeacon
optional

integer (int32)

totalViolationsBlufi
optional

integer (int32)

type
optional

string

DashboardOverviewDevicesOfBeaconView

Name Schema

devices
optional

< BeaconView > array

totalActive
optional

integer (int32)

totalActiveBeacons
optional

integer (int32)

totalActiveBlufis
optional

integer (int32)

totalBeacons
optional

integer (int32)

totalBlufis
optional

integer (int32)

totalDevices
optional

integer (int32)

totalInactive
optional

integer (int32)

totalInactiveBeacons
optional

integer (int32)

totalInactiveBlufis
optional

integer (int32)

totalViewActive
optional

integer (int32)

totalViewActiveBeacon
optional

integer (int32)

totalViewActiveBlufi
optional

integer (int32)

totalViewDevices
optional

integer (int32)

totalViewDevicesBeacon
optional

integer (int32)

totalViewDevicesBlufi
optional

integer (int32)

totalViewInactive
optional

integer (int32)

totalViewInactiveBeacon
optional

integer (int32)

totalViewInactiveBlufi
optional

integer (int32)

totalViewViolations
optional

integer (int32)

totalViewViolationsBeacon
optional

integer (int32)

totalViewViolationsBlufi
optional

integer (int32)

totalViolatingBeacons
optional

integer (int32)

totalViolatingBlufis
optional

integer (int32)

totalViolations
optional

integer (int32)

totalViolationsBeacon
optional

integer (int32)

totalViolationsBlufi
optional

integer (int32)

type
optional

string

DashboardRecent

Name Schema

devices
optional

< BeaconView > array

recentViolations
optional

< PolicyViolation > array

totalActive
optional

integer (int32)

totalActiveBeacons
optional

integer (int32)

totalActiveBlufis
optional

integer (int32)

totalBeacons
optional

integer (int32)

totalBlufis
optional

integer (int32)

totalDevices
optional

integer (int32)

totalInactive
optional

integer (int32)

totalInactiveBeacons
optional

integer (int32)

totalInactiveBlufis
optional

integer (int32)

totalViewActive
optional

integer (int32)

totalViewActiveBeacon
optional

integer (int32)

totalViewActiveBlufi
optional

integer (int32)

totalViewDevices
optional

integer (int32)

totalViewDevicesBeacon
optional

integer (int32)

totalViewDevicesBlufi
optional

integer (int32)

totalViewInactive
optional

integer (int32)

totalViewInactiveBeacon
optional

integer (int32)

totalViewInactiveBlufi
optional

integer (int32)

totalViewViolations
optional

integer (int32)

totalViewViolationsBeacon
optional

integer (int32)

totalViewViolationsBlufi
optional

integer (int32)

totalViolatingBeacons
optional

integer (int32)

totalViolatingBlufis
optional

integer (int32)

totalViolations
optional

integer (int32)

totalViolationsBeacon
optional

integer (int32)

totalViolationsBlufi
optional

integer (int32)

type
optional

string

DashboardView

Name Schema

beaconQueryTime
optional

integer (int64)

blufiQueryTime
optional

integer (int64)

currentFloor
optional

integer (int32)

currentLocation
optional

Location

devices
optional

< BaseDevice > array

floorNumbers
optional

< integer (int32) > array

locations
optional

< Location > array

locusLabsEnabled
optional

boolean

scanDataProcessTime
optional

integer (int64)

scanDataQueryTime
optional

integer (int64)

scanDataTime
optional

integer (int64)

tags
optional

< Tag > array

totalBeacons
optional

integer (int32)

totalBeaconsConnected
optional

integer (int64)

totalBeaconsTime
optional

integer (int64)

totalBeaconsView
optional

integer (int32)

totalBlufiScanDataResults
optional

integer (int32)

totalBlufis
optional

integer (int32)

totalBlufisConnected
optional

integer (int64)

totalBlufisTime
optional

integer (int64)

totalBlufisView
optional

integer (int32)

totalMethodTime
optional

integer (int64)

totalPolicies
optional

integer (int32)

totalViolatingDevices
optional

integer (int32)

totalViolations
optional

integer (int32)

viewLocationId
optional

integer (int64)

violations
optional

< PolicyViolation > array

DatalogReadConfig

Name Schema

forceLegacy
optional

boolean

index
optional

integer (int32)

percentCompleted
optional

number (float)

Device

Name Schema

id
optional

string

rssi
optional

string

signal
optional

string

DeviceJob

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

blufiName
optional

string

bulkProvisioning
optional

boolean

configData
optional

BeaconTemplate

configType
optional

string

currentState
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

deviceJobId
optional

integer (int64)

deviceJobScheduleId
optional

integer (int64)

emailAddresses
optional

string

encrKey
optional

string

endDate
optional

integer (int64)

managerType
optional

string

notes
optional

string

postProcessingData
optional

object

projectId
optional

integer (int64)

resultData
optional

string

retryCount
optional

integer (int32)

retryIndex
optional

integer (int32)

scanModeId
optional

integer (int64)

sessionId
optional

string

startDate
optional

integer (int64)

timeout
optional

integer (int64)

webSocketSessionId
optional

string

DeviceJobBulk

Name Schema

deviceIds
optional

< string > array

deviceJob
optional

DeviceJob

DeviceJobCancel

Name Schema

beaconId
optional

string

deviceJobId
optional

integer (int64)

projectId
optional

integer (int64)

successCount
optional

integer (int32)

DeviceJobCancelBulk

Name Schema

beaconIds
optional

< string > array

deviceJobIds
optional

< integer (int64) > array

projectId
optional

integer (int64)

successCount
optional

integer (int32)

DeviceJobDetail

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

blufiName
optional

string

bulkProvisioning
optional

boolean

configData
optional

BeaconTemplate

configType
optional

string

currentState
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceJobId
optional

integer (int64)

deviceJobScheduleId
optional

integer (int64)

emailAddresses
optional

string

endDate
optional

integer (int64)

managerType
optional

string

notes
optional

string

postProcessingData
optional

object

projectId
optional

integer (int64)

retryCount
optional

integer (int32)

retryIndex
optional

integer (int32)

scanModeId
optional

integer (int64)

sessionId
optional

string

startDate
optional

integer (int64)

timeout
optional

integer (int64)

DeviceJobFromSchedule

Name Schema

beaconIds
optional

< string > array

startDate
optional

string

DeviceJobLite

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

blufiName
optional

string

bulkProvisioning
optional

boolean

configType
optional

string

currentState
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceJobId
optional

integer (int64)

deviceJobScheduleId
optional

integer (int64)

emailAddresses
optional

string

endDate
optional

integer (int64)

managerType
optional

string

notes
optional

string

projectId
optional

integer (int64)

retryCount
optional

integer (int32)

retryIndex
optional

integer (int32)

scanModeId
optional

integer (int64)

sessionId
optional

string

startDate
optional

integer (int64)

timeout
optional

integer (int64)

DeviceJobLog

Name Schema

blufiId
optional

integer (int64)

dateCreated
optional

integer (int64)

description
optional

string

deviceJobId
optional

integer (int64)

deviceJobLogId
optional

integer (int64)

state
optional

string

webSocketSessionId
optional

string

DeviceJobRequest

Name Schema

beaconIds
optional

< string > array

blufiIds
optional

< integer (int64) > array

configTypes
optional

< string > array

currentStates
optional

< string > array

deviceJobScheduleIds
optional

< integer (int64) > array

forDate
optional

string

fromDate
optional

string

page
optional

integer (int32)

pageSize
optional

integer (int32)

sortBy
optional

string

sortDirection
optional

string

toDate
optional

string

DeviceJobSchedule

Name Schema

active
optional

boolean

beacons
optional

< SimpleDevice > array

configData
optional

BeaconTemplate

configType
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceJobScheduleId
optional

integer (int64)

emailAddresses
optional

string

name
optional

string

notes
optional

string

policyId
optional

integer (int64)

postProcessingData
optional

object

projectId
optional

integer (int64)

systemGenerated
optional

boolean

triggerData
optional

DeviceJobTriggerConfig

triggerType
optional

string

DeviceJobScheduleCreate

Name Schema

beaconIds
optional

< string > array

deviceJobSchedule
optional

DeviceJobSchedule

DeviceJobScheduleLite

Name Schema

active
optional

boolean

configType
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceJobScheduleId
optional

integer (int64)

emailAddresses
optional

string

name
optional

string

notes
optional

string

policyId
optional

integer (int64)

projectId
optional

integer (int64)

systemGenerated
optional

boolean

triggerType
optional

string

DeviceJobTemplate

Name Schema

deviceIds
optional

< string > array

deviceJob
optional

DeviceJob

templateId
optional

integer (int64)

DeviceJobTriggerConfig

Name Schema

interval
optional

integer (int64)

offset
optional

integer (int64)

startDate
optional

integer (int64)

waitForCompletion
optional

boolean

DeviceMfgInfo

Name Schema

batteryType
optional

integer (int64)

batteryVoltage
optional

integer (int64)

bcnAdvFlags
optional

integer (int64)

calData
optional

string

capabilities
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

deviceMfgInfoId
optional

integer (int64)

deviceType
optional

integer (int64)

ethMacAddr
optional

string

exportId
optional

integer (int64)

exportInvalidated
optional

boolean

fileName
optional

string

firmwareRev
optional

integer (int64)

firmwareString
optional

string

id128
optional

string

id64
optional

string

keyData
optional

string

macAddress
optional

string

partNumber
optional

integer (int64)

sensorFlags
optional

integer (int64)

wifiMacAddress
optional

string

DeviceRegistry

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

deviceType
optional

string

eddystoneUidInstance
optional

string

eddystoneUidNamespace
optional

string

firmwareType
optional

string

firmwareVersion
optional

integer (int32)

floorNumber
optional

integer (int32)

id64
optional

string

latitude
optional

number (double)

longitude
optional

number (double)

macAddress
optional

string

major
optional

integer (int32)

metaData
optional

object

minor
optional

integer (int32)

name
optional

string

status
optional

string

tags
optional

< string > array

uuid
optional

string

DeviceSearch

Name Schema

beaconId
optional

string

floorNumber
optional

integer (int32)

includeScanData
optional

boolean

locationId
optional

integer (int64)

tagIds
optional

< integer (int64) > array

DeviceSelfie

Name Schema

contentType
optional

string

data
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

name
optional

string

overlayRadius
optional

number (double)

overlayX
optional

number (double)

overlayY
optional

number (double)

projectId
optional

integer (int64)

selfieId
optional

integer (int64)

url
optional

string

DeviceStatsProperties

Name Schema

avgDataCtrlRssi
optional

integer (int32)

avgMgmtRssi
optional

integer (int32)

batteryCharging
optional

boolean

batteryVoltage
optional

number (float)

binaryMessageBytes
optional

integer (int64)

conFail
optional

integer (int64)

conSuccess
optional

integer (int64)

connectionRTT
optional

integer (int64)

fcsErrorPackets
optional

integer (int32)

lightLevels
optional

< number (float) > array

packetReceived
optional

integer (int32)

packetsDropped
optional

integer (int32)

packetsLost
optional

integer (int32)

plcpErrorPackets
optional

integer (int32)

recvBytes
optional

integer (int64)

recvPackets
optional

integer (int64)

sendBytes
optional

integer (int64)

sendPackets
optional

integer (int64)

temperature
optional

number (float)

type
optional

string

validPackets
optional

integer (int32)

DeviceTemplate

Name Schema

configType
optional

enum (CM, CM_AI, CM_AI_VELOCITY, CM_AV, CM_HIGH_SENSITIVITY, CM_LOW_POWER, CM_TRACKING, CM_TRACKING_LOW_POWER, DEFAULT, DEFAULT_LOW_POWER, LOGGING, PARKING, PANIC_BUTTON, TRACKING, TRACKING_LOW_POWER, TRACKING_ULTRA_LOW_POWER, TRACKING_CAL, TRACKING_CAL_LOW_POWER, TRACKING_IDENTITY, MLS, USER, DISTANCE_TRACKING, CM_TEMPERATURE_LOGGING)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

iBeacon
optional

boolean

name
optional

string

sBeacon
optional

boolean

securityType
optional

WifiSecurityType

ssid
optional

string

templateId
optional

integer (int64)

DeviceType

Name Schema

active
optional

boolean

blufi
optional

boolean

code
optional

string

deviceTypeId
optional

integer (int64)

name
optional

string

DwellMonitorView

Name Schema

beaconId
optional

string

beaconName
optional

string

blufiId
optional

integer (int64)

blufiName
optional

string

policyId
optional

integer (int64)

policyName
optional

string

totalTime
optional

integer (int64)

totalTimeHuman
optional

string

EddystoneTlm

Name Schema

adapter
optional

Adapter

batt
optional

integer (int32)

frameCount
optional

integer (int32)

revision
optional

integer (int32)

temp
optional

number (float)

type
optional

string

uptime
optional

integer (int32)

EddystoneUid

Name Schema

adapter
optional

Adapter

instanceIdentifier
optional

string

measuredPower
optional

integer (int32)

namespaceIdentifier
optional

string

type
optional

string

EddystoneUrl

Name Schema

adapter
optional

Adapter

measuredPower
optional

integer (int32)

type
optional

string

url
optional

string

Email

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

emailAddress
optional

string

emailId
optional

integer (int64)

enabled
optional

boolean

firstName
optional

string

lastName
optional

string

verified
optional

boolean

EncodedPayload

Name Schema

key
optional

string

payload
optional

string

EncryptionResponse

Name Schema

commandDelayMillis
optional

integer (int32)

commands
optional

< string > array

description
optional

string

error
optional

string

gid
optional

string

status
optional

string

EncryptionSetup

Name Schema

commandIds
optional

< string > array

commandResponses
optional

< string > array

ErrorMessage

Name Schema

args
optional

< string > array

code
optional

integer (int32)

dateTime
optional

string

debugMessage
optional

string

debugStack
optional

string

message
optional

string

timestamp
optional

integer (int64)

type
optional

string

ExportInfo

Name Schema

accountId
optional

integer (int64)

apiToken
optional

string

apiVersion
optional

string

cloudProvider
optional

string

enableBlufiRedirect
optional

boolean

environment
optional

string

exportedTime
optional

string

hostname
optional

string

projectId
optional

integer (int64)

sessionId
optional

string

targetHostname
optional

string

Feature

Name Schema

featureName
optional

string

File

Name Schema

absolute
optional

boolean

absoluteFile
optional

file

absolutePath
optional

string

canonicalFile
optional

file

canonicalPath
optional

string

directory
optional

boolean

executable
optional

boolean

file
optional

boolean

freeSpace
optional

integer (int64)

hidden
optional

boolean

lastModified
optional

integer (int64)

name
optional

string

parent
optional

string

parentFile
optional

file

path
optional

string

readable
optional

boolean

totalSpace
optional

integer (int64)

usableSpace
optional

integer (int64)

writable
optional

boolean

FileData

Name Schema

data
optional

< string (byte) > array

fileName
optional

string

FilterOptions

Name Schema

logic
optional

enum (AND, OR)

parameters
optional

CollectionOfFilterParameters

FilterParameters

Name Schema

field
optional

string

operator
optional

enum (EQ, NEQ, ISNULL, ISNOTNULL, ISEMPTY, ISNOTEMPTY, STARTSWITH, CONTAINS, DOESNOTCONTAIN, ENDSWITH, ISNULLOREMPTY, ISNOTNULLOREMPTY, GTE, GT, LTE, LT)

value
optional

string

FilterSortRequest

Name Schema

filterOptions
optional

FilterOptions

sortOptions
optional

SortOptions

Firmware

Name Schema

deviceType
optional

DeviceType

firmwareId
optional

integer (int64)

type
optional

string

version
optional

integer (int32)

FirmwareConfig

Name Schema

allowDowngrade
optional

boolean

firmwareImageAltId
optional

integer (int64)

firmwareImageIds
optional

< integer (int64) > array

firmwareLoaderAltId
optional

integer (int64)

forced
optional

boolean

FirmwareImage

Name Schema

build
optional

integer (int32)

dateCreated
optional

integer (int64)

dateReleased
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

deviceTypes
optional

string

firmwareImageId
optional

integer (int64)

headerUuid
optional

string

imageType
optional

enum (BLE_COLLECTION, BLE_LEGACY, BLUFI_SERVICE_PACK, BLUFI_WIFI)

name
optional

string

notes
optional

string

revision
optional

integer (int32)

revisionString
optional

string

status
optional

enum (BETA, OPEN_BETA, RELEASE)

version
optional

integer (int32)

FirmwareImageDefault

Name Schema

build
optional

integer (int32)

dateCreated
optional

integer (int64)

dateReleased
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

deviceTypes
optional

string

firmwareImageId
optional

integer (int64)

headerUuid
optional

string

imageType
optional

enum (BLE_COLLECTION, BLE_LEGACY, BLUFI_SERVICE_PACK, BLUFI_WIFI)

name
optional

string

notes
optional

string

revision
optional

integer (int32)

revisionString
optional

string

status
optional

enum (BETA, OPEN_BETA, RELEASE)

systemDefault
optional

boolean

version
optional

integer (int32)

FirmwareUpdate

Name Schema

firmwareVersion
optional

integer (int32)

nextFirmwareVersion
optional

integer (int32)

systemDefault
optional

boolean

FirmwareUpdateStrings

Name Schema

firmwareVersion
optional

string

nextFirmwareVersion
optional

string

systemDefault
optional

boolean

GeoJsonObject

Name Schema

bbox
optional

< number (double) > array

crs
optional

Crs

HeartRate

Name Schema

adapter
optional

Adapter

bpm
optional

integer (int32)

type
optional

string

HistoryMetricRequest

Name Schema

beaconIds
optional

< string > array

blufiIds
optional

< string > array

download
optional

boolean

endDate
optional

string

includeHeader
optional

boolean

interval
optional

string

metric
optional

string

projectId
optional

integer (int64)

provider
optional

string

startDate
optional

string

HotelLoaderJob

Name Schema

address
optional

string

beaconTemplateId
optional

integer (int64)

beaconTemplateName
optional

string

blufiTemplateId
optional

integer (int64)

blufiTemplateName
optional

string

callbackUrl
optional

string

csvFileUri
optional

string

currentState
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

emailAddress
optional

string

hotelLoaderJobId
optional

integer (int64)

projectId
optional

integer (int64)

HotelLoaderJobLog

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

hotelLoaderJobId
optional

integer (int64)

hotelLoaderJobLogId
optional

integer (int64)

message
optional

string

HotelingLocationSetting

Name Schema

countMeetingBlufis
optional

boolean

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

greeting
optional

string

hotelingLocationSettingId
optional

integer (int64)

ignoreBlufiIds
optional

< integer (int64) > array

mapRotation
optional

integer (int32)

markerFileUri
optional

string

markerLatitude
optional

number (double)

markerLongitude
optional

number (double)

markerScale
optional

number (double)

meetingBlufiIds
optional

< integer (int64) > array

projectId
optional

integer (int64)

useRssi
optional

boolean

watermarkFileUri
optional

string

watermarkLatitude
optional

number (double)

watermarkLongitude
optional

number (double)

watermarkScale
optional

number (double)

zoom
optional

integer (int32)

HotelingSetting

Name Schema

color
optional

string

hotelingSettingId
optional

integer (int64)

logoFileUrl
optional

string

packets
optional

integer (int32)

pollingInterval
optional

integer (int32)

projectId
optional

integer (int64)

radiusMeters
optional

number (float)

thresholdMinutes
optional

integer (int32)

HotelingSummary

Name Description Schema

available
optional

Example : "null"

integer (int32)

locationId
optional

Example : "null"

integer (int64)

occupancyMap
optional

Example : "null"

< string, Occupancy > map

occupied
optional

Example : "null"

integer (int32)

population
optional

Example : "null"

integer (int32)

IBeacon

Name Schema

adapter
optional

Adapter

id
optional

string

major
optional

integer (int32)

measuredPower
optional

integer (int32)

minor
optional

integer (int32)

type
optional

string

uuid
optional

string

IBeaconConfigUploadJob

Name Schema

accountId
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

errorCode
optional

string

errorMessage
optional

string

errorParamList
optional

< string > array

jobId
optional

integer (int64)

projectId
optional

integer (int64)

status
optional

enum (NOT_RUNNING, INIT_PROCESSING, RUNNING_VALIDATION, RUNNING_BULK_SAVE, FINISHED_SUCCESS, FINISHED_FAILURE)

statusCode
optional

integer (int32)

IBeaconConfiguration

Name Schema

beacon
optional

BeaconLite

beaconId
optional

string

blufi
optional

BlufiLite

blufiSid64
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceName
optional

string

deviceType
optional

string

ibeaconConfigId
optional

integer (int64)

ibeaconInterval
optional

number (float)

ibeaconMajor
optional

integer (int32)

ibeaconMinor
optional

integer (int32)

ibeaconPower
optional

integer (int32)

ibeaconRssiOffset
optional

integer (int32)

ibeaconStatus
optional

string

ibeaconUuid
optional

string

id64
optional

string

macAddress
optional

string

projectId
optional

integer (int64)

InputStream

Type : object

InstallerTestLog

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

installerTestLogId
optional

integer (int64)

log
optional

string

policies
optional

< integer (int64) > array

projectId
optional

integer (int64)

IntersectionGroup

Name Description Schema

id
optional

Example : "null"

string

intersectionCoords
optional

Example : "null"

< BeaconLocation > array

intersectionPoint
optional

BeaconLocation

newCoord
optional

BeaconLocation

startingCoord
optional

BeaconLocation

KmxConfig

Name Schema

enabledSensors
optional

enum (NONE, ACCEL, MAG, ACCEL_MAG, MAG_TEMP, ALL)

fifoBufferMax
optional

integer (int32)

fifoReadOffset
optional

integer (int32)

fullScale
optional

enum (RANGE_8G, RANGE_16G, RANGE_32G, RANGE_64G)

kmxConfigId
optional

integer (int64)

rateAccelerometer
optional

integer (int32)

rateMagnetometer
optional

integer (int32)

resolution
optional

enum (OVERSAMPLE_4_2, OVERSAMPLE_32_16, OVERSAMPLE_MAX)

KmxReadConfig

Name Schema

samples
optional

integer (int32)

sensorConfig
optional

KmxConfig

summarySamples
optional

integer (int32)

Label

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

labelId
optional

integer (int64)

labelValues
optional

< LabelValue > array

name
optional

string

projectId
optional

integer (int64)

LabelValue

Name Schema

color
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

labelId
optional

integer (int64)

labelName
optional

string

labelValueId
optional

integer (int64)

projectId
optional

integer (int64)

value
optional

string

LdapConnector

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

ldapConnectorId
optional

integer (int64)

ldapPassword
optional

string

ldapSearchBase
optional

string

ldapUri
optional

string

ldapUsername
optional

string

name
optional

string

projectId
optional

integer (int64)

status
optional

string

LdapConnectorEntity

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

ldapConnectorId
optional

integer (int64)

ldapPassword
optional

string

ldapSearchBase
optional

string

ldapUri
optional

string

ldapUsername
optional

string

name
optional

string

projectId
optional

integer (int64)

status
optional

enum (NEW, STARTING_TEST, TESTING, CONNECTED, DISCONNECTED, ERROR, DELETING, DELETED)

LeMotionConfig

Name Schema

advCycle
optional

integer (int32)

cutoff
optional

integer (int32)

enableHpf
optional

boolean

enabled
optional

boolean

fullScale
optional

integer (int32)

motionConfigId
optional

integer (int64)

motionDbn
optional

integer (int32)

motionEnabled
optional

boolean

motionThr
optional

integer (int32)

motionX
optional

boolean

motionY
optional

boolean

motionZ
optional

boolean

rate
optional

integer (int32)

transDbn
optional

integer (int32)

transEnabled
optional

boolean

transThr
optional

integer (int32)

transX
optional

boolean

transY
optional

boolean

transZ
optional

boolean

Location

Name Schema

address
optional

string

assetTrackingEnabled
optional

boolean

bearing
optional

integer (int32)

bounds
optional

string

boundsGeojson
optional

string

boxCalibrationComplete
optional

boolean

cntrLatitude
optional

number (double)

cntrLongitude
optional

number (double)

dataFileExtension
optional

string

dataFileName
optional

string

dataFileUrl
optional

string

dataFurnitureUri
optional

string

dataLegalSpaceUri
optional

string

dataPortalsUri
optional

string

dataRoomsUri
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

floorNumber
optional

integer (int32)

hotelingSetting
optional

HotelingLocationSetting

humanCalibrationComplete
optional

boolean

locationId
optional

integer (int64)

mapProviderAirportId
optional

string

mapProviderApiKey
optional

string

mapProviderBuildingId
optional

string

mapProviderMapId
optional

string

mapProviderType
optional

string

metalCalibrationComplete
optional

boolean

name
optional

string

neLatitude
optional

number (double)

neLongitude
optional

number (double)

opacity
optional

number (double)

projectId
optional

integer (int64)

swLatitude
optional

number (double)

swLongitude
optional

number (double)

LocationDataLayers

Name Schema

furniture
optional

string

legalSpace
optional

string

portals
optional

string

rooms
optional

string

LocationPacket

Name Schema

altitude
optional

number (double)

battery
optional

integer (int32)

calculatedTimestamp
optional

string

deviceName
optional

string

floorNumber
optional

integer (int32)

id
optional

string

latitude
optional

number (double)

location
optional

string

locationId
optional

integer (int64)

longitude
optional

number (double)

mac
optional

string

maxTimestamp
optional

string

projectId
optional

integer (int64)

timestamp
optional

string

type
optional

string

variance
optional

number (double)

varianceX
optional

number (double)

varianceY
optional

number (double)

varianceZ
optional

number (double)

windowCount
optional

integer (int32)

LocationSummary

Name Schema

beaconCount
optional

integer (int64)

blufiConnectedCount
optional

integer (int64)

blufiCount
optional

integer (int64)

virtualBlufiCount
optional

integer (int64)

LtxReadReport

Name Schema

eventTimestamp
optional

integer (int64)

ltxBeaconId
optional

string

ltxBeaconName
optional

string

projectId
optional

integer (int64)

scanBeaconId
optional

string

scanBeaconName
optional

string

LtxScanConfig

Name Schema

advDuration
optional

integer (int32)

advInterval
optional

number (float)

advTxPower
optional

integer (int32)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

ltxScanConfigId
optional

integer (int64)

scanConfiguration
optional

BeaconScanConfig

Mag

Name Schema

adapter
optional

Adapter

flags
optional

integer (int32)

id
optional

string

msTime
optional

integer (int64)

time
optional

integer (int32)

type
optional

string

xMag
optional

number (double)

yMag
optional

number (double)

zMag
optional

number (double)

MagAdDataStateAggregation

Name Schema

beaconId
optional

string

closed
optional

boolean

duration
optional

integer (int64)

temp
optional

number (float)

timestamp
optional

integer (int64)

xMag
optional

number (double)

yMag
optional

number (double)

zMag
optional

number (double)

MagStateAggregation

Name Schema

beaconId
optional

string

date
optional

string

duration
optional

string

opened
optional

boolean

temp
optional

number (float)

xMag
optional

number (double)

yMag
optional

number (double)

zMag
optional

number (double)

Major

Name Schema

majorId
optional

integer (int64)

uuidId
optional

integer (int64)

value
optional

integer (int32)

McMotionConfig

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

fifoReadSize
optional

integer (int32)

fullScale
optional

integer (int32)

mcMotionConfigId
optional

integer (int64)

mode
optional

integer (int32)

powerMode
optional

integer (int32)

rateControl
optional

integer (int32)

sniffControl
optional

integer (int32)

sniffCountX
optional

integer (int32)

sniffCountY
optional

integer (int32)

sniffCountZ
optional

integer (int32)

sniffThrRange
optional

integer (int32)

sniffThrX
optional

integer (int32)

sniffThrY
optional

integer (int32)

sniffThrZ
optional

integer (int32)

sniffWakeCount
optional

integer (int32)

MlsSetting

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enableRotation
optional

boolean

mlsSettingId
optional

integer (int64)

projectId
optional

integer (int64)

rotationInterval
optional

integer (int32)

uuids
optional

< string > array

Motion

Name Schema

adapter
optional

Adapter

flags
optional

integer (int32)

id
optional

string

msTime
optional

integer (int64)

time
optional

integer (int32)

type
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

MotionConditionComparator

Name Schema

motionConditionComparatorId
optional

integer (int64)

operatorType
optional

enum (GREATER_THAN_OR_EQUALS, LESSER_THAN_OR_EQUALS)

selector
optional

integer (int32)

threshold
optional

number (double)

MotionConditionConfig

Name Schema

advIntervalScale
optional

number (double)

bufferLimit
optional

integer (int32)

bufferUpdateLimit
optional

integer (int32)

enabled
optional

boolean

highSpeedConfig
optional

MotionConditionStateConfig

lowSpeedConfig
optional

MotionConditionStateConfig

motionConditionConfigId
optional

integer (int64)

outputMultiplier
optional

number (double)

updateInterval
optional

number (double)

version
optional

integer (int32)

MotionConditionField

Name Schema

encodedValue
optional

integer (int64)

shift
optional

integer (int32)

MotionConditionStateConfig

Name Schema

comparator1
optional

MotionConditionComparator

comparator2
optional

MotionConditionComparator

comparator3
optional

MotionConditionComparator

comparator4
optional

MotionConditionComparator

comparator5
optional

MotionConditionComparator

comparator6
optional

MotionConditionComparator

comparatorMask
optional

string

cutoff
optional

integer (int32)

dropSamples
optional

integer (int32)

durationMax
optional

number (double)

durationMin
optional

number (double)

kmxMotionConfiguration
optional

KmxConfig

kmxRate
optional

integer (int32)

motionConditionStateConfigId
optional

integer (int64)

numSamples
optional

integer (int32)

outputFields
optional

integer (int64)

rate
optional

integer (int32)

MotionData

Name Schema

battery
optional

integer (int32)

beaconId
optional

string

temp
optional

number (float)

timestamp
optional

integer (int64)

totalCounters
optional

integer (int32)

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

MotionFrame

Name Schema

battery
optional

integer (int32)

beaconId
optional

string

temp
optional

number (float)

timestamp
optional

integer (int64)

totalCounters
optional

integer (int32)

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

MusteringZone

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

musteringZoneId
optional

integer (int64)

name
optional

string

projectId
optional

integer (int64)

NotificationSubscription

Name Schema

asset
optional

Asset

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

email
optional

Email

notificationSubscriptionId
optional

integer (int64)

notificationTypes
optional

< enum (GREEN, GREEN_YELLOW, YELLOW, RED) > array

status
optional

enum (PENDING, SUBSCRIBED, DECLINED, UNSUBSCRIBED, INVALID)

Number

Type : object

Occupancy

Name Description Schema

beacons
optional

Example : "null"

< BeaconLocation > array

deviceId
optional

Example : "null"

integer (int64)

latitude
optional

Example : "null"

number (double)

longitude
optional

Example : "null"

number (double)

occupied
optional

Example : false

boolean

status
optional

Example : "null"

string

type
optional

Example : "null"

string

PageResponseOfBeaconReadReport

Name Schema

content
optional

< BeaconReadReport > array

hasNext
optional

boolean

hasPrevious
optional

boolean

isFirst
optional

boolean

isLast
optional

boolean

pageElements
optional

integer (int32)

pageNumber
optional

integer (int32)

pageToken
optional

string

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

PageResponseOfDeviceJobLite

Name Schema

content
optional

< DeviceJobLite > array

hasNext
optional

boolean

hasPrevious
optional

boolean

isFirst
optional

boolean

isLast
optional

boolean

pageElements
optional

integer (int32)

pageNumber
optional

integer (int32)

pageToken
optional

string

totalElements
optional

integer (int64)

totalPages
optional

integer (int32)

PanicButtonDashboardView

Name Schema

activeAlertCount
optional

integer (int64)

panicButtonViolationHistList
optional

CollectionOfPanicButtonViolationHistView

totalActiveBlufis
optional

integer (int64)

totalBlufis
optional

integer (int64)

PanicButtonViolationHistView

Name Schema

beaconId
optional

string

beaconName
optional

string

blufiId
optional

integer (int64)

dateCreated
optional

Timestamp

eventUuid
optional

string

locationName
optional

string

nearestBeaconDeviceId
optional

string

nearestBlufi
optional

string

nearestBlufiLatitude
optional

number (double)

nearestBlufiLocationId
optional

integer (int64)

nearestBlufiLongitude
optional

number (double)

state
optional

string

value
optional

string

PanicValue

Name Schema

c
optional

integer (int32)

d
optional

string

i
optional

boolean

t
optional

integer (int32)

v
optional

integer (int64)

PeakMotion

Name Schema

beaconId
optional

string

dateEnd
optional

string

dateStart
optional

string

metricType
optional

enum (MOTION, UNKNOWN)

projectId
optional

integer (int64)

reportType
optional

enum (RAW, XTOOLS_RAW, PEAK, PEAK_TO_PEAK, RMS, CONDITION_SUMMARY, UNKNOWN)

x
optional

number (double)

xAccel
optional

number (double)

xTimestamp
optional

integer (int64)

y
optional

number (double)

yAccel
optional

number (double)

yTimestamp
optional

integer (int64)

z
optional

number (double)

zAccel
optional

number (double)

zTimestamp
optional

integer (int64)

PeakToPeakMotion

Name Schema

beaconId
optional

string

dateEnd
optional

string

dateStart
optional

string

metricType
optional

enum (MOTION, UNKNOWN)

projectId
optional

integer (int64)

reportType
optional

enum (RAW, XTOOLS_RAW, PEAK, PEAK_TO_PEAK, RMS, CONDITION_SUMMARY, UNKNOWN)

x
optional

number (double)

y
optional

number (double)

z
optional

number (double)

PirConfig

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deadTime
optional

integer (int32)

enableFastUpdate
optional

boolean

enableLedIndicator
optional

boolean

enabled
optional

boolean

filter
optional

PirFilter

filterDecimation
optional

integer (int32)

filterOutputDecimation
optional

integer (int32)

filterOutputSize
optional

integer (int32)

pirConfigId
optional

integer (int64)

readInterval
optional

number (float)

resetCount
optional

integer (int32)

resetLevel
optional

integer (int32)

resetTime
optional

integer (int32)

triggerCount
optional

integer (int32)

triggerLevel
optional

integer (int32)

PirFilter

Name Schema

coeffs
optional

< integer (int32) > array

filterSize
optional

integer (int32)

pirFilterId
optional

integer (int64)

Policy

Name Schema

ambientBeacons
optional

< AmbientBeacon > array

anchorBlufis
optional

< PolicyBlufi > array

autoClearEnabled
optional

boolean

autoClearOperatorType
optional

enum (EQUALS, NOT_EQUALS, GREATER_THAN, LESSER_THAN, GREATER_THAN_OR_EQUALS, LESSER_THAN_OR_EQUALS, BETWEEN, OUTSIDE, ENTER, LEAVE, SEARCH, MOVEMENT, AT_REST, UNKNOWN, PARKED, NOT_PARKED)

autoClearRssiThreshold
optional

number (float)

autoClearTimeout
optional

integer (int64)

autoClearType
optional

enum (BY_METRIC, BY_POLICY)

blufisInZone
optional

< string > array

bounds
optional

string

boundsGeojson
optional

string

conditionModelTemplate
optional

ConditionModelTemplate

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

deviceCount
optional

integer (int32)

deviceJobSchedules
optional

< DeviceJobScheduleLite > array

duration
optional

integer (int64)

emailAddresses
optional

< string > array

enabled
optional

boolean

entryBlufi
optional

PolicyBlufi

exitBlufi
optional

PolicyBlufi

foreignLocationAsOut
optional

boolean

globalScope
optional

boolean

interior
optional

boolean

labelValues
optional

< LabelValue > array

locationId
optional

integer (int64)

managedBeaconIds
optional

< string > array

managedBlufiIds
optional

< integer (int64) > array

metricType
optional

enum (PRESENCE, BATTERY, TEMPERATURE, AMBIENT_TEMPERATURE, MOTION, GEOFENCE, DISTANCE, WEAKCONNECTION, WIFIPROBEQUEUE, MOTION_TRIGGER, PROXIMITY_ALERT, ENTER_EXIT, LOCATION_CHANGE, MOTION_CONDITION, MAGNETOMETER, TAMPER, PANIC_BUTTON, PARKING, ENTERPRISE_PRESENCE, VIBRATION_THRESHOLD, DISTANCE_VIOLATION, UNKNOWN)

missingDataSeconds
optional

integer (int32)

missingDataType
optional

enum (STAY_THE_SAME, OK, VIOLATE)

name
optional

string

namespace
optional

enum (BLUFI, BEACON, UNKNOWN)

operatorType
optional

enum (EQUALS, NOT_EQUALS, GREATER_THAN, LESSER_THAN, GREATER_THAN_OR_EQUALS, LESSER_THAN_OR_EQUALS, BETWEEN, OUTSIDE, ENTER, LEAVE, SEARCH, MOVEMENT, AT_REST, UNKNOWN, PARKED, NOT_PARKED)

period
optional

integer (int64)

policyId
optional

integer (int64)

policyTrigger
optional

enum (UNKNOWN, ENTER_EXIT, LOCATION)

projectId
optional

integer (int64)

regions
optional

GeoJsonObject

sampleInterval
optional

integer (int64)

scope
optional

enum (DEVICE, GLOBAL, LABELS, UNKNOWN)

shopperTrackEventId
optional

integer (int64)

smsIds
optional

< integer (int64) > array

threshold
optional

number (float)

thresholdHyst
optional

number (float)

thresholdRange
optional

< number (float) > array

varianceThreshold
optional

integer (int32)

vibrationMetric
optional

string

vibrationMetricUnit
optional

string

zoneBeacons
optional

< string > array

PolicyBlufi

Name Schema

alloyVersion
optional

string

altitude
optional

number (float)

bluetoothFWRev
optional

integer (int32)

bluetoothMac
optional

string

bssid
optional

string

cloudUrl
optional

string

deviceId
optional

integer (int64)

dnsIpAddress
optional

string

enabledWifiRates
optional

integer (int32)

ethDnsIpAddress
optional

string

ethGwIpAddress
optional

string

ethIpAddress
optional

string

ethMac
optional

string

goArch
optional

string

goVersion
optional

string

goos
optional

string

gwIpAddress
optional

string

ipAddress
optional

string

latitude
optional

number (double)

longitude
optional

number (double)

nwpVersion
optional

string

resetReason
optional

string

sid64
optional

string

ssid
optional

string

wifiFWRev
optional

integer (int32)

wifiMac
optional

string

PolicyDeviceStatus

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

eventUuid
optional

string

metric
optional

enum (PRESENCE, BATTERY, TEMPERATURE, AMBIENT_TEMPERATURE, MOTION, GEOFENCE, DISTANCE, WEAKCONNECTION, WIFIPROBEQUEUE, MOTION_TRIGGER, PROXIMITY_ALERT, ENTER_EXIT, LOCATION_CHANGE, MOTION_CONDITION, MAGNETOMETER, TAMPER, PANIC_BUTTON, PARKING, ENTERPRISE_PRESENCE, VIBRATION_THRESHOLD, DISTANCE_VIOLATION, UNKNOWN)

namespace
optional

enum (BLUFI, BEACON, UNKNOWN)

policyId
optional

integer (int64)

projectId
optional

integer (int64)

state
optional

enum (OK, VIOLATING, ENTER, EXIT, ADMIN_CLOSED, UNKNOWN)

timestamp
optional

integer (int64)

value
optional

string

PolicyDeviceStatusEnhanced

Name Schema

beaconId
optional

string

beaconName
optional

string

blufiId
optional

integer (int64)

blufiName
optional

string

eventUuid
optional

string

metric
optional

enum (PRESENCE, BATTERY, TEMPERATURE, AMBIENT_TEMPERATURE, MOTION, GEOFENCE, DISTANCE, WEAKCONNECTION, WIFIPROBEQUEUE, MOTION_TRIGGER, PROXIMITY_ALERT, ENTER_EXIT, LOCATION_CHANGE, MOTION_CONDITION, MAGNETOMETER, TAMPER, PANIC_BUTTON, PARKING, ENTERPRISE_PRESENCE, VIBRATION_THRESHOLD, DISTANCE_VIOLATION, UNKNOWN)

namespace
optional

enum (BLUFI, BEACON, UNKNOWN)

policyId
optional

integer (int64)

policyName
optional

string

projectId
optional

integer (int64)

state
optional

enum (OK, VIOLATING, ENTER, EXIT, ADMIN_CLOSED, UNKNOWN)

timestamp
optional

integer (int64)

value
optional

string

PolicyEvent

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

dateCleared
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

dateViolated
optional

integer (int64)

eventUuid
optional

string

metricType
optional

string

namespace
optional

string

policyEventId
optional

integer (int64)

policyId
optional

integer (int64)

projectId
optional

integer (int64)

state
optional

string

totalTime
optional

integer (int64)

value
optional

string

PolicyEventDetail

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

dateCleared
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

dateViolated
optional

integer (int64)

eventUuid
optional

string

metricType
optional

string

namespace
optional

string

policyEventId
optional

integer (int64)

policyId
optional

integer (int64)

projectId
optional

integer (int64)

state
optional

string

totalTime
optional

integer (int64)

value
optional

string

PolicyStateChangeEvent

Name Schema

beaconName
optional

string

blufiId
optional

string

blufiName
optional

string

eventUuid
optional

string

metricType
optional

enum (PRESENCE, BATTERY, TEMPERATURE, AMBIENT_TEMPERATURE, MOTION, GEOFENCE, DISTANCE, WEAKCONNECTION, WIFIPROBEQUEUE, MOTION_TRIGGER, PROXIMITY_ALERT, ENTER_EXIT, LOCATION_CHANGE, MOTION_CONDITION, MAGNETOMETER, TAMPER, PANIC_BUTTON, PARKING, ENTERPRISE_PRESENCE, VIBRATION_THRESHOLD, DISTANCE_VIOLATION, UNKNOWN)

namespace
optional

enum (BLUFI, BEACON, UNKNOWN)

newState
optional

enum (OK, VIOLATING, ENTER, EXIT, ADMIN_CLOSED, UNKNOWN)

oldState
optional

enum (OK, VIOLATING, ENTER, EXIT, ADMIN_CLOSED, UNKNOWN)

policyId
optional

integer (int64)

policyName
optional

string

projectId
optional

integer (int64)

shopperTrackEventId
optional

integer (int64)

timestamp
optional

integer (int64)

timestampCleared
optional

integer (int64)

uniqueDeviceId
optional

string

value
optional

string

PolicyStateChangeExtraEvent

Name Schema

beaconName
optional

string

blufiId
optional

string

blufiName
optional

string

duration
optional

integer (int64)

eventUuid
optional

string

metricType
optional

enum (PRESENCE, BATTERY, TEMPERATURE, AMBIENT_TEMPERATURE, MOTION, GEOFENCE, DISTANCE, WEAKCONNECTION, WIFIPROBEQUEUE, MOTION_TRIGGER, PROXIMITY_ALERT, ENTER_EXIT, LOCATION_CHANGE, MOTION_CONDITION, MAGNETOMETER, TAMPER, PANIC_BUTTON, PARKING, ENTERPRISE_PRESENCE, VIBRATION_THRESHOLD, DISTANCE_VIOLATION, UNKNOWN)

namespace
optional

enum (BLUFI, BEACON, UNKNOWN)

newState
optional

enum (OK, VIOLATING, ENTER, EXIT, ADMIN_CLOSED, UNKNOWN)

oldState
optional

enum (OK, VIOLATING, ENTER, EXIT, ADMIN_CLOSED, UNKNOWN)

policyId
optional

integer (int64)

policyName
optional

string

projectId
optional

integer (int64)

shopperTrackEventId
optional

integer (int64)

timestamp
optional

integer (int64)

timestampCleared
optional

integer (int64)

uniqueDeviceId
optional

string

value
optional

string

PolicyView

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

enabled
optional

boolean

metricType
optional

string

name
optional

string

namespace
optional

string

policyId
optional

integer (int64)

projectId
optional

integer (int64)

PolicyViolation

Name Schema

beaconId
optional

string

beaconName
optional

string

blufiId
optional

integer (int64)

blufiName
optional

string

dateCreated
optional

integer (int64)

eventUuid
optional

string

metricType
optional

string

namespace
optional

string

policyEventId
optional

integer (int64)

policyId
optional

integer (int64)

policyName
optional

string

policyViolationId
optional

integer (int64)

projectId
optional

integer (int64)

selfieUrl
optional

string

value
optional

string

PolicyViolationDevice

Name Schema

deviceId
optional

string

policyId
optional

integer (int64)

policyViolationId
optional

integer (int64)

PostProcessingConfigBeaconReadReport

ostProcessingConfigBeaconReadReport

Name Schema

configType
required

string

metricTypes
optional

< string > array

reportTypes
optional

< string > array

PostProcessingConfigFtpUploadCsv

PostProcessingConfigFtpUploadCsv

Name Schema

configType
required

string

csvConfiguration
optional

CsvConfiguration

serverConfiguration
optional

ServerConfiguration

Product

Name Schema

enabled
optional

boolean

productName
optional

string

requested
optional

boolean

ProfileData

Name Schema

channels
optional

string

description
optional

string

dnsAddress
optional

string

gatewayAddress
optional

string

hostname
optional

string

ipAddress
optional

string

name
optional

string

netMask
optional

string

networkProtocolType
optional

enum (DHCP, STATIC)

networkSelectorType
optional

enum (ANY, WIFI, ETHERNET)

ntpDisabled
optional

boolean

ntpServers
optional

string

pass
optional

string

passphrase
optional

string

proxyConfiguration
optional

ProxyConfiguration

proxyUrl
optional

string

rssiThreshold
optional

integer (int32)

securityType
optional

string

ssid
optional

string

user
optional

string

verifyCert
optional

boolean

wifiCertBase64
optional

string

wifiClientCertBase64
optional

string

wifiPrivateKeyBase64
optional

string

wifiProfileId
optional

string

Project

Name Schema

allowBeaconMinuteMetrics
optional

boolean

allowBlufiMinuteMetrics
optional

boolean

beaconMinuteMetricTtlSeconds
optional

integer (int32)

blufiHostnameNaming
optional

string

blufiMinuteMetricTtlSeconds
optional

integer (int32)

channelMigrationComplete
optional

boolean

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

defaultUuidValue
optional

string

description
optional

string

deviceJobConcurrency
optional

integer (int32)

enableAdvancedPackets
optional

boolean

enableChannelMigration
optional

boolean

enableDataUnload
optional

boolean

enableDeviceJobNotifications
optional

boolean

enableDeviceJobSweep
optional

boolean

enableDeviceTelemetry
optional

boolean

enableEmail
optional

boolean

enableGeofenceMemberService
optional

boolean

enableLocationConsumer
optional

boolean

enableLocusMaps
optional

boolean

enableMetricStorage
optional

boolean

enablePolicyConsumer
optional

boolean

enableScanConsumer
optional

boolean

enableStreamProducer
optional

boolean

enableTamper
optional

boolean

enabledBeaconMetrics
optional

integer (int32)

enabledBlufiMetrics
optional

integer (int32)

enabledPacketTypes
optional

string

firmwareUpdateStrategy
optional

string

language
optional

string

mapProviderApiKey
optional

string

mapProviderType
optional

string

name
optional

string

owner
optional

ProjectOwner

projectId
optional

integer (int64)

projectMigratedEndpoint
optional

string

reportEmailList
optional

< string > array

reportTimezone
optional

string

status
optional

string

wakeupUuid
optional

string

ProjectContext

Name Schema

policies
optional

< PolicyView > array

projectId
optional

integer (int64)

totalBeacons
optional

integer (int32)

totalBlufis
optional

integer (int32)

totalLocations
optional

integer (int32)

totalPolicies
optional

integer (int32)

totalTemplates
optional

integer (int32)

totalViolatingBeacons
optional

integer (int32)

totalViolatingBlufis
optional

integer (int32)

totalViolations
optional

integer (int32)

ProjectOwner

Name Schema

emailAddress
optional

string

username
optional

string

ProvisionTransaction

Name Schema

altitude
optional

number (float)

autoLocationName
optional

string

blufi
optional

boolean

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

encrKey
optional

string

error
optional

string

floorNumber
optional

integer (int32)

gid
optional

string

latitude
optional

number (double)

locationId
optional

integer (int64)

longitude
optional

number (double)

name
optional

string

notes
optional

string

projectId
optional

integer (int64)

provider
optional

enum (KEYVAULT, MPROV)

selfie
optional

DeviceSelfie

sid64
optional

string

status
optional

string

tags
optional

< Tag > array

templateId
optional

integer (int64)

transactionId
optional

string

ProxyConfiguration

Name Schema

authenticationEnabled
optional

boolean

enabled
optional

boolean

hostname
optional

string

password
optional

string

portNumber
optional

integer (int32)

url
optional

string

username
optional

string

RCMMessage

Name Schema

clientId
optional

string

packets
optional

< RCMPacket2 > array

sid64
optional

string

RCMPacket

Name Schema

clientId
optional

string

data
optional

< number (float) > array

deviceTime
optional

integer (int32)

interval
optional

integer (int32)

sid64
optional

string

startups
optional

integer (int32)

unixTimestamp
optional

integer (int32)

RCMPacket2

Name Schema

data
optional

object

interval
optional

integer (int32)

startups
optional

integer (int32)

timestamp
optional

integer (int64)

type
optional

string

unixTime
optional

integer (int64)

RCMRawMessage

Name Schema

clientId
optional

string

packets
optional

< RCMRawPacket > array

sid64
optional

string

RCMRawPacket

Name Schema

beaconStartupCount
optional

integer (int32)

beaconTime
optional

integer (int64)

lastIndex
optional

integer (int32)

packetData
optional

string

packetIndex
optional

integer (int32)

unixTime
optional

integer (int64)

RawCommand

Name Schema

commandType
optional

enum (CSCMD_READ, CSCMD_WRITE, STATUS_READ)

payloads
optional

< string > array

results
optional

< string > array

RawCommandConfig

Name Schema

commands
optional

< RawCommand > array

RawMetricResponse

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

dateKey
optional

integer (int64)

dateStringKey
optional

string

projectId
optional

integer (int64)

RcmImport

Name Schema

beaconId
optional

string

blufiId
optional

integer (int64)

bucket
optional

string

clientId
optional

string

dataLength
optional

integer (int32)

dateCompleted
optional

integer (int64)

dateFirstPacket
optional

integer (int64)

dateLastPacket
optional

integer (int64)

dateStarted
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceJobId
optional

integer (int64)

fileName
optional

string

importType
optional

string

keyName
optional

string

packetsLight
optional

integer (int32)

packetsMag
optional

integer (int32)

packetsMotion
optional

integer (int32)

packetsTemp
optional

integer (int32)

packetsTotal
optional

integer (int32)

projectId
optional

integer (int64)

rcmImportId
optional

integer (int64)

RemoteConsumerConfig

Name Schema

assumeRoleEnabled
optional

boolean

assumeRoleName
optional

string

awsAccessKey
optional

string

awsSecretKey
optional

string

azureEventNameSpace
optional

string

azureSasKey
optional

string

azureSasKeyName
optional

string

consumeAllPolicyEvents
optional

boolean

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enabled
optional

boolean

errorMessage
optional

string

kinesisEndpoint
optional

string

partitionKey
optional

string

policyEventTypes
optional

< enum (PRESENCE, BATTERY, TEMPERATURE, AMBIENT_TEMPERATURE, MOTION, GEOFENCE, DISTANCE, WEAKCONNECTION, WIFIPROBEQUEUE, MOTION_TRIGGER, PROXIMITY_ALERT, ENTER_EXIT, LOCATION_CHANGE, MOTION_CONDITION, MAGNETOMETER, TAMPER, PANIC_BUTTON, PARKING, ENTERPRISE_PRESENCE, VIBRATION_THRESHOLD, DISTANCE_VIOLATION, UNKNOWN) > array

projectId
optional

integer (int64)

remoteConsumerConfigId
optional

integer (int64)

status
optional

string

streamName
optional

string

streamProvider
optional

enum (AWS, AZURE)

streamType
optional

string

useStan
optional

boolean

RemoteConsumerConfigView

Name Schema

assumeRoleEnabled
optional

boolean

assumeRoleName
optional

string

awsAccessKey
optional

string

awsSecretKey
optional

string

azureEventNameSpace
optional

string

azureSasKey
optional

string

azureSasKeyName
optional

string

consumeAllPolicyEvents
optional

boolean

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enabled
optional

boolean

errorMessage
optional

string

kinesisEndpoint
optional

string

partitionKey
optional

string

policyEventTypes
optional

< enum (PRESENCE, BATTERY, TEMPERATURE, AMBIENT_TEMPERATURE, MOTION, GEOFENCE, DISTANCE, WEAKCONNECTION, WIFIPROBEQUEUE, MOTION_TRIGGER, PROXIMITY_ALERT, ENTER_EXIT, LOCATION_CHANGE, MOTION_CONDITION, MAGNETOMETER, TAMPER, PANIC_BUTTON, PARKING, ENTERPRISE_PRESENCE, VIBRATION_THRESHOLD, DISTANCE_VIOLATION, UNKNOWN) > array

projectId
optional

integer (int64)

remoteConsumerConfigId
optional

integer (int64)

status
optional

string

streamName
optional

string

streamProvider
optional

enum (AWS, AZURE)

streamType
optional

string

useStan
optional

boolean

RemoteStorageConfig

Name Schema

accessKey
optional

string

assumeRoleEnabled
optional

boolean

assumeRoleName
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enabled
optional

boolean

errorMessage
optional

string

projectId
optional

integer (int64)

remoteStorageConfigId
optional

integer (int64)

secretKey
optional

string

status
optional

string

storageProvider
optional

string

storageRegion
optional

string

storageResourceIdentifier
optional

string

storageTypes
optional

< string > array

RemoteStorageConfigView

Name Schema

accessKey
optional

string

assumeRoleEnabled
optional

boolean

assumeRoleName
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enabled
optional

boolean

errorMessage
optional

string

projectId
optional

integer (int64)

remoteStorageConfigId
optional

integer (int64)

secretKey
optional

string

status
optional

string

storageProvider
optional

string

storageRegion
optional

string

storageResourceIdentifier
optional

string

storageTypes
optional

< string > array

Resource

Name Schema

description
optional

string

file
optional

file

filename
optional

string

inputStream
optional

InputStream

open
optional

boolean

readable
optional

boolean

uri
optional

URI

url
optional

URL

RmsMotion

Name Schema

beaconId
optional

string

dateEnd
optional

string

dateStart
optional

string

metricType
optional

enum (MOTION, UNKNOWN)

projectId
optional

integer (int64)

reportType
optional

enum (RAW, XTOOLS_RAW, PEAK, PEAK_TO_PEAK, RMS, CONDITION_SUMMARY, UNKNOWN)

x
optional

number (double)

y
optional

number (double)

z
optional

number (double)

Role

Name Schema

description
optional

string

roleName
optional

string

RssiEntry

Name Schema

channel
optional

integer (int32)

rssi
optional

number (float)

sampleCount
optional

integer (int32)

RtlsSetting

Name Schema

allowOptimizedHistory
optional

boolean

assetTypeRtlsSettings
optional

< AssetTypeRtlsSetting > array

averageLocationOutput
optional

boolean

binCount
optional

integer (int32)

blufiCalibrationRangeMeters
optional

integer (int32)

blufiCalibrationRequiredSampleCount
optional

integer (int32)

boxStaticLocationMilliseconds
optional

integer (int64)

bucketMilliseconds
optional

integer (int64)

compEntryRssiAvgInterval
optional

integer (int32)

compEntryRssiAvgTimeOfs
optional

integer (int32)

compEntrySbv2SendInterval
optional

integer (int32)

compEntrySbv2SendMode
optional

integer (int32)

compEntrySendChannel
optional

boolean

compEntrySendOtherSbFrames
optional

boolean

compEntrySendUnknown
optional

boolean

compEntryTrackingSendMode
optional

integer (int32)

compEntryUnknownRssiAvgInterval
optional

integer (int32)

compEntryUnknownRssiAvgTimeOfs
optional

integer (int32)

compEntryUnknownSbv2SendInterval
optional

integer (int32)

compEntryUnknownSbv2SendMode
optional

integer (int32)

compEntryUnknownSendChannel
optional

boolean

compEntryUnknownSendOtherSbFrames
optional

boolean

compEntryUnknownSendUnknown
optional

boolean

compEntryUnknownTrackingSendMode
optional

integer (int32)

compFilterSyncThreshold
optional

integer (int32)

compFlags
optional

integer (int32)

compSendInterval
optional

integer (int32)

compSendThreshold
optional

integer (int32)

compSendUnknown
optional

integer (int32)

compUdpAddr
optional

string

compUdpDynamicRedundancy
optional

boolean

compUdpEnabled
optional

boolean

compUdpMaxSendTime
optional

integer (int32)

compUdpNumPackets
optional

integer (int32)

compUdpNumRedundancy
optional

integer (int32)

compUdpPort
optional

integer (int32)

compUdpSendBlockSize
optional

integer (int32)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

defaultBatteryOffset
optional

number (double)

defaultBatteryScale
optional

number (double)

defaultBatteryVariance
optional

number (double)

defaultOffset
optional

number (double)

defaultPlusOffset
optional

number (double)

defaultPlusScale
optional

number (double)

defaultPlusVariance
optional

number (double)

defaultScale
optional

number (double)

defaultVariance
optional

number (double)

doorTag
optional

string

duressNext
optional

boolean

duressSeconds
optional

integer (int32)

enableKalmanFilter
optional

boolean

enablePfrac
optional

boolean

enableTethering
optional

boolean

filterChannel
optional

integer (int32)

fingerprintChannel
optional

integer (int32)

fingerprintK
optional

integer (int32)

fingerprintMode
optional

enum (FULL, RSSI_ONLY, FP_ONLY, FP_OR_RSSI)

forceBlufiConnection
optional

boolean

forceSweepMultiChannelCalibration
optional

boolean

fpMode
optional

enum (ABSOLUTE, DIFFERENTIAL)

fpThr
optional

number (float)

fpVarBlockLength
optional

integer (int32)

fpVarWinLength
optional

integer (int32)

fpVarWinShift
optional

integer (int32)

globalRssDownTh
optional

number (double)

heightOffset
optional

integer (int32)

highDoorRange
optional

integer (int32)

humanStaticLocationMilliseconds
optional

integer (int64)

locationChangeBlufiCount
optional

integer (int32)

locationChangeBlufiRssiThreshold
optional

integer (int32)

locationChangeThreshold
optional

integer (int64)

lowDoorRange
optional

integer (int32)

metalStaticLocationMilliseconds
optional

integer (int64)

minimumCalibrationPoints
optional

integer (int32)

minimumFirmwareVersion
optional

integer (int32)

minimumSampleCount
optional

integer (int64)

noiseStateObsCvScale
optional

number (float)

outputParticles
optional

boolean

overlapMilliseconds
optional

integer (int64)

pNoiseCvScale
optional

number (float)

periodMilliseconds
optional

integer (int64)

pfLocationWeight
optional

number (double)

pfModelSpeedDecay
optional

number (float)

pfModelStateStd
optional

< string > array

pfNumParticles
optional

integer (int32)

pfResampleMethod
optional

enum (RESIDUAL, SYSTEMATIC, MULTINOMIAL)

pfUseBounds
optional

boolean

pfracInitializationFrac
optional

number (float)

pfracInstMaxMarginThreshold
optional

number (float)

pfracMaxCurrentValueWeight
optional

number (float)

pfracMovAvgDecayRate
optional

number (float)

pfracMovAvgLowThreshold
optional

number (float)

pfracMovAvgMaxMarginThreshold
optional

number (float)

pfracTau
optional

number (float)

pirWindowMultiplier
optional

number (float)

projectId
optional

integer (int64)

rangeCalculationMilliseconds
optional

integer (int64)

rssDownTh
optional

number (float)

rssiRetentionMilliseconds
optional

integer (int64)

rtlsNoCalMode
optional

integer (int32)

rtlsSettingId
optional

integer (int64)

selRadius
optional

number (float)

selRssTh1
optional

number (float)

sparGeneratorType
optional

integer (int32)

staticMotionDelayMilliseconds
optional

integer (int64)

sunstoneGeneratorType
optional

integer (int32)

useBlufiCalibrationRange
optional

boolean

useBounds
optional

boolean

useBoundsExclusions
optional

boolean

useMinimumFirmwareCheck
optional

boolean

useOfflineBlufiVariance
optional

boolean

useStaticMotionCheck
optional

boolean

useThresholdForLocation
optional

boolean

useTrilateration
optional

boolean

varianceScale
optional

number (float)

varianceThreshold
optional

integer (int32)

viewThreshold
optional

integer (int32)

wallBlockRatio
optional

number (double)

windowOpenBufferMilliseconds
optional

integer (int64)

windowStrategy
optional

enum (VARIABLE, GUARANTEED, EMA)

SBeaconV1

Name Schema

adapter
optional

Adapter

bat
optional

integer (int32)

id
optional

string

sdc
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int32)

txChn
optional

integer (int32)

txPower
optional

integer (int32)

type
optional

string

SBeaconV2

Name Schema

adapter
optional

Adapter

batt
optional

integer (int32)

id
optional

string

id64
optional

integer (int64)

msTime
optional

integer (int64)

sdc
optional

integer (int32)

temp
optional

number (float)

time
optional

integer (int64)

txChn
optional

integer (int32)

txPower
optional

integer (int32)

type
optional

string

SBeaconV2Windowed

Name Schema

adapter
optional

Adapter

batt
optional

integer (int32)

captureTime
optional

integer (int32)

filterId
optional

integer (int32)

id
optional

string

id64
optional

integer (int64)

index
optional

integer (int32)

rssiChannelMap
optional

< string, number (float) > map

rssiEntries
optional

< RssiEntry > array

temp
optional

number (float)

type
optional

string

windowTime
optional

integer (int64)

SLight

Name Schema

adapter
optional

Adapter

id
optional

string

id64
optional

integer (int64)

lums
optional

integer (int32)

time
optional

integer (int32)

type
optional

string

SSnsNanoAdData

Name Schema

adapter
optional

Adapter

base
optional

integer (int32)

deviceJobId
optional

integer (int64)

fullScale
optional

integer (int32)

id
optional

string

rssi
optional

integer (int32)

sessionId
optional

string

time
optional

integer (int64)

timeNano
optional

integer (int64)

type
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

SSnsSummaryAdData

Name Schema

adapter
optional

Adapter

adv
optional

boolean

highRes
optional

boolean

id
optional

string

rssi
optional

integer (int32)

started
optional

integer (int64)

time
optional

integer (int64)

type
optional

string

xPeak
optional

number (double)

xPeakToPeak
optional

number (double)

xRms
optional

number (double)

xVPeak
optional

number (double)

xVPeakToPeak
optional

number (double)

xVRms
optional

number (double)

yPeak
optional

number (double)

yPeakToPeak
optional

number (double)

yRms
optional

number (double)

yVPeak
optional

number (double)

yVPeakToPeak
optional

number (double)

yVRms
optional

number (double)

zPeak
optional

number (double)

zPeakToPeak
optional

number (double)

zRms
optional

number (double)

zVPeak
optional

number (double)

zVPeakToPeak
optional

number (double)

zVRms
optional

number (double)

SSpec

Name Schema

adapter
optional

Adapter

batt
optional

integer (int32)

id
optional

string

motion
optional

< < string (byte) > array > array

temp
optional

number (float)

time
optional

integer (int32)

type
optional

string

ScanData

Name Schema

battery
optional

integer (int32)

beaconId
optional

string

beaconName
optional

string

blufiId
optional

integer (int64)

blufiName
optional

string

channel
optional

integer (int32)

latitude
optional

number (double)

longitude
optional

number (double)

rssi
optional

integer (int32)

status
optional

string

temp
optional

number (float)

timestamp
optional

integer (int64)

ScanFrame

Name Schema

battery
optional

integer (int32)

beaconId
optional

string

beaconName
optional

string

blufiId
optional

integer (int64)

blufiName
optional

string

channel
optional

integer (int32)

latitude
optional

number (double)

longitude
optional

number (double)

rssi
optional

integer (int32)

status
optional

string

temp
optional

number (float)

timestamp
optional

integer (int64)

ServerConfiguration

Name Schema

directory
optional

string

password
optional

string

port
optional

string

server
optional

string

username
optional

string

ServerPagingRequest

Name Schema

filterOptions
optional

FilterOptions

pageNumber
optional

integer (int64)

pageSize
optional

integer (int64)

sortOptions
optional

SortOptions

ServerPagingResponseOfBaseDevice

Name Schema

data
optional

CollectionOfBaseDevice

total
optional

integer (int64)

SessionHolder

Name Schema

accountContext
optional

AccountContext

lastAccessed
optional

integer (int64)

ttl
optional

integer (int64)

SimpleDevice

Name Schema

bleFirmwareVersion
optional

integer (int32)

dateCompleted
optional

integer (int64)

dateStarted
optional

integer (int64)

deviceId
optional

string

deviceTypeName
optional

string

duration
optional

integer (int64)

macAddress
optional

string

modelStatus
optional

string

name
optional

string

status
optional

string

Sms

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enabled
optional

boolean

smsId
optional

integer (int64)

smsNumber
optional

string

verified
optional

boolean

SortOptions

Name Schema

sortDir
optional

enum (ASC, DESC, UNKNOWN)

sortField
optional

string

Status

Name Schema

code
optional

string

error
optional

string

gid
optional

string

transactionId
optional

string

wifiState
optional

string

wsState
optional

string

SwMotionConfig

Name Schema

counter0
optional

SwMotionCounterConfig

counter1
optional

SwMotionCounterConfig

counter2
optional

SwMotionCounterConfig

counter3
optional

SwMotionCounterConfig

counter4
optional

SwMotionCounterConfig

counter5
optional

SwMotionCounterConfig

swMotionConfigId
optional

integer (int64)

SwMotionCounterConfig

Name Schema

continuous
optional

boolean

countOnAxes
optional

string

input1
optional

SwMotionCounterInput

input2
optional

SwMotionCounterInput

input3
optional

SwMotionCounterInput

inputSkip
optional

integer (int32)

startOnEvent
optional

boolean

swMotionCounterConfigId
optional

integer (int64)

SwMotionCounterInput

Name Schema

countDown
optional

boolean

countHigh
optional

integer (int32)

countLow
optional

integer (int32)

levelHigh
optional

number (double)

levelLow
optional

number (double)

signedComparison
optional

boolean

source
optional

string

swMotionCounterInputId
optional

integer (int64)

SystemScanMode

Name Schema

alternateMaxNoise
optional

integer (int32)

alternateMaxSnr
optional

integer (int32)

alternateMinSnr
optional

integer (int32)

assetTrackingMode
optional

boolean

bulkMode
optional

boolean

channelCount
optional

integer (int32)

channelCycles
optional

string

channels
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

defaultMode
optional

boolean

description
optional

string

deviceJobMode
optional

boolean

dwellTime
optional

integer (int32)

frequencyStep
optional

integer (int32)

idleCycles
optional

integer (int32)

iqDataMode
optional

enum (MULTICHANNEL, AOA)

maxNoise
optional

integer (int32)

maxSnr
optional

integer (int32)

minSnr
optional

integer (int32)

name
optional

string

scanDelayTime
optional

integer (int32)

scanInterval
optional

integer (int32)

scanMode
optional

integer (int32)

scanModeId
optional

integer (int64)

scanWindow
optional

integer (int32)

startFrequency
optional

integer (int32)

sweepChannelCount
optional

integer (int32)

sweepMode
optional

integer (int32)

trackingChannels
optional

string

useAntennaScan
optional

boolean

wifiProbe
optional

boolean

wifiProbeChannel
optional

integer (int32)

wifiProbeInterval
optional

integer (int32)

wifiProbeWindow
optional

integer (int32)

Tag

Name Schema

displayName
optional

string

projectId
optional

integer (int64)

tagId
optional

integer (int64)

value
optional

string

TeamInvitation

Name Schema

actionDate
optional

integer (int64)

emailAddress
optional

string

invitationDate
optional

integer (int64)

inviterEmailAddress
optional

string

products
optional

< Product > array

projectId
optional

integer (int64)

projectName
optional

string

teamInvitationId
optional

integer (int64)

teamInvitationStatusType
optional

string

teamMemberType
optional

string

token
optional

string

TeamMember

Name Schema

accountId
optional

integer (int64)

emailAddress
optional

string

features
optional

< Feature > array

invitationActionDate
optional

integer (int64)

invitationCreatedDate
optional

integer (int64)

owner
optional

boolean

projectId
optional

integer (int64)

roles
optional

< Role > array

teamMemberId
optional

integer (int64)

username
optional

string

ThirdPartyGateway

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

locationId
optional

integer (int64)

macAddress
optional

string

metaData
optional

string

model
optional

string

name
optional

string

notes
optional

string

projectId
optional

integer (int64)

protocolType
optional

enum (ARUBA_TELEMETRY_WEBSOCKET)

tags
optional

< Tag > array

vendor
optional

string

ThirdPartyGatewayUpdate

Name Schema

assetTrackable
optional

boolean

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

locationId
optional

integer (int64)

macAddress
optional

string

metaData
optional

string

model
optional

string

name
optional

string

notes
optional

string

policies
optional

< Policy > array

projectId
optional

integer (int64)

protocolType
optional

enum (ARUBA_TELEMETRY_WEBSOCKET)

tags
optional

< Tag > array

vendor
optional

string

ThirdPartyIBeacon

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

string

isUuidUnique
optional

boolean

major
optional

integer (int64)

minor
optional

integer (int64)

projectId
optional

integer (int64)

thirdPartyIbeaconId
optional

integer (int64)

uuid
optional

string

Timestamp

Name Schema

date
optional

integer (int32)

day
optional

integer (int32)

hours
optional

integer (int32)

minutes
optional

integer (int32)

month
optional

integer (int32)

nanos
optional

integer (int32)

seconds
optional

integer (int32)

time
optional

integer (int64)

timezoneOffset
optional

integer (int32)

year
optional

integer (int32)

TokenPageQuery

Name Schema

pageSize
optional

integer (int32)

pageToken
optional

string

TokenPageResponse

Name Schema

content
optional

< object > array

pageElements
optional

integer (int32)

pageToken
optional

string

TracingConfig

Name Schema

channels
optional

< integer (int32) > array

cycles
optional

< integer (int32) > array

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

enableButton
optional

boolean

enableBuzzer
optional

boolean

enableLed
optional

boolean

enabled
optional

boolean

entries
optional

integer (int32)

identityChannels
optional

< integer (int32) > array

idleDutyCycle
optional

integer (int32)

repeat
optional

integer (int32)

rssiRef
optional

integer (int32)

scanInterval
optional

integer (int32)

scanMode
optional

integer (int32)

scanWindow
optional

integer (int32)

state
optional

enum (DISABLED, ENABLED, STAY_THE_SAME)

tracingConfigId
optional

integer (int64)

Tracking

Name Schema

adapter
optional

Adapter

id
optional

string

id64
optional

integer (int64)

msTime
optional

integer (int64)

type
optional

string

TrayCreateResponse

Name Schema

errors
optional

boolean

failures
optional

< TrayError > array

TrayError

Name Schema

beaconId
optional

string

errorCode
optional

integer (int32)

errorDescription
optional

string

trayId
optional

string

URI

Name Schema

absolute
optional

boolean

authority
optional

string

fragment
optional

string

host
optional

string

opaque
optional

boolean

path
optional

string

port
optional

integer (int32)

query
optional

string

rawAuthority
optional

string

rawFragment
optional

string

rawPath
optional

string

rawQuery
optional

string

rawSchemeSpecificPart
optional

string

rawUserInfo
optional

string

scheme
optional

string

schemeSpecificPart
optional

string

userInfo
optional

string

URL

Name Schema

authority
optional

string

content
optional

object

defaultPort
optional

integer (int32)

deserializedFields
optional

URLStreamHandler

file
optional

string

host
optional

string

path
optional

string

port
optional

integer (int32)

protocol
optional

string

query
optional

string

ref
optional

string

serializedHashCode
optional

integer (int32)

userInfo
optional

string

URLStreamHandler

Type : object

Unknown

Name Schema

adapter
optional

Adapter

raw
optional

< integer (int32) > array

type
optional

string

UpdateTeamMemberRequest

Name Schema

products
optional

< Product > array

teamMemberType
optional

string

Uuid

Name Schema

uuidId
optional

integer (int64)

value
optional

string

Valid

Name Schema

name
optional

string

valid
optional

boolean

value
optional

string

ViewDeviceTemplate

Name Schema

description
optional

string

name
optional

string

templateId
optional

integer (int64)

VirtualBlufi

Name Schema

beaconTemplateId
optional

integer (int64)

beaconTemplateName
optional

string

blufiTemplateId
optional

integer (int64)

blufiTemplateName
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

latitude
optional

number (double)

locationId
optional

integer (int64)

locationName
optional

string

longitude
optional

number (double)

name
optional

string

powerSourceType
optional

enum (UNKNOWN, AC, DC, POE)

projectId
optional

integer (int64)

sid64
optional

string

virtualBlufiId
optional

integer (int64)

virtualBlufiType
optional

enum (BLUFI, BEACON, UNKNOWN)

VirtualBlufiAssignRequest

Name Schema

overrideAssignment
optional

boolean

sid64
optional

string

virtualBlufiId
optional

integer (int64)

VirtualBlufiAssignResponse

Name Schema

beaconTemplateId
optional

integer (int64)

blufiTemplateId
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceId
optional

integer (int64)

ethIpAddress
optional

string

ethMacAddress
optional

string

firmwareVersion
optional

integer (int32)

ipAddress
optional

string

latitude
optional

number (double)

locationId
optional

integer (int64)

locationName
optional

string

longitude
optional

number (double)

macAddress
optional

string

name
optional

string

networkSelectorType
optional

enum (ANY, WIFI, ETHERNET)

powerSourceType
optional

enum (UNKNOWN, AC, DC, POE)

projectId
optional

integer (int64)

selfieUrl
optional

string

sid64
optional

string

status
optional

string

tags
optional

< Tag > array

wifiSsid
optional

string

VirtualBlufiLog

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

log
optional

string

projectId
optional

integer (int64)

virtualBlufiId
optional

integer (int64)

virtualBlufiLogId
optional

integer (int64)

VirtualBlufiUploadJob

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

errorCode
optional

string

errorMessage
optional

string

errorParamList
optional

< string > array

projectId
optional

integer (int64)

status
optional

enum (NOT_RUNNING, INIT_PROCESSING, RUNNING_VALIDATION, RUNNING_BULK_SAVE, FINISHED_SUCCESS, FINISHED_FAILURE)

statusCode
optional

integer (int32)

virtualBlufiUploadJobId
optional

integer (int64)

VirtualDevice

Name Schema

beaconTemplateId
optional

integer (int64)

bleFirmware
optional

Firmware

blufiTemplateId
optional

integer (int64)

configData
optional

object

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

deviceType
optional

DeviceType

floorNumber
optional

integer (int32)

latitude
optional

number (double)

location
optional

Location

longitude
optional

number (double)

major
optional

Major

metaData
optional

object

minorValue
optional

integer (int32)

name
optional

string

projectId
optional

integer (int64)

tags
optional

< Tag > array

uuid
optional

string (uuid)

virtualDeviceId
optional

integer (int64)

WebSocketSessionEvent

Name Schema

accountId
optional

integer (int64)

blufiId
optional

integer (int64)

clientType
optional

string

dateClosed
optional

integer (int64)

dateOpened
optional

integer (int64)

error
optional

string

errors
optional

boolean

hostname
optional

string

projectId
optional

integer (int64)

sessionDuration
optional

integer (int64)

sessionId
optional

string

sessionState
optional

string

totalBytesRead
optional

integer (int64)

uri
optional

string

Webhook

Name Schema

authHeaderName
optional

string

authHeaderValue
optional

string

dateUpdated
optional

integer (int64)

httpStatusCode
optional

integer (int32)

httpStatusMessage
optional

string

projectId
optional

integer (int64)

state
optional

string

url
optional

string

webhookId
optional

integer (int64)

WebhookEvent

Name Schema

agent
optional

Agent

eventType
optional

enum (CREATE, UPDATE, DELETE, WEB_SOCKET_CONNECT, WEB_SOCKET_DISCONNECT, BULK_DELETE)

namespace
optional

string

payload
optional

object

primaryKey
optional

string

primaryKeys
optional

< string > array

projectId
optional

integer (int64)

timestamp
optional

integer (int64)

version
optional

string

Wifi

Name Schema

addr1
optional

string

addr3
optional

string

channel
optional

integer (int32)

durationId
optional

integer (int32)

frameControl
optional

integer (int32)

length
optional

integer (int32)

mac
optional

string

rate
optional

integer (int32)

rssi
optional

integer (int32)

seq
optional

integer (int32)

ssid
optional

string

staticHash
optional

integer (int32)

ts
optional

integer (int64)

WifiFirmware

Name Schema

checksum
optional

< string (byte) > array

data
optional

< string (byte) > array

name
optional

string

revision
optional

integer (int32)

WifiMacData

Name Schema

addr1Set
optional

< string > array

addr3Set
optional

< string > array

blufiSet
optional

< string > array

durationId
optional

integer (int32)

firstSeen
optional

integer (int64)

frameControl
optional

integer (int32)

lastSeen
optional

integer (int64)

length
optional

integer (int32)

mac
optional

string

projectId
optional

string

rate
optional

integer (int32)

rssiSet
optional

< WifiRssiData > array

ssidSet
optional

< string > array

staticHash
optional

integer (int32)

WifiReconnectConfig

Name Schema

backoffFactor
optional

integer (int32)

bssid
optional

string

conChangeMaxTime
optional

integer (int32)

conKeptTime
optional

integer (int32)

conMaxRetries
optional

integer (int32)

deltaScanTime
optional

integer (int32)

maxScanTime
optional

integer (int32)

maxWaitTime
optional

integer (int32)

minScanTime
optional

integer (int32)

minWaitTime
optional

integer (int32)

WifiRssiData

Name Schema

blufiId
optional

string

channel
optional

integer (int32)

rssi
optional

integer (int32)

seq
optional

integer (int32)

timeStamp
optional

integer (int64)

WifiScanProperty

Name Schema

blufiId
optional

integer (int64)

projectId
optional

integer (int64)

type
optional

string

wifi
optional

< Wifi > array

WifiScanPropertyWrapper

Name Schema

addr1
optional

string

addr3
optional

string

channel
optional

integer (int32)

durationId
optional

integer (int32)

frameControl
optional

integer (int32)

length
optional

integer (int32)

mac
optional

string

rate
optional

integer (int32)

rssi
optional

integer (int32)

seq
optional

integer (int32)

ssid
optional

string

staticHash
optional

integer (int32)

ts
optional

integer (int64)

type
optional

string

WifiScanReport

Name Schema

dateEnd
optional

integer (int64)

dateReported
optional

integer (int64)

dateStart
optional

integer (int64)

metricType
optional

enum (QUEUE_TIME, PEOPLE_COUNT_SINGLE, PEOPLE_COUNT_MULTI)

projectId
optional

integer (int64)

reportType
optional

enum (INTERVAL_AGGREGATION, UNKNOWN)

reportUrl
optional

string

wifiScanReportId
optional

integer (int64)

wifiScanReportPlanId
optional

integer (int64)

WifiScanReportConfig

Name Schema

metricType
optional

string

range
optional

integer (int64)

WifiScanReportPlan

Name Schema

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

projectId
optional

integer (int64)

reportConfig
optional

WifiScanReportConfig

reportType
optional

enum (INTERVAL_AGGREGATION, UNKNOWN)

wifiScanReportPlanId
optional

integer (int64)

WifiScanRunReportRequest

Name Schema

endDate
optional

string

startDate
optional

string

wifiScanReportPlanIds
optional

< integer (int64) > array

WifiSecurityType

Name Schema

enterprise
optional

boolean

securityTypeKey
optional

string

WorkZoneBlufi

Name Schema

blufiId
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

name
optional

string

projectId
optional

integer (int64)

rssiThreshold
optional

number (float)

workZoneBlufiId
optional

integer (int64)

Workplace

Name Schema

address
optional

string

currentOccupancy
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

lat
optional

number (double)

lng
optional

number (double)

managerEmail
optional

string

managerName
optional

string

maxOccupancy
optional

integer (int64)

name
optional

string

numFloors
optional

integer (int32)

numZones
optional

integer (int32)

projectId
optional

integer (int64)

reportTimezone
optional

string

selfie
optional

DeviceSelfie

tags
optional

< Tag > array

workplaceId
optional

integer (int64)

WorkplaceSelfie

Name Schema

contentType
optional

string

data
optional

string

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

name
optional

string

projectId
optional

integer (int64)

selfieId
optional

integer (int64)

url
optional

string

WpoLocation

Name Schema

currentOccupancy
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

floorNumber
optional

integer (int32)

maxOccupancy
optional

integer (int32)

name
optional

string

numZones
optional

integer (int32)

projectId
optional

integer (int64)

systemZoneId
optional

integer (int64)

workplaceId
optional

integer (int64)

wpoLocationId
optional

integer (int64)

Zone

Name Schema

bounds
optional

string

currentOccupancy
optional

integer (int64)

dateCreated
optional

integer (int64)

dateUpdated
optional

integer (int64)

description
optional

string

maxOccupancy
optional

integer (int32)

name
optional

string

projectId
optional

integer (int64)

workplaceId
optional

integer (int64)

wpoLocationId
optional

integer (int64)

zoneId
optional

integer (int64)

ZonesSummary

Name Description Schema

beaconCount
optional

Example : "null"

integer (int32)

musteringZoneId
optional

Example : "null"

string

sSns

Name Schema

adapter
optional

Adapter

batt
optional

integer (int32)

eventCounter
optional

< integer (int32) > array

id
optional

string

msTime
optional

integer (int64)

temp
optional

number (float)

time
optional

integer (int32)

type
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

sSnsNano

Name Schema

adapter
optional

Adapter

base
optional

integer (int32)

deviceJobId
optional

integer (int64)

fullScale
optional

integer (int32)

id
optional

string

sessionId
optional

string

timeNano
optional

integer (int64)

type
optional

string

xAccel
optional

number (double)

yAccel
optional

number (double)

zAccel
optional

number (double)

sSnsSummary

Name Schema

adapter
optional

Adapter

adv
optional

boolean

highRes
optional

boolean

id
optional

string

started
optional

integer (int64)

time
optional

integer (int64)

type
optional

string

xPeak
optional

number (double)

xPeakToPeak
optional

number (double)

xRms
optional

number (double)

xVPeak
optional

number (double)

xVPeakToPeak
optional

number (double)

xVRms
optional

number (double)

yPeak
optional

number (double)

yPeakToPeak
optional

number (double)

yRms
optional

number (double)

yVPeak
optional

number (double)

yVPeakToPeak
optional

number (double)

yVRms
optional

number (double)

zPeak
optional

number (double)

zPeakToPeak
optional

number (double)

zRms
optional

number (double)

zVPeak
optional

number (double)

zVPeakToPeak
optional

number (double)

zVRms
optional

number (double)