Beacon Endpoints¶
Beacons and Beacon Sets provide an easy way to search multiple datasets across SolveBio at once for a specific entity.
A Beacon Set is an arbitrary grouping of Beacons that can be private to a user or shared with their whole account. Beacons can only be created with a Beacon Set.
There are two API endpoints relevant to Beacons: /v2/beacon_sets and /v2/beacons.
Beacon Sets¶
For more information about Beacon Sets endpoints, see the Beacon Sets Reference.
| Method | HTTP Request | Description |
|---|---|---|
| create | POST /v2/beacon_sets | Create a beacon set. |
| list | GET /v2/beacon_sets | List beacon sets. |
| update | PUT /v2/beacon_sets/{BEACON_SET_ID} | Update a beacon set. |
| delete | DELETE /v2/beacon_sets/{BEACON_SET_ID} | Delete a beacon set (and all beacons). |
| get | GET /v2/beacon_sets/{BEACON_SET_ID} | Retrieve metadata about a beacon set. |
| query | POST /v2/beacon_sets/{BEACON_SET_ID}/query | Query a beacon set. |
Beacons¶
For more information about Beacons endpoints, see the Beacons Reference.
| Method | HTTP Request | Description |
|---|---|---|
| create | POST /v2/beacons | Create a beacon. |
| list | GET /v2/beacons | List all beacons. |
| update | PUT /v2/beacons/{BEACON_ID} | Update a beacon. |
| delete | DELETE /v2/beacons/{BEACON_ID} | Delete a beacon. |
| get | GET /v2/beacons/{BEACON_ID} | Retrieve metadata about a beacon. |
| query | POST /v2/beacons/{BEACON_ID}/query | Query a beacon. |