GA4GH Beacon API Specification - Analysis endpoints (2.0.0)

Download OpenAPI specification:Download

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

TBD

GET Endpoints

getAnalyses

Get a list of bioinformatics analysis

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.

filters
Array of strings
Examples: filters=variantcaller:GATK4.0

Responses

Response samples

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

getOneAnalysis

Get details about one bioinformatics analysis, identified by its (unique) 'id'

path Parameters
id
required
string

Responses

Response samples

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

getOneAnalysisVariants

Get the list of variants instances for one bioinformatics analysis, 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

postAnalysesRequest

Get a list of bioinformatics analysis

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
{
  • "beaconHandovers": [],
  • "info": { },
  • "meta": {
    },
  • "response": {},
  • "responseSummary": {
    }
}

postOneAnalysisRequest

Get details about one bioinformatics analysis, 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": {
    }
}

postOneAnalysisVariantsRequest

Get the list of variants instances for one bioinformatics analysis, 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": {
    }
}