Beacons¶
create¶
Add a new beacon to an existing beacon set. The beacon set must already exist in order to create beacons (see the beacon set reference).
HTTP Request
POST https://api.solvebio.com/v2/beacons
Parameters
This request does not accept URL parameters.
Authorization
All users can create new beacons. The parent beacon set must be owned by the current user.
Request Body
In the request body, provide a single beacon resource.
| Property | Value | Description |
|---|---|---|
| beacon_set_id | integer | The ID of the parent beacon set, which must be owned by the current user. |
| title | string | The title displayed for the beacon. |
| vault_object_id | string | The ID of the vault object (i.e. dataset) queried by the beacon. |
| description | string | (Optional) A description of the beacon. |
| params | object | (Optional) Additional query parameters (filters) which can be used to scope the dataset query. |
The params property must be an object containing valid dataset filters, for example:
{"filters": [["my_field", "value"]]}
For more information about constructing filters, see the dataset query reference.
Response
The response contains a single beacon resource.
list¶
Retrieve a list of all beacons visible to the current user.
HTTP Request
GET https://api.solvebio.com/v2/beacons
Parameters
This request accepts the following parameters:
| Parameter | Value | Description |
|---|---|---|
| beacon_set_id | integer | Filter by the parent beacon set's ID. |
| vault_id | integer | Filters beacons linked to a particular vault. |
| vault_object_id | integer | Filters beacons linked to a particular vault object. |
Authorization
All public beacons, beacons private to the user, and beacons shared by members of the user's account are included in this response.
Request Body
Do not supply a request body with this method.
Response
The response returns a list of beacons matching the provided filters.
update¶
HTTP Request
PUT https://api.solvebio.com/v2/beacons/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires that the user be the creator of the beacon.
Request Body
In the request body, provide a valid beacon object (see create above).
Response
The response contains the updated beacon resource.
delete¶
HTTP Request
DELETE https://api.solvebio.com/v2/beacons/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires that the user be the creator of the beacon.
Request Body
Do not supply a request body with this method.
Response
The response returns "HTTP 200 OK" when successful.
get¶
HTTP Request
GET https://api.solvebio.com/v2/beacons/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires that the beacon is visible to the user.
Request Body
Do not supply a request body with this method.
Response
The response contains a beacon resource.