Skip to content
Docs

beacon_operations.get_full_result

GET
/result/{queue_id}

Get full Beacon result for a search

Parameters

Path Parameters

queue_id
required
string

Responses

200

OK

Beacon response that includes record level details, grouped in Resultsets.

object
beaconHandovers

Set of handovers to be added in one section the response.

Array<object>

A handover is a typed link for attaching actionable links to results, non purely informational, requests. The goal of the handovers is to list the different actions available, e.g.:

  • a link to a request access page * linking to a file for download, e.g. a VCF file Another common scenario is to provide a fast summary response (e.g. BeconCountResponse) and to provide access to different endpoints for the entities matched by the query using temporary access tokens in the handover URLs.
object
handoverType
required

In our context, only htsget or download urls should be returned

object
id
string
Allowed values: CUSTOM
label
string
Allowed values: HTSGET DOWNLOAD
note

An optional text including considerations on the handover link provided.

string
This handover link provides access to a summarized VCF.
url
required

URL endpoint to where the handover process could progress, in RFC3986 format

string format: uri 
https://api.mygenomeservice.org/Handover/9dcc48d7-fc88-11e8-9110-b0c592dbf8c0/
info

Placeholder to allow the Beacon to return any additional information that is necessary or could be of interest in relation to the query or the entry returned. It is recommended to encapsulate additional informations in this attribute instead of directly adding attributes at the same level than the others in order to avoid collision in the names of attributes in future versions of the specification.

object
meta
required

Information about the response that could be relevant for the Beacon client in order to interpret the results.

object
apiVersion
required

Version of API, e.g. in request or response. Beacon uses a Github-style, “v”-prefixed semantic versioning format.

string
beaconId
required

The Id of a Beacon. Usually a reversed domain string, but any URI is acceptable. The purpose of this attribute is, in the context of a Beacon network, to disambiguate responses coming from different Beacons.

string
receivedRequestSummary
required

Section of the response that summarize the request received as it has been interpreted by the Beacon server. This summary can help to identify differences between the incoming request and its interpretation or processing, e.g. in the response granularity or pagination. The required properties include those that should be part of every request.

object
apiVersion
required

Version of API, e.g. in request or response. Beacon uses a Github-style, “v”-prefixed semantic versioning format.

string
requestedSchemas
required

Set of schemas to be used in the response to a request.

Array<object>

Schema to be used for the requested entry type in the response.

object
entityType
string
Individual
schema
string
filters

Ontology based filters. A CURIE syntax is encouraged to be used.

Array<string>
[
  "BTO:0000199",
  "PATO:0000383"
]
requestParameters
object
alternateBases

Alternate bases for this variant (starting from start). * Accepted values: [ACGTN]* * N is a wildcard, that denotes the position of any base, and can be used as a standalone base of any type or within a partially known sequence. As example, a query of ANNT the Ns can take take any form of [ACGT] and will match ANNT, ACNT, ACCT, ACGT … and so forth.

  • an empty value is used in the case of deletions with the maximally trimmed, deleted sequence being indicated in ReferenceBases
  • Categorical variant queries, e.g. such not being represented through sequence & position, make use of the variantType parameter.
  • either alternateBases or variantType is required.
string
/^([ACGTUNRYSWKMBDHV\-\.]*)$/
aminoacidChange

Aminoacid alteration of interest. Format 1 letter, e.g. “V600E”

string
assemblyId

Genomic assembly accession and version as RefSqeq assembly accession (e.g. “GCF_000001405.39”) or a versioned assembly name or synonym such as UCSC Genome Browser assembly (e.g. “hg38”) or Genome Reference Consortium Human (e.g. “GRCh38.p13”) names.

string
default: hg38 
[
  "GCF_000001405.39",
  "hg38",
  "GRCh38.p13"
]
end

Precise or bracketing the end of the variants of interest: * (0-based, exclusive) - see start * for bracket queries, provide 2 values (e.g. [111,222]).”

Array<integer>
<= 2 items
geneId
string
genomicAlleleShortForm

HGVSId descriptor, e.g. NC_000017.11:g.43057063G>A

string
referenceBases

