Skip to content

Beacon Sets

create

Creates a new beacon set.

HTTP Request

POST https://api.solvebio.com/v2/beacon_sets

Parameters

This request does not accept URL parameters.

Authorization

All users can create new beacon sets.

Request Body

In the request body, provide a single beacon set resource.

Property Value Description
title string The title for the beacon set. This is displayed on the web interface.
description string (Optional) A description with supplementary information about the beacon set.
is_shared boolean If true, everyone else in your account will be able to see and query the beacon set, but will not be able to edit it. Defaults to false.

Response

The response contains a single beacon set resource.

list

Retrieve a list of all beacon sets visible to you.

HTTP Request

GET https://api.solvebio.com/v2/beacon_sets

Parameters

This request accepts the following query parameters:

Parameter Value Description
account_id integer The ID of the account that created the beacon set.
is_shared boolean Filters shared or private beacon sets.
user_id integer The ID of the user that created the beacon set.
vault_id integer Filters beacon sets containing beacons linked to a particular vault.
vault_object_id integer Filters beacon sets containing beacons linked to a particular vault object.

Authorization

All beacon sets visible to the current user are included in this response.

Request Body

Do not supply a request body with this method.

Response

The response returns a list of beacon sets matching the provided filters.

update

HTTP Request

PUT https://api.solvebio.com/v2/beacon_sets/{ID}

Parameters

This request does not accept URL parameters.

Authorization

The target beacon set must be owned by the current user in order to be modified.

Request Body

In the request body, provide a valid beacon set object (see create above).

Response

The response contains the updated beacon set resource.

delete

HTTP Request

DELETE https://api.solvebio.com/v2/beacon_sets/{ID}

Parameters

This request does not accept URL parameters.

Authorization

The target beacon set must be owned by the current user in order to be deleted.

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/beacon_sets/{ID}

Parameters

This request does not accept URL parameters.

Authorization

If the beacon set is visible to the current user, it can be retrieved.

Request Body

Do not supply a request body with this method.

Response

The response contains a beacon set resource.

query

Queries a beacon set.

HTTP Request

POST https://api.solvebio.com/v2/beacon_sets/{ID}/query

Parameters

This request does not accept URL parameters.

Authorization

All users can query any beacon set visible to them.

Request Body

In the request body, provide a beacon query:

Property Value Description
query string An entity ID or other arbitrary query string.
entity_type string (Optional) One of the following entity types: gene, variant, literature.

Omitting the entity_type property (or setting it to null) will query all the string/text fields in all the beacons.

Response

The response contains a beacon set query response with the following properties:

Property Value Description
query string The entity ID or query string provided.
entity_type string The entity type provided in the query.
beacon_set object The beacon set resource queried.
beacons object (list) The list of beacons queried, with result summaries..
found_count integer The number of beacons with records matching the query.
not_found_count integer The number of beacons without any records matching the query.
failed_count integer The number of beacons that could not be queried.

Beacons may fail for any of the following reasons:

  • They do not support the requested entity type.
  • The beacon's filter parameters are invalid for the dataset.
  • An internal server error occurred.