1. Overview

Documentation of all APIs related to Bluzone.

1.1. Version information

Version : 1.0

1.2. Contact information

Contact : Bluvision Inc
Contact Email : support@bluzone.io

1.3. License information

License : Copyright Bluzone Inc
License URL : bluvision.com
Terms of service : bluvision.com

1.4. URI scheme

Host : localhost:8080
BasePath : /

1.5. Tags

  • beaconTemplates : Beacon Template Controller

  • reports : Report Controller

  • test : Advertisement Property Test Controller

  • dashboard : Dashboard Controller

  • deviceTemplates : Device Template Controller

  • manufactureData : Portal Mfg Data Controller

  • deviceJobs : Device Job Controller

  • blufiTemplates : Blufi Template Controller

  • webhooks : Webhook Controller

  • calibrationGroups : Calibration Group Controller

  • policies : Policy Controller

  • history : History Controller

  • deviceRegistry : Device Registry Controller

  • projects : Project Controller

  • rcm : RCM Controller

  • wifiSecurityType : Wifi Security Type Controller

  • deviceSelfie : Device Selfie Controller

  • calibrations : Calibration Controller

  • baselines : Baseline Controller

  • blufis : Blufi Controller

  • deviceTypes : Device Type Controller

  • provisioning : Beacon Provisioning Controller

  • virtualDevice : Virtual Device Controller

  • beacons : Beacon Controller

  • locations : Location Controller

  • accounts : Portal Account Controller

  • tags : Tag Controller

  • search : Search Controller

  • validations : Validation Controller

  • calibrationPoints : Calibration Point Controller

  • remoteConsumerConfig : Remote Consumer Config Controller

2. Learn More

To learn more about how to use Bluzone REST API’s please visit Bluvision Developer Portal

2.1. 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.

2.2. 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).

2.3. 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.

3. Where Next

Please follow through the resources to learn more.

4. Resources

4.1. Accounts

Portal Account Controller

4.1.1. Get account

GET /papis/v1/accounts/{accountId}
Parameters
Type Name Description Schema Default

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
  • /

4.1.2. Update Account

PUT /papis/v1/accounts/{accountId}
Parameters
Type Name Description Schema Default

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
  • /

4.2. Baselines

Baseline Controller

4.2.1. Create baseline

POST /papis/v1/projects/{projectId}/baselines
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Body

baseline
required

baseline

Baseline

Responses
HTTP Code Description Schema

200

OK

Baseline

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.2.2. Get all project baselines

GET /papis/v1/projects/{projectId}/baselines
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< Baseline > 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
  • /

4.2.3. Get baseline by project id and baseline id

GET /papis/v1/projects/{projectId}/baselines/{baselineId}
Parameters
Type Name Description Schema Default

Path

baselineId
required

baselineId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

Baseline

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.2.4. Get beacon config history

GET /papis/v1/projects/{projectId}/baselines/{baselineId}/histories
Parameters
Type Name Description Schema Default

Path

baselineId
required

baselineId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< BeaconConfigHistory > 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
  • /

4.3. BeaconTemplates

Beacon Template Controller

4.3.1. Create beacon template

POST /papis/v1/projects/{projectId}/beaconTemplates
Parameters
Type Name Description Schema Default

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
  • /

4.3.2. Get all beacon templates by project id

GET /papis/v1/projects/{projectId}/beaconTemplates
Parameters
Type Name Description Schema Default

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
  • /

4.3.3. Delete beacon templates by beacon template ids

PUT /papis/v1/projects/{projectId}/beaconTemplates/_delete
Parameters
Type Name Description Schema Default

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
  • /

4.3.4. Get beacon template by beacon template id

GET /papis/v1/projects/{projectId}/beaconTemplates/{templateId}
Parameters
Type Name Description Schema Default

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
  • /

4.3.5. Update beacon template by beacon template id

PUT /papis/v1/projects/{projectId}/beaconTemplates/{templateId}
Parameters
Type Name Description Schema Default

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
  • /

4.3.6. Clone beacon template by beacon template id

PUT /papis/v1/projects/{projectId}/beaconTemplates/{templateId}/_clone
Parameters
Type Name Description Schema Default

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
  • /

4.4. Beacons

Beacon Controller

4.4.1. Get beacons

GET /papis/v1/projects/{projectId}/devices/beacons
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

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
  • /

4.4.2. Update beacon bulk configuration

PUT /papis/v1/projects/{projectId}/devices/beacons/_bulkConfig
Parameters
Type Name Description Schema Default

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
  • /