Reference bases for this variant (starting from start). * Accepted values: [ACGTN]* * N is a wildcard, that denotes the position of any base, and can be used as a standalone base of any type or within a partially known sequence. As example, a query of ANNT the Ns can take take any form of [ACGT] and will match ANNT, ACNT, ACCT, ACGT … and so forth.

  • an empty value is used in the case of insertions with the maximally trimmed, inserted sequence being indicated in AlternateBases
string
/^([ACGTUNRYSWKMBDHV\-\.]*)$/
referenceName

Reference sequence id for genomic reference sequence in which variant coordinates are given, e.g. “refseq:NC_000009.12” for human chromosome 9 in the GRCh38 assembly. The use of the assembly specific RefSeqId is recommended although alternatively names, synonymous or aliases e.g. “chr9” could be used in conjunction with an Assembly parameter.

string
[
  "refseq:NC_000009.12",
  "chr9",
  "NC_012920.1"
]
start

Precise or fuzzy start coordinate position(s), allele locus (0-based, inclusive). * start only:

  • for single positions, e.g. the start of a specified sequence alteration where the size is given through the specified alternateBases
  • typical use are queries for SNV and small InDels
  • the use of start without an end parameter requires the use of alternateBases
  • start and end:
    • for searching any variant falling fully or partially within the range between start and end (a.k.a. “range query”)
    • additional use of variantType OR alternateBases can limit the scope of the query
    • by convention, partial overlaps of variants with the indicated genomic range are accepted; for specific overlap requirements the 4-parameter “Bracket Queries” should be employed
  • 2 values in both start and end for constructing a “Bracket Query”:
    • can be used to match any contiguous genomic interval, e.g. for querying imprecise positions
    • identifies all structural variants starting between start[0] and start[1], and ending between end[0] <-> end[1]
    • single or double sided precise matches can be achieved by setting start[1]=start[0]+1 and end[1]=end[0]+1
Array<integer>
>= 1 items <= 2 items
variantMaxLength
  • Maximum length in bases of a genomic variant. * This is an optional parameter without prescribed use. While a length is commonly available for structural variants such as copy number variations, it is recommended that length based queries should also be supported for variants with indicated referenceBases and alternateBases, to enable length-specific wildcard queries.
integer format: int64
>= 1
variantMinLength
  • Minimum length in bases of a genomic variant * This is an optional parameter without prescribed use. While a length is commonly available for structural variants such as copy number variations, it is recommended that length based queries should also be supported for variants with indicated referenceBases and alternateBases, to enable length-specific wildcard queries.
integer format: int64
variantType

The variantType is used to query variants which are not defined through a sequence of one or more bases using the alternateBases parameter. Examples here are e.g. structural variants: * DUP

  • increased allelic count of material from the genomic region between start and end positions
  • no assumption about the placement of the additional sequences is being made (i.e. no in situ requirement as tandem duplications)
  • DEL: deletion of sequence following start The Beacon model is not prescriptive with regard to the values allowed for variantType with use of extended types (such as from EFO:0030063) being possible. However, a support for the basic CNV types above - where represented in the data - is recommended. Either alternateBases or variantType is required, with the exception of range queries (single start and end parameters).
string
includeResultsetResponses

Indicator of whether responses from every Resultset should be included in the response to this request or just the ones with positive, negative results or no details at all. If null (not specified), the default value of ‘HIT’ is assumed. This parameter allows for returning boolean/counting results although the Beacon instance is capable to return record level details.

string
default: HIT
Allowed values: ALL HIT MISS NONE
pagination
required

Pagination to apply or that has been applied on the results.

object
currentPage

A hash or similar that allows the server to retrieve a “page”, e.g. (a subset of) a query response.

string
ab0sc&fe1dd
limit

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

integer
default: 10 
10
nextPage

A hash or similar that allows the server to retrieve a “page”, e.g. (a subset of) a query response.

string
ab0sc&fe1dd
previousPage

A hash or similar that allows the server to retrieve a “page”, e.g. (a subset of) a query response.

string
ab0sc&fe1dd
skip
  • In the request: number of pages to skip * In the response: number of pages that has been skipped
integer
0
requestedGranularity
required

