Documentation Powered by Redocly

GA4GH Beacon API Specification (2.0.0)

Download OpenAPI specification:Download

E-mail: beacon@ga4gh.org License: Apache 2.0

A Beacon is a web service for genetic data sharing that can be queried for information about variants, individuals, biosamples, and other entities.

Informational endpoints

getBeaconRoot

Get information about the beacon

query Parameters
requestedSchema
string
Example: requestedSchema=ga4gh-service-info-v1.0

Schema to be used to format the result field in the resposne. The response will use Beacon format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

getBeaconInfoRoot

Get information about the beacon

query Parameters
requestedSchema
string
Example: requestedSchema=ga4gh-service-info-v1.0

Schema to be used to format the result field in the resposne. The response will use Beacon format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

getBeaconServiceInfo

Get information about the beacon using GA4GH ServiceInfo format

Responses

Response samples

Content type
application/json
{
  • "id": "org.ga4gh.myservice",
  • "name": "My project",
  • "type": {
    },
  • "description": "This service provides...",
  • "organization": {},
  • "contactUrl": "mailto:support@example.com",
  • "documentationUrl": "https://docs.myservice.example.com",
  • "createdAt": "2019-06-04T12:58:19Z",
  • "updatedAt": "2019-06-04T12:58:19Z",
  • "environment": "test",
  • "version": "1.0.0"
}

getFilteringTerms

Get the list of filtering terms handled by this beacon

query Parameters
skip
integer (Skip) >= 0
Default: 0
Example: skip=0
  • In the request: number of pages to skip * In the response: number of pages that has been skipped
limit
integer (Limit) >= 0
Default: 10
Example: limit=10

Size of the page. Use 0 to return all the results or the maximum allowed by the Beacon, if there is any.

Responses

Configuration

getBeaconConfiguration

TBD

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

getBeaconMap

TBD

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {}
}

getEntryTypes

TBD

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}