4.4.3. Update beacon configuration

PUT /papis/v1/projects/{projectId}/devices/beacons/_config
Parameters
Type Name Description Schema Default

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
  • /

4.4.4. Update beacon configuration by template

PUT /papis/v1/projects/{projectId}/devices/beacons/_config/template
Parameters
Type Name Description Schema Default

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
  • /

4.4.5. Delete beacons

PUT /papis/v1/projects/{projectId}/devices/beacons/_delete
Parameters
Type Name Description Schema Default

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
  • /

4.4.6. Get beacons lite view

GET /papis/v1/projects/{projectId}/devices/beacons/_lite
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< DeviceLite > 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
  • /

4.4.7. Get beacon map

GET /papis/v1/projects/{projectId}/devices/beacons/_map
Parameters
Type Name Description Schema Default

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
  • /

4.4.8. Get beacon by beacon id

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}
Parameters
Type Name Description Schema Default

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
  • /

4.4.9. Update beacon

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}
Parameters
Type Name Description Schema Default

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
  • /

4.4.10. Update beacon coordinates

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/coordinates
Parameters
Type Name Description Schema Default

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
  • /

4.4.11. Get beacon events

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/events
Parameters
Type Name Description Schema Default

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

PageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.4.12. Get beacon events paged

POST /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/events/_query
Parameters
Type Name Description Schema Default

Path

beaconId
required

beaconId

string

Path

projectId
required

projectId

integer(int64)

Body

query
required

query

PageQuery

Responses
HTTP Code Description Schema

200

OK

PageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.4.13. Update beacon metadata

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/metaData
Parameters
Type Name Description Schema Default

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
  • /

4.4.14. Get Beacon Policies

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/policies
Parameters
Type Name Description Schema Default

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
  • /

4.4.15. Get beacon scan data

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/scanData
Parameters
Type Name Description Schema Default

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
  • /

4.4.16. Get beacon scan data any

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/scanData/_any
Parameters
Type Name Description Schema Default

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
  • /

4.4.17. Get beacon scan data closest

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/scanData/_closest
Parameters
Type Name Description Schema Default

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
  • /

4.4.18. Get beacon selfie view

POST /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.4.19. Get beacon selfie view

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.4.20. Get beacon selfie view

PUT /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.4.21. Get beacon selfie view

DELETE /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.4.22. Get beacon selfie view

PATCH /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.4.23. Get beacon selfie view

HEAD /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.4.24. Get beacon selfie view

OPTIONS /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.4.25. Get beacon templates by beacon id

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/templates
Parameters
Type Name Description Schema Default

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
  • /

4.4.26. Get beacon policy violations

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/violations
Parameters
Type Name Description Schema Default

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
  • /

4.5. BlufiTemplates

Blufi Template Controller

4.5.1. Create blufi template

POST /papis/v1/projects/{projectId}/blufiTemplates
Parameters
Type Name Description Schema Default

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
  • /

4.5.2. Get all blufi templates

GET /papis/v1/projects/{projectId}/blufiTemplates
Parameters
Type Name Description Schema Default

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
  • /

4.5.3. Delete blufi templates by blufi template ids

PUT /papis/v1/projects/{projectId}/blufiTemplates
Parameters
Type Name Description Schema Default

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
  • /

4.5.4. Get blufi template by id

GET /papis/v1/projects/{projectId}/blufiTemplates/{templateId}
Parameters
Type Name Description Schema Default

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
  • /

4.5.5. Update blufi template

PUT /papis/v1/projects/{projectId}/blufiTemplates/{templateId}
Parameters
Type Name Description Schema Default

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
  • /

4.6. Blufis

Blufi Controller

4.6.1. Get blufis

GET /papis/v1/projects/{projectId}/devices/blufis
Parameters
Type Name Description Schema Default

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
  • /

4.6.2. Reset blufi ble

PUT /papis/v1/projects/{projectId}/devices/blufis/_bleReset
Parameters
Type Name Description Schema Default

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
  • /

4.6.3. Delete blufi

PUT /papis/v1/projects/{projectId}/devices/blufis/_delete
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

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
  • /

4.6.4. Get blufis lite view

GET /papis/v1/projects/{projectId}/devices/blufis/_lite
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< DeviceLite > 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
  • /

4.6.5. Search blufis

GET /papis/v1/projects/{projectId}/devices/blufis/_search
Parameters
Type Name Description Schema Default

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
  • /