Level of detail of the response:

  • boolean: returns true/false’ responses * count: adds the total number of positive results found * aggregated: returns summary, aggregated or distribution like responses * record: returns details for every row. In cases where a Beacon prefers to return records with fewer than allattributes, different strategies have to be considered w/o adding them to the current design, e.g.:
    • keeping non-mandatory attributes empty
    • Beacon to provide a minimal record definition
string
default: boolean
Allowed values: boolean count aggregated record
testMode

Used for indicating that a request or response is done in a test context e.g. for compliance testing i.e. to evaluate the acceptance/understanding of a request and the structure of the returned response by the Beacon instance. A TRUE testMode parameter DOES NOT require that the Beacon instance is a test instance, but that this specific request-response cycle is a testing one. When true the Beacon instance MUST respond the request but it SHOULD use virtual or non-sensitive data. Here, what is being evaluated is the acceptance/understanding of a request and the structure of the returned response by the Beacon instance.

boolean
returnedGranularity
required

Level of detail of the response:

  • boolean: returns true/false’ responses * count: adds the total number of positive results found * aggregated: returns summary, aggregated or distribution like responses * record: returns details for every row. In cases where a Beacon prefers to return records with fewer than allattributes, different strategies have to be considered w/o adding them to the current design, e.g.:
    • keeping non-mandatory attributes empty
    • Beacon to provide a minimal record definition
string
default: boolean
Allowed values: boolean count aggregated record
returnedSchemas
required

Set of schemas to be used in the response to a request.

Array<object>

Schema to be used for the requested entry type in the response.

object
entityType
string
Individual
schema
string
testMode

Used for indicating that a request or response is done in a test context e.g. for compliance testing i.e. to evaluate the acceptance/understanding of a request and the structure of the returned response by the Beacon instance. A TRUE testMode parameter DOES NOT require that the Beacon instance is a test instance, but that this specific request-response cycle is a testing one. When true the Beacon instance MUST respond the request but it SHOULD use virtual or non-sensitive data. Here, what is being evaluated is the acceptance/understanding of a request and the structure of the returned response by the Beacon instance.

boolean
response
required

Sets of results to be returned as query response.

object
resultSets
required
Array
object
exists
required
boolean
id
required

Id of the resultset

string
programA
info

Additional details that could be of interest about the Resultset. Provided to clearly enclose any attribute that is not part of the Beacon specification.

object
results
required
Array<object>

Schema for a genomic variant entry. In this case, each GenomicVariant represents a single alternate allele, with the reference allele assumed from the reference sequence.

object
caseLevelData

CaseLevelData reports about the variation instances observed in individual analyses.

Array<object>
object
alleleOrigin

Ontology value for allele origin of variant in sample from the Variant Origin (SO:0001762). Categories are somatic variant, germline variant, maternal variant, paternal variant, de novo variant, pedigree specific variant, population specific variant. Corresponds to Variant Inheritance in FHIR.

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
analysisId

Reference to the bioinformatics analysis ID (analysis.id)

string
biosampleId
required

Reference to biosample ID (biosample.id). For MoH, this will be {program_id}~{submitter_sample_id}, delimited with a tilde. If this is not available, it will be the name of the sample as listed in the variant file.

string
clinicalInterpretations
Array<object>

List of annotated effects on disease or phenotypes.

object
annotatedWith
object
toolName
required

Name of the tool.

string
toolReferences
required

References to the tool

object
>= 1 properties
key
additional properties
any
version
required

Version used.

string
category

Ontology term for the type of disease, condition, phenotypic measurement, etc.

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
clinicalRelevance

Indication of the clinical relevance of the variant Recommended: A value from the five-tiered classification from the American College of Medical Genetics (ACMG) designed to describe the likelihood that a genomic sequence variant is causative of an inherited disease. (NCIT:C168798).

string
Allowed values: benign likely benign uncertain significance likely pathogenic pathogenic 
pathogenic
conditionId
required

Internal identifier of the phenotype or clinical effect.

string
effect
required

Ontology term for the phenotypic or clinical effect

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
evidenceType

Ontology term for the type of evidence supporting variant-disease association Recommended: values from the Evidence & Conclusion Ontology (ECO)

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
id

