sb-beacon-api beaconResultsetsResponse [ ↗ ]

{S}[B] Status [i]
proposed
Provenance
Used by
Contributors
Source (2.0.0)

Attributes

Type: object
Description: Beacon response that includes record level details, grouped in Resultsets.

Properties

PropertyType
beaconHandovershttps://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/beaconCommonComponents.json#/definitions/ListOfHandovers [LINK]
infohttps://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/beaconCommonComponents.json#/definitions/Info [LINK]
metahttps://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/sections/beaconResponseMeta.json [LINK]
responsehttps://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/sections/beaconResultsets.json [LINK]
responseSummaryhttps://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/sections/beaconSummaryResponseSection.json [LINK]

beaconHandovers

List of handovers that apply to the whole response, not to any resultset or result in particular.

info

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

meta

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

response

Response for queries that recovers any result.

responseSummary

Response summary, including Boolean and optionally results count.