4.6.6. Update blufi coordinates

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/coordinates
Parameters
Type Name Description Schema Default

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
  • /

4.6.7. Get blufi scan data

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/scanData
Parameters
Type Name Description Schema Default

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
  • /

4.6.8. Get blufi scan data any

GET /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/scanData/_any
Parameters
Type Name Description Schema Default

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
  • /

4.6.9. Update blufi scan mode

PUT /papis/v1/projects/{projectId}/devices/blufis/{blufiId}/scanmode
Parameters
Type Name Description Schema Default

Path

blufiId
required

blufiId

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
  • /

4.6.10. Get blufi

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}
Parameters
Type Name Description Schema Default

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
  • /

4.6.11. Update blufi

PUT /papis/v1/projects/{projectId}/devices/blufis/{deviceId}
Parameters
Type Name Description Schema Default

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
  • /

4.6.12. Get blufi events

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/events
Parameters
Type Name Description Schema Default

Path

deviceId
required

deviceId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

PageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.6.13. Get blufi events pages

POST /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/events/_query
Parameters
Type Name Description Schema Default

Path

deviceId
required

deviceId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Body

query
required

query

PageQuery

Responses
HTTP Code Description Schema

200

OK

PageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.6.14. Get blufi location

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/location
Parameters
Type Name Description Schema Default

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
  • /

4.6.15. Get blufi policies

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/policies
Parameters
Type Name Description Schema Default

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
  • /

4.6.16. Get blufi selfie view

POST /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.6.17. Get blufi selfie view

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.6.18. Get blufi selfie view

PUT /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.6.19. Get blufi selfie view

DELETE /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.6.20. Get blufi selfie view

PATCH /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.6.21. Get blufi selfie view

HEAD /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.6.22. Get blufi selfie view

OPTIONS /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.6.23. Get blufi policy violations

GET /papis/v1/projects/{projectId}/devices/blufis/{deviceId}/violations
Parameters
Type Name Description Schema Default

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
  • /

4.7. CalibrationGroups

Calibration Group Controller

4.7.1. Create calibration group

POST /sapis/v1/calibrationGroup/{projectId}
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Body

group
required

group

CalibrationGroup

Responses
HTTP Code Description Schema

200

OK

CalibrationGroup

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.7.2. Get all calibration group

GET /sapis/v1/calibrationGroup/{projectId}
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationGroup > 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
  • /

4.7.3. Get calibration group

GET /sapis/v1/calibrationGroup/{projectId}/{calibrationGroupId}
Parameters
Type Name Description Schema Default

Path

calibrationGroupId
required

calibrationGroupId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

CalibrationGroup

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.7.4. Delete calibration group

DELETE /sapis/v1/calibrationGroup/{projectId}/{calibrationGroupId}
Parameters
Type Name Description Schema Default

Path

calibrationGroupId
required

calibrationGroupId

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
  • /

4.7.5. Get calibration groups by location id

GET /sapis/v1/calibrationGroup/{projectId}/{locationId}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationGroup > 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
  • /

4.7.6. Get calibration groups by location id and material

GET /sapis/v1/calibrationGroup/{projectId}/{locationId}/{material}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationGroup > 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
  • /

4.7.7. Delete calibration group by material

DELETE /sapis/v1/calibrationGroup/{projectId}/{locationId}/{material}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

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
  • /

4.8. CalibrationPoints

Calibration Point Controller

4.8.1. Find calibration points

POST /papis/v1/projects/{projectId}/locations/{locationId}/calibrationPoints
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Body

query
required

query

CalibrationPointQuery

Responses
HTTP Code Description Schema

200

OK

PageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.8.2. Get all calibration points

GET /papis/v1/projects/{projectId}/locations/{locationId}/calibrationPoints
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Query

assetMaterialType
optional

assetMaterialType

enum (HUMAN, METAL, BOX, ALL)

Query

calibrationDirection
optional

calibrationDirection

< enum (NORTH, SOUTH, EAST, WEST, ROTATION) > array(multi)

Query

calibrationGroupId
optional

calibrationGroupId

integer(int64)

Query

calibrationPointType
optional

calibrationPointType

enum (OFFSET_POINT, CALIBRATION_POINT)

Query

calibrationStatus
optional

calibrationStatus

enum (CALIBRATING, PROCESSING, COMPLETE, ERROR, TIMEOUT)

Query

channel
optional

channel

integer(int32)

Query

page
optional

page

integer(int32)

Query

size
optional

size

integer(int32)

"20"

Responses
HTTP Code Description Schema

200

OK

PageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.8.3. Get calibration point

GET /papis/v1/projects/{projectId}/locations/{locationId}/calibrationPoints/{calibrationPointId}
Parameters
Type Name Description Schema Default

Path

calibrationPointId
required

calibrationPointId

integer(int64)

Path

locationId
required

locationId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

CalibrationPoint

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.9. Calibrations

Calibration Controller

4.9.1. Calculate offset average for location

GET /sapis/v1/calculateOffsetAverage/{projectId}/{locationId}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationBeaconBlufiOffset > 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
  • /

4.9.2. Add calibration event

POST /sapis/v1/calibration/{projectId}
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Body

event
required

event

LocationCalibrationEvent

Responses
HTTP Code Description Schema

200

OK

LocationCalibrationEvent

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.9.3. Complete calibration for location and material

POST /sapis/v1/calibrations/complete/{projectId}/{locationId}/{material}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

LocationCalibrationEvent

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.9.4. Create calibration point

POST /sapis/v1/calibrations/{projectId}
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Body

point
required

point

CalibrationPoint

Responses
HTTP Code Description Schema

200

OK

CalibrationPoint

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.9.5. Get calibration points

GET /sapis/v1/calibrations/{projectId}
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationPoint > 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
  • /

4.9.6. Update calibration point

PUT /sapis/v1/calibrations/{projectId}/{calibrationPointId}
Parameters
Type Name Description Schema Default

Path

calibrationPointId
required

calibrationPointId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Body

calibrationPoint
required

calibrationPoint

CalibrationPoint

Responses
HTTP Code Description Schema

200

OK

CalibrationPoint

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.9.7. Get calibration points for location

GET /sapis/v1/calibrations/{projectId}/{locationId}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationPoint > 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
  • /

4.9.8. Get reference beacon for material

GET /sapis/v1/calibrations/{projectId}/{locationId}/reference/{material}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

ReferenceBeaconResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.9.9. Get calibration points for location and material and type

GET /sapis/v1/calibrations/{projectId}/{locationId}/type/{calibrationPointType}/{material}
Parameters
Type Name Description Schema Default

Path

calibrationPointType
required

calibrationPointType

enum (OFFSET_POINT, CALIBRATION_POINT)

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationPoint > 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
  • /

4.9.10. Delete calibration points by material and type

DELETE /sapis/v1/calibrations/{projectId}/{locationId}/type/{calibrationPointType}/{material}
Parameters
Type Name Description Schema Default

Path

calibrationPointType
required

calibrationPointType

enum (OFFSET_POINT, CALIBRATION_POINT)

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

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
  • /

4.9.11. Get calibration points for location and material and type and direction

GET /sapis/v1/calibrations/{projectId}/{locationId}/type/{calibrationPointType}/{material}/{direction}
Parameters
Type Name Description Schema Default

Path

calibrationPointType
required

calibrationPointType

enum (OFFSET_POINT, CALIBRATION_POINT)

Path

direction
required

direction

enum (NORTH, SOUTH, EAST, WEST, ROTATION)

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationPoint > 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
  • /

4.9.12. Get calibration point

GET /sapis/v1/calibrations/{projectId}/{locationId}/{calibrationPointId}
Parameters
Type Name Description Schema Default

Path

calibrationPointId
required

calibrationPointId

integer(int64)

Path

locationId
required

locationId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

CalibrationPoint

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.9.13. Delete calibration point

DELETE /sapis/v1/calibrations/{projectId}/{locationId}/{calibrationPointId}
Parameters
Type Name Description Schema Default

Path

calibrationPointId
required

calibrationPointId

integer(int64)

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
  • /

4.9.14. Calculate offset average for location and material

GET /sapis/v1/calibrations/{projectId}/{locationId}/{material}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationPoint > 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
  • /

4.9.15. Delete calibration points by material

DELETE /sapis/v1/calibrations/{projectId}/{locationId}/{material}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

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
  • /

4.9.16. Get calibration offsets

GET /sapis/v1/offset/{projectId}/{locationId}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

< CalibrationBeaconBlufiOffset > 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
  • /

4.9.17. Delete calibration offsets

DELETE /sapis/v1/offset/{projectId}/{locationId}/{material}
Parameters
Type Name Description Schema Default

Path

locationId
required

locationId

integer(int64)

Path

material
required

material

enum (HUMAN, METAL, BOX, ALL)

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
  • /

