...
| Code Block |
|---|
curl -X GET \ https://bluzone.io/portal/papis/v1/projects/<YOUR_PROJECT_ID_HERE>/devices/beacons/<BEACON_ID_HERE> \ -H 'bzid: <YOUR_API_KEY_HERE>' |
APIs Examples
Most Bluzone APIs follow restful patterns. Business use cases often require simplified APIs to perform repetitive and high value tasks. The best solution for these business needs is not always the most "RESTful" pattern. When Bluzone APIs break out of a true "RESTful" pattern, the API becomes more task oriented and begins with an underscore. This section will use three common APIs as examples of this "RPC" type pattern in Bluzone APIs.
Project Rename
This API will rename the current project in context with the name supplied in the JSON body.
Sample Body
```json
{
"projectName": "New Name Value"
}
```
API Details
| Method | PUT |
|---|---|
| URI | /portal/papis/v1/projects/{{projectId}}/_rename |
| Accept | application/json |
| Response | Project.json |
Beacon Rename
Rename a Beacon in context with the newly supplied name.
Sample Body
```json
{
"beaconName": "New Name Value"
}
```
API Details
| Method | PUT |
|---|---|
| URI | /portal/papis/v1/projects/{{projectId}}/devices/beacons/{{beacon.deviceId}}/_rename |
| Accept | application/json |
| Response | Beacon.json |
Blufi Rename
Rename a Blufi in context with the newly supplied name.
Sample Body
```json
{
"blufiName": "New Name Value"
}
```
API Details
| Method | PUT |
|---|---|
| URI | /portal/papis/v1/projects/{{projectId}}/devices/blufis/{{blufi.deviceId}}/_rename |
| Accept | application/json |
| Response | Blufi.json |