Internal id of this case level instance of the variant. This is an optional housekeeping parameter and should not be confused with the identifier of the variant (variantInternalId).

string
individualId

Reference to individual ID (individual.id)

string
phenotypicEffects
Array<object>

List of annotated effects on disease or phenotypes.

object
annotatedWith
object
toolName
required

Name of the tool.

string
toolReferences
required

References to the tool

object
>= 1 properties
key
additional properties
any
version
required

Version used.

string
category

Ontology term for the type of disease, condition, phenotypic measurement, etc.

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
clinicalRelevance

Indication of the clinical relevance of the variant Recommended: A value from the five-tiered classification from the American College of Medical Genetics (ACMG) designed to describe the likelihood that a genomic sequence variant is causative of an inherited disease. (NCIT:C168798).

string
Allowed values: benign likely benign uncertain significance likely pathogenic pathogenic 
pathogenic
conditionId
required

Internal identifier of the phenotype or clinical effect.

string
effect
required

Ontology term for the phenotypic or clinical effect

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
evidenceType

Ontology term for the type of evidence supporting variant-disease association Recommended: values from the Evidence & Conclusion Ontology (ECO)

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
runId

Reference to the experimental run ID (run.id)

string
genotype
object
zygosity
required

Ontology term for zygosity in which variant is present in the sample from the Zygosity Ontology (GENO:0000391) , e.g heterozygous (GENO:0000135)

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
value

VCF GT-style value, e.g. 0/0, 1|2

string
secondaryAlleleIds

VariantInternalIds of the other allele(s) present in this genotype

Array<string>
identifiers
object
clinvarVariantId

ClinVar variant id. Other id values used by ClinVar can be added to variantAlternativeIds

string
/^(clinvar:)?\d+$/
genomicHGVSId

HGVSId descriptor.

string
proteinHGVSIds

List of HGVSId descriptor(s) at protein level (for protein-altering variants).

Array<string>
transcriptHGVSIds

List of HGVSId descriptor(s) at transcript level.

Array<string>
variantAlternativeIds

List of cross-referencing ID(s), for the variant in other databases (e.g. dbSNP, ClinVar, ClinGen, COSMIC), as externalReferences with CURIE(s).

Array<object>
object
molecularAttributes
object
aminoacidChanges

List of change(s) at aminoacid level for protein affecting variants.

Array<string>
geneIds
Array<string>
genomicFeatures
Array<object>

Genomic feature(s) related to the variant. NOTE: Although genes could also be referenced using these attributes, they have an independent section to allow direct queries.

object
featureClass
required

Ontology term that describes the class of genomic feature affected by the variant. Values from SO (Sequence ontology) are recommended, e.g. SO:0001623: 5 prime UTR variant

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
featureID

Where applicable, ID/accession/name of genomic feature related to the featureClass, preferably in CURIE format. If the value is a gene id or name, it points to the gene related to the featureClass, e.g. the 5 prime UTR upstream of TP53

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
molecularEffects

Ontology term that includes describes the class of molecular consequence generated by the variant. Values from SO (Sequence Ontology) are recommended, e.g. SO:0001583: missense variant.

Array<object>

Definition of an ontology term.

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
variantInternalId
required

Reference to the internal variant ID. This represents the primary key/identifier of that variant inside a given Beacon instance. Different Beacon instances may use identical id values, referring to unrelated variants. Public identifiers such as the GA4GH Variant Representation Id (VRSid) MUST be returned in the identifiers section. A Beacon instance can, of course, use the VRSid as their own internal id but still MUST represent this then in the identifiers section.

string
variantLevelData
object
clinicalInterpretations
Array<object>

List of annotated effects on disease or phenotypes.

object
annotatedWith
object
toolName
required

Name of the tool.

string
toolReferences
required

References to the tool

object
>= 1 properties
key
additional properties
any
version
required

Version used.

string
category

Ontology term for the type of disease, condition, phenotypic measurement, etc.

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
clinicalRelevance

Indication of the clinical relevance of the variant Recommended: A value from the five-tiered classification from the American College of Medical Genetics (ACMG) designed to describe the likelihood that a genomic sequence variant is causative of an inherited disease. (NCIT:C168798).

string
Allowed values: benign likely benign uncertain significance likely pathogenic pathogenic 
pathogenic
conditionId
required

Internal identifier of the phenotype or clinical effect.

string
effect
required

Ontology term for the phenotypic or clinical effect

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
evidenceType

Ontology term for the type of evidence supporting variant-disease association Recommended: values from the Evidence & Conclusion Ontology (ECO)

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
phenotypicEffects
Array<object>

List of annotated effects on disease or phenotypes.

object
annotatedWith
object
toolName
required

Name of the tool.

string
toolReferences
required

References to the tool

object
>= 1 properties
key
additional properties
any
version
required

Version used.

string
category

Ontology term for the type of disease, condition, phenotypic measurement, etc.

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
clinicalRelevance

Indication of the clinical relevance of the variant Recommended: A value from the five-tiered classification from the American College of Medical Genetics (ACMG) designed to describe the likelihood that a genomic sequence variant is causative of an inherited disease. (NCIT:C168798).

string
Allowed values: benign likely benign uncertain significance likely pathogenic pathogenic 
pathogenic
conditionId
required

Internal identifier of the phenotype or clinical effect.

string
effect
required

Ontology term for the phenotypic or clinical effect

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
evidenceType

Ontology term for the type of evidence supporting variant-disease association Recommended: values from the Evidence & Conclusion Ontology (ECO)

object
id
required

A W3C Compact URI formatted string. A CURIE string has the structure prefix:reference, as defined by the W3C syntax.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
label

The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.

string
key
additional properties
any
variation
required

A variation on a contiguous molecule.

object
type
required

MUST be “Allele”

string
default: Allele
location
required

A Location defined by an interval on a referenced Sequence.

object
type
required

MUST be “SequenceLocation”

string
default: SequenceLocation
sequence_id
required

A VRS Computed Identifier for the reference Sequence.

string
/^\w[^:]*:.+$/ 
ensembl:ENSG00000139618
interval
required

A SequenceInterval represents a span on a Sequence. Positions are always represented by contiguous spans using interbase coordinates or coordinate ranges.

object
type
required

MUST be “SequenceInterval”

string
default: SequenceInterval
start
required
One of:

A bounded, inclusive range of numbers.

object
type
required

MUST be “DefiniteRange”

string
default: DefiniteRange
min
required

The minimum value; inclusive

number
max
required

The maximum value; inclusive

number
end
required
One of:

A bounded, inclusive range of numbers.

object
type
required

MUST be “DefiniteRange”

string
default: DefiniteRange
min
required

The minimum value; inclusive

number
max
required

The maximum value; inclusive

number
state
required
object
type
required

MUST be “LiteralSequenceExpression”

string
default: LiteralSequenceExpression
sequence
required

The literal Sequence expressed

string
resultsCount
required

Number of results in this Resultset.

integer
resultsHandovers

Set of handovers to be added in one section the response.

Array<object>

A handover is a typed link for attaching actionable links to results, non purely informational, requests. The goal of the handovers is to list the different actions available, e.g.:

  • a link to a request access page * linking to a file for download, e.g. a VCF file Another common scenario is to provide a fast summary response (e.g. BeconCountResponse) and to provide access to different endpoints for the entities matched by the query using temporary access tokens in the handover URLs.
object
handoverType
required

In our context, only htsget or download urls should be returned

object
id
string
Allowed values: CUSTOM
label
string
Allowed values: HTSGET DOWNLOAD
note

An optional text including considerations on the handover link provided.

string
This handover link provides access to a summarized VCF.
url
required

URL endpoint to where the handover process could progress, in RFC3986 format

string format: uri 
https://api.mygenomeservice.org/Handover/9dcc48d7-fc88-11e8-9110-b0c592dbf8c0/
setType
required

Entry type of resultSet. It SHOULD MATCH an entry type declared as collection in the Beacon configuration.

string
default: dataset
key
additional properties
any
key
additional properties
any
responseSummary
required

Beacon results summary section.

object
exists
required

Indicator of whether any record was observed in any of the collections queried. This should be non-null.

boolean
numTotalResults

Total number of results. NOT the number of results returned in this batch (after pagination) but the total obtained by the query.

string

404

Not Found