4.10. Dashboard

Dashboard Controller

4.10.1. Get devices by device search

POST /papis/v1/projects/{projectId}/dashboard
Parameters
Type Name Description Schema Default

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
  • /

4.10.2. Get devices view by project id

GET /papis/v1/projects/{projectId}/dashboard
Parameters
Type Name Description Schema Default

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
  • /

4.10.3. Get search beacon view

GET /papis/v1/projects/{projectId}/dashboard/_search
Parameters
Type Name Description Schema Default

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
  • /

4.10.4. Get beacon views by tag ids post

POST /papis/v1/projects/{projectId}/dashboard/beaconViews
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Body

tagIds
required

tagIds

< integer(int64) > array

Responses
HTTP Code Description Schema

200

OK

Dashboard3OfBeaconView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.10.5. 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

Dashboard3OfBeaconView

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.10.6. Get blufi views by post

POST /papis/v1/projects/{projectId}/dashboard/blufiViews
Parameters
Type Name Description Schema Default

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
  • /

4.10.7. Get blufi views

GET /papis/v1/projects/{projectId}/dashboard/blufiViews
Parameters
Type Name Description Schema Default

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
  • /

4.10.8. Get beacon ids by tag ids

GET /papis/v1/projects/{projectId}/dashboard/tags/{tagId}/beaconIds
Parameters
Type Name Description Schema Default

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
  • /

4.11. DeviceJobs

Device Job Controller

4.11.1. Cancel device job bulk

POST /papis/v1/projects/{projectId}/devices/beacons/jobs/_bulkCancel
Parameters
Type Name Description Schema Default

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
  • /

4.11.2. Create bulk device job

PUT /papis/v1/projects/{projectId}/devices/beacons/jobs/_bulkCreate
Parameters
Type Name Description Schema Default

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
  • /

4.11.3. Cancel device job

POST /papis/v1/projects/{projectId}/devices/beacons/jobs/_cancel
Parameters
Type Name Description Schema Default

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
  • /

4.11.4. Create device job

PUT /papis/v1/projects/{projectId}/devices/beacons/jobs/_create
Parameters
Type Name Description Schema Default

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
  • /

4.11.5. Create device jobs by template

PUT /papis/v1/projects/{projectId}/devices/beacons/jobs/_create/template
Parameters
Type Name Description Schema Default

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
  • /

4.11.6. Get beacon jobs

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/jobs
Parameters
Type Name Description Schema Default

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
  • /

4.11.7. Get beacon jobs by beacon id and job id

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/jobs/{jobId}
Parameters
Type Name Description Schema Default

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
  • /

4.11.8. Get beacon job configuration

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/jobs/{jobId}/configData
Parameters
Type Name Description Schema Default

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
  • /

4.11.9. Get beacon job logs

GET /papis/v1/projects/{projectId}/devices/beacons/{beaconId}/jobs/{jobId}/logs
Parameters
Type Name Description Schema Default

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
  • /

4.12. DeviceRegistry

Device Registry Controller

4.12.1. 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
  • /

4.13. DeviceSelfie

Device Selfie Controller

4.13.1. Update beacon selfie

PUT /papis/v1/projects/{projectId}/selfies/beacons/{deviceId}
Parameters
Type Name Description Schema Default

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
  • /

4.13.2. Update blufi selfie

PUT /papis/v1/projects/{projectId}/selfies/blufis/{deviceId}
Parameters
Type Name Description Schema Default

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
  • /

4.13.3. Get device selfie

GET /papis/v1/projects/{projectId}/selfies/{deviceSelfieId}
Parameters
Type Name Description Schema Default

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
  • /

4.14. DeviceTemplates

Device Template Controller

4.14.1. Get device templates

GET /papis/v1/projects/{projectId}/deviceTemplates
Parameters
Type Name Description Schema Default

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
  • /

4.15. DeviceTypes

Device Type Controller

4.15.1. 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
  • /

4.15.2. Get device type

GET /papis/v1/deviceTypes/{code}
Parameters
Type Name Description Schema Default

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
  • /

4.15.3. Get system template

GET /papis/v1/deviceTypes/{code}/template
Parameters
Type Name Description Schema Default

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
  • /

4.16. History

History Controller

4.16.1. Get rcm data mag state aggregation json

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

download
optional

download

boolean

"true"

Query

endDate
optional

endDate

string

Query

format
required

format

enum (json)

"json"

Query

startDate
optional

startDate

string

Responses
HTTP Code Description Schema

200

OK

< MagAdDataStateAggegration > 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

4.16.2. Get all aggregate history by csv

GET /papis/v1/history/metric/aggregate/{projectId}
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Query

beaconId
required

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

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

4.16.3. Search aggregate metrics by beacon csv

POST /papis/v1/history/metric/{projectId}
Parameters
Type Name Description Schema Default

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

4.16.4. Get aggregate metrics by beacon csv

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

endDate
optional

endDate

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

interval
required

interval

string

Query

metric
required

metric

enum (TEMP, RSSI, PER_BLUFI_RSSI, LUMS, X_ACCEL, Y_ACCEL, Z_ACCEL, X_MAG, Y_MAG, Z_MAG, MAG_STATE, BATTERY)

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

4.16.5. Search aggregate metrics by beacon csv

POST /papis/v1/history/metric_csv/{projectId}
Parameters
Type Name Description Schema Default

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

4.16.6. Get read data csv upload

GET /papis/v1/history/readdata/{projectId}
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

dataType
optional

dataType

string

Query

dir
optional

dir

string

Query

endDate
optional

endDate

string

Query

filename
optional

filename

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

password
optional

password

string

Query

port
optional

port

string

Query

separator
optional

separator

string

"default"

Query

server
optional

server

string

Query

startDate
optional

startDate

string

Query

upload
required

upload

enum (true)

"true"

Query

username
optional

username

string

Query

x_tools
optional

x_tools

boolean

"false"

Responses
HTTP Code Description Schema

204

No Content

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

4.16.7. Get read data csv compressed

GET /papis/v1/history/readdata/{projectId}/compressed
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Query

beaconId
optional

beaconId

< string > array(multi)

Query

dataType
optional

dataType

string

Query

endDate
optional

endDate

string

Query

filename
optional

filename

string

Query

format
required

format

enum (csv)

"csv"

Query

header
optional

header

boolean

"true"

Query

separator
optional

separator

string

"default"

Query

startDate
optional

startDate

string

Query

x_tools
optional

x_tools

boolean

"false"

Responses
HTTP Code Description Schema

200

OK

CompressedCSVResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

4.17. Locations

Location Controller

4.17.1. Create location

POST /papis/v1/projects/{projectId}/locations
Parameters
Type Name Description Schema Default

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
  • /

4.17.2. Get locations

GET /papis/v1/projects/{projectId}/locations
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

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
  • /

4.17.3. Delete Locations

PUT /papis/v1/projects/{projectId}/locations/_delete
Parameters
Type Name Description Schema Default

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
  • /

4.17.4. Import locations

PUT /papis/v1/projects/{projectId}/locations/_import
Parameters
Type Name Description Schema Default

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
  • /

4.17.5. Get location

GET /papis/v1/projects/{projectId}/locations/{locationId}
Parameters
Type Name Description Schema Default

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
  • /

4.17.6. Update location

PUT /papis/v1/projects/{projectId}/locations/{locationId}
Parameters
Type Name Description Schema Default

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
  • /

4.17.7. 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)

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
  • /

4.17.8. Get blufis in location

GET /papis/v1/projects/{projectId}/locations/{locationId}/blufis
Parameters
Type Name Description Schema Default

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
  • /

Caution

This operation is deprecated.

4.17.9. Get location data

GET /papis/v1/projects/{projectId}/locations/{locationId}/data
Parameters
Type Name Description Schema Default

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
  • /

4.17.10. Update location data

PUT /papis/v1/projects/{projectId}/locations/{locationId}/data
Parameters
Type Name Description Schema Default

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
  • /

4.17.11. Delete location data

DELETE /papis/v1/projects/{projectId}/locations/{locationId}/data
Parameters
Type Name Description Schema Default

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
  • /

4.17.12. Update location data layers

PUT /papis/v1/projects/{projectId}/locations/{locationId}/data-layers
Parameters
Type Name Description Schema Default

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
  • /

4.17.13. Get location policies

GET /papis/v1/projects/{projectId}/locations/{locationId}/policies
Parameters
Type Name Description Schema Default

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
  • /

4.17.14. Get location policies by type

GET /papis/v1/projects/{projectId}/locations/{locationId}/policies/{metricType}
Parameters
Type Name Description Schema Default

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
  • /

4.17.15. Get virtual devices in location

GET /papis/v1/projects/{projectId}/locations/{locationId}/virtualDevices
Parameters
Type Name Description Schema Default

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
  • /

4.18. ManufactureData

Portal Mfg Data Controller

4.18.1. 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
  • /

4.18.2. Get key data by id

GET /papis/v1/mfgdata/devices/keydata/{id64}
Parameters
Type Name Description Schema Default

Path

id64
required

id64

string

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
  • application/octet-stream

4.18.3. Get manufacture data by id64

GET /papis/v1/mfgdata/devices/{id64}
Parameters
Type Name Description Schema Default

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
  • /

4.19. Policies

Policy Controller

4.19.1. Create policy

POST /papis/v1/projects/{projectId}/policies
Parameters
Type Name Description Schema Default

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
  • /

4.19.2. Get policies

GET /papis/v1/projects/{projectId}/policies
Parameters
Type Name Description Schema Default

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
  • /

4.19.3. Delete policy

PUT /papis/v1/projects/{projectId}/policies/_delete
Parameters
Type Name Description Schema Default

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
  • /

4.19.4. Add policy event state change

POST /papis/v1/projects/{projectId}/policies/_policyEvent
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

Body

policyStateChangeEvent
required

policyStateChangeEvent

PolicyStateChangeEvent

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
  • /

4.19.5. 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
  • /

4.19.6. 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

policyId
required

policyId

< integer(int64) > array(multi)

Query

startDate
optional

startDate

string

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
  • /

4.19.7. Get policy

GET /papis/v1/projects/{projectId}/policies/{policyId}
Parameters
Type Name Description Schema Default

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
  • /

4.19.8. Update policy

PUT /papis/v1/projects/{projectId}/policies/{policyId}
Parameters
Type Name Description Schema Default

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
  • /

4.19.9. Get available beacons

GET /papis/v1/projects/{projectId}/policies/{policyId}/_availableBeacons
Parameters
Type Name Description Schema Default

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
  • /

4.19.10. Get available blufis

GET /papis/v1/projects/{projectId}/policies/{policyId}/_availableBlufis
Parameters
Type Name Description Schema Default

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
  • /

4.19.11. Get policies for beacon

GET /papis/v1/projects/{projectId}/policies/{policyId}/beacons
Parameters
Type Name Description Schema Default

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
  • /

4.19.12. Update policies for beacon

PUT /papis/v1/projects/{projectId}/policies/{policyId}/beacons
Parameters
Type Name Description Schema Default

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
  • /

4.19.13. Get policies for blufi

GET /papis/v1/projects/{projectId}/policies/{policyId}/blufis
Parameters
Type Name Description Schema Default

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
  • /

4.19.14. Update policies for blufi

PUT /papis/v1/projects/{projectId}/policies/{policyId}/blufis
Parameters
Type Name Description Schema Default

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
  • /

4.19.15. Get policy events

GET /papis/v1/projects/{projectId}/policies/{policyId}/events
Parameters
Type Name Description Schema Default

Path

policyId
required

policyId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Responses
HTTP Code Description Schema

200

OK

PageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.19.16. Get policy events paged

POST /papis/v1/projects/{projectId}/policies/{policyId}/events/_query
Parameters
Type Name Description Schema Default

Path

policyId
required

policyId

integer(int64)

Path

projectId
required

projectId

integer(int64)

Body

query
required

query

PageQuery

Responses
HTTP Code Description Schema

200

OK

PageResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

480

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

ErrorMessage

500

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

ErrorMessage

Consumes
  • application/json

Produces
  • /

4.19.17. Get policy event details

GET /papis/v1/projects/{projectId}/policies/{policyId}/events/{eventId}
Parameters
Type Name Description Schema Default

Path

eventId
required

eventId

integer(int64)

Path

policyId
required

policyId

integer(int64)

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
  • /

4.19.18. Get policy violations for policy

GET /papis/v1/projects/{projectId}/policies/{policyId}/violations
Parameters
Type Name Description Schema Default

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
  • /

4.19.19. Clear policy violations

DELETE /papis/v1/projects/{projectId}/policies/{policyId}/violations
Parameters
Type Name Description Schema Default

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
  • /

4.19.20. Clear project violations

DELETE /papis/v1/projects/{projectId}/violations
Parameters
Type Name Description Schema Default

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
  • /

4.20. Projects

Project Controller

4.20.1. Create a project

POST /papis/v1/projects
Parameters
Type Name Description Schema Default

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
  • /

4.20.2. 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
  • /

4.20.3. Get a project by its id

GET /papis/v1/projects/{projectId}
Parameters
Type Name Description Schema Default

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
  • /

4.20.4. Update a project

PUT /papis/v1/projects/{projectId}
Parameters
Type Name Description Schema Default

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
  • /

4.20.5. setProjectContext

PUT /papis/v1/projects/{projectId}/_set
Parameters
Type Name Description Schema Default

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
  • /

4.20.6. Get project api access

GET /papis/v1/projects/{projectId}/apiAccess
Parameters
Type Name Description Schema Default

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
  • /

4.20.7. Get project context

GET /papis/v1/projects/{projectId}/context
Parameters
Type Name Description Schema Default

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
  • /

4.20.8. adminClearPolicyEvent

PUT /papis/v1/projects/{projectId}/events/_clear
Parameters
Type Name Description Schema Default

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
  • /

4.20.9. Get project RtlsSetting

GET /papis/v1/projects/{projectId}/rtlsSetting
Parameters
Type Name Description Schema Default

Path

projectId
required

projectId

integer(int64)

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
  • /

4.20.10. Update Project Rtls Setting

PUT /papis/v1/projects/{projectId}/rtlsSetting
Parameters
Type Name Description Schema Default

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
  • /

4.20.11. Update a projects show intro flag

PUT /papis/v1/projects/{projectId}/showIntro
Parameters
Type Name Description Schema Default

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
  • /

4.20.12. Get all policy violations

GET /papis/v1/projects/{projectId}/violations
Parameters
Type Name Description Schema Default

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
  • /

4.21. Provisioning

Beacon Provisioning Controller

4.21.1. Get beacon template tags

GET /sapis/v1/provisioning/beaconTemplates/{templateId}/tags
Parameters
Type Name Description Schema Default

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
  • /

4.21.2. Register beacon

POST /sapis/v1/provisioning/beacons
Parameters
Type Name Description Schema Default

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
  • /

4.21.3. Get beacon signal

POST /sapis/v1/provisioning/beacons/signal
Parameters
Type Name Description Schema Default

Body

beaconSignal
required

beaconSignal

BeaconSignalRequest

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
  • /

4.21.4. Get provisioning beacon

GET /sapis/v1/provisioning/beacons/{beaconId}
Parameters
Type Name Description Schema Default

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
  • /

4.21.5. Update provisioning beacon

PUT /sapis/v1/provisioning/beacons/{deviceId}
Parameters
Type Name Description Schema Default

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
  • /

4.21.6. Get beacon selfie

GET /sapis/v1/provisioning/beacons/{deviceId}/selfie
Parameters
Type Name Description Schema Default

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
  • /

4.21.7. Get beacon selfie view

GET /sapis/v1/provisioning/beacons/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.21.8. Delete beacon selfie

DELETE /sapis/v1/provisioning/beacons/{deviceId}/selfies/{deviceSelfieId}
Parameters
Type Name Description Schema Default

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
  • /

4.21.9. Get beacon templates

GET /sapis/v1/provisioning/beacons/{deviceId}/templates
Parameters
Type Name Description Schema Default

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
  • /

4.21.10. 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
  • /

4.21.11. Get blufi template scan mode

GET /sapis/v1/provisioning/blufiTemplates/{templateId}/scanMode
Parameters
Type Name Description Schema Default

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
  • /

4.21.12. Get blufi template tags

GET /sapis/v1/provisioning/blufiTemplates/{templateId}/tags
Parameters
Type Name Description Schema Default

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
  • /

4.21.13. Get blufi selfie view

GET /sapis/v1/provisioning/blufis/{deviceId}/selfie/_view
Parameters
Type Name Description Schema Default

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
  • /

4.21.14. Get blufi status by id

GET /sapis/v1/provisioning/blufis/{sid64}
Parameters
Type Name Description Schema Default

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
  • /

4.21.15. Update blufi

PUT /sapis/v1/provisioning/blufis/{sid64}
Parameters
Type Name Description Schema Default

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
  • /

4.21.16. 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
  • /

4.21.17. Start transaction

POST /sapis/v1/provisioning/transactions
Parameters
Type Name Description Schema Default

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
  • /

4.21.18. Get transaction

GET /sapis/v1/provisioning/transactions/{transactionId}
Parameters
Type Name Description Schema Default

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
  • /

4.21.19. Acknowledge command

POST /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}
Parameters
Type Name Description Schema Default

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
  • /

4.21.20. Acknowledge command

GET /sapis/v1/provisioning/transactions/{transactionId}/ack/{seq}
Parameters
Type Name Description Schema Default

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-ErrorMe