Documentation Powered by Redocly

GA4GH Beacon API Specification - Genomic Variations Endpoints (2.0.0)

Download OpenAPI specification:Download

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

TBD

GET Endpoints

getExampleEntries

Get a list of example entries

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

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

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.

start
Array of integers <int64> [ 1 .. 2 ] items [ items <int64 > >= 0 ]
end
Array of integers <int64> [ 0 .. 2 ] items [ items <int64 > >= 0 ]
assemblyId
string
referenceName
string
referenceBases
string
alternateBases
string
variantMinLength
integer <int64> >= 0
variantMaxLength
integer <int64> >= 0
allele
string
Example: allele=NM_004006.2:c.4375C>T
geneid
string
Example: geneid=BRAF
aminoacidchange
string
Example: aminoacidchange=V600E
filters
Array of strings
Examples: filters=EFO:0009655 filters=NCIT:C48725&filters=NCIT:C28080

Responses

Response samples

Content type
application/json
Example
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "responseSummary": {
    }
}

getOneGenomicVariation

Get details about one genomic variation, identified by its (unique) 'id'

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "responseSummary": {
    }
}

getOneGenomicVariantBiosamples

Get the biosamples list from one genomic variant, identified by its (unique) 'id'

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

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

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

Response samples

Content type
application/json
Example
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "responseSummary": {
    }
}

getOneGenomicVariantIndividuals

Get the individuals list from one genomic variant, identified by its (unique) 'id'

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

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

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

Response samples

Content type
application/json
Example
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "responseSummary": {
    }
}

POST Endpoints

postExampleEntriesRequest

Get a list of example entries

Request Body schema: application/json
$schema
string ($schema)

Refers to the JSON Schema which describes the set of valid attributes for this particular document type. This attribute is mostly used in schemas that should be tested in Beacon implementations.

required
object (beaconRequestMeta)

Meta section of the Beacon request. It includes request context details relevant for the Beacon server when processing the request.

object

Parameters to limit the list of returned results.

Responses

Request samples

Content type
application/json
{
  • "$schema": "string",
  • "meta": {
    },
  • "query": {
    }
}

Response samples

Content type
application/json
Example
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "responseSummary": {
    }
}

postOneGenomicVariation

Get details about one genomic variation, identified by its (unique) 'id'

path Parameters
id
required
string
Request Body schema: application/json
$schema
string ($schema)

Refers to the JSON Schema which describes the set of valid attributes for this particular document type. This attribute is mostly used in schemas that should be tested in Beacon implementations.

required
object (beaconRequestMeta)

Meta section of the Beacon request. It includes request context details relevant for the Beacon server when processing the request.

object

Parameters to limit the list of returned results.

Responses

Request samples

Content type
application/json
{
  • "$schema": "string",
  • "meta": {
    },
  • "query": {
    }
}

Response samples

Content type
application/json
Example
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "responseSummary": {
    }
}

postOneGenomicVariantBiosamples

Get the biosamples list from one genomic variant, identified by its (unique) 'id'

path Parameters
id
required
string
Request Body schema: application/json
$schema
string ($schema)

Refers to the JSON Schema which describes the set of valid attributes for this particular document type. This attribute is mostly used in schemas that should be tested in Beacon implementations.

required
object (beaconRequestMeta)

Meta section of the Beacon request. It includes request context details relevant for the Beacon server when processing the request.

object

Parameters to limit the list of returned results.

Responses

Request samples

Content type
application/json
{
  • "$schema": "string",
  • "meta": {
    },
  • "query": {
    }
}

Response samples

Content type
application/json
Example
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "responseSummary": {
    }
}

postOneGenomicVariantIndividuals

Get the biosamples list from one genomic variant, identified by its (unique) 'id'

path Parameters
id
required
string
Request Body schema: application/json
$schema
string ($schema)

Refers to the JSON Schema which describes the set of valid attributes for this particular document type. This attribute is mostly used in schemas that should be tested in Beacon implementations.

required
object (beaconRequestMeta)

Meta section of the Beacon request. It includes request context details relevant for the Beacon server when processing the request.

object

Parameters to limit the list of returned results.

Responses

Request samples

Content type
application/json
{
  • "$schema": "string",
  • "meta": {
    },
  • "query": {
    }
}

Response samples

Content type
application/json
Example
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "responseSummary": {
    }
}