Response Class (Status 200)
OK
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
AnnotationMetadata {[
{
"cacheVersion": "string",
"defaultVersion": true,
"vepVersion": "string"
}
]
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
Get information about the beacon
successful operation
There are no other use restrictions/limitations in force which are not herein specified. No special evaluation required for access requests involving sensitive/restricted populations. Identical consent permissions have been provided by all subjects.
BeaconDataset {
KeyValuePair {
BeaconOrganization {
BeaconAlleleRequest {
,string Enum: "ALL", "HIT", "MISS", "NONE"
,string Enum: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "X", "Y", "MT"
DataUseConditions {
AdamDataUse {
ConsentCodeDataUse {
Header {
,string Enum: "UNKNOWN", "DATABASE", "METADATA", "SUMMARISED", "DATASET", "RECORDSET", "RECORD", "RECORDFIELD"
MetaConditions {
,string Enum: "MEET_ALL_OBLIGATIONS", "MEET_AT_LEAST_ONE_OBLIGATION"
,string Enum: "UNKNOWN", "DISCOVERY", "ACCESS", "DISCOVERY_AND_ACCESS"
Profile {
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
,string Enum: "UNRESTRICTED", "LIMITED"
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
,string Enum: "UNRESTRICTED", "LIMITED"
,string Enum: "UNRESTRICTED", "LIMITED"
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN" string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN"
Terms {
ConsentCodeDataUseCondition {
ProfileUpdates {
Contact {
ProfileDescription {
ClinicalDescription {
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN" string Enum: "OTHER", "DECISION_SUPPORT", "DISEASE"
ResearchDescription {
,string Enum: "UNRESTRICTED", "LIMITED", "UNRESTRICTED_OBLIGATORY", "LIMITED_OBLIGATORY", "FORBIDDEN" string Enum: "OTHER", "METHODS", "CONTROL", "POPULATION", "ANCESTRY", "BIOMEDICAL", "FUNDAMENTAL", "GENETIC", "DRUG", "DISEASE", "GENDER", "AGE" {
"alternativeUrl": "string",
"apiVersion": "string",
"createDateTime": "string",
"datasets": [
{
"assemblyId": "string",
"callCount": 0,
"createDateTime": "string",
"dataUseConditions": {
"adamDataUse": {
"header": {
"matrixName": "string",
"matrixProfileCreateDate": "string",
"matrixProfileUpdates": [
{
"date": "string",
"description": "string"
}
],
"matrixReferences": [
"string"
],
"matrixVersion": "string",
"resourceContactNames": [
{
"email": "string",
"name": "string"
}
],
"resourceContactOrganisations": [
"string"
],
"resourceDataLevel": "UNKNOWN",
"resourceDescription": "string",
"resourceName": "string",
"resourceReferences": [
"string"
]
},
"metaConditions": {
"multipleObligationsRule": "MEET_ALL_OBLIGATIONS",
"noOtherConditions": false,
"sensitivePopulations": false,
"sharingMode": "UNKNOWN",
"uniformConsent": false,
"whichOtherConditions": [
"string"
]
},
"profile": {
"academicProfessional": "UNRESTRICTED",
"allowedAcademicProfessionals": [
{
"description": "string",
"obligatory": false
}
],
"allowedClinicalProfessionals": [
{
"description": "string",
"obligatory": false
}
],
"allowedClinicalProfiles": [
{
"description": "string",
"restriction": "UNRESTRICTED",
"type": "OTHER"
}
],
"allowedClinicalPurpose": [
{
"description": "string",
"obligatory": false
}
],
"allowedCountries": [
{
"description": "string",
"obligatory": false
}
],
"allowedNonProfessionals": [
{
"description": "string",
"obligatory": false
}
],
"allowedNonProfitOrganisations": [
{
"description": "string",
"obligatory": false
}
],
"allowedNonProfitPurposes": [
{
"description": "string",
"obligatory": false
}
],
"allowedOrganisations": [
{
"description": "string",
"obligatory": false
}
],
"allowedPersons": [
{
"description": "string",
"obligatory": false
}
],
"allowedProfitOrganisations": [
{
"description": "string",
"obligatory": false
}
],
"allowedProfitProfessionals": [
{
"description": "string",
"obligatory": false
}
],
"allowedProfitPurposes": [
{
"description": "string",
"obligatory": false
}
],
"allowedResearchProfiles": [
{
"description": "string",
"restriction": "UNRESTRICTED",
"type": "OTHER"
}
],
"allowedResearchPurposes": [
{
"description": "string",
"obligatory": false
}
],
"clinicalProfessional": "UNRESTRICTED",
"clinicalPurpose": "UNRESTRICTED",
"country": "UNRESTRICTED",
"nonProfessional": "UNRESTRICTED",
"nonProfitOrganisation": "UNRESTRICTED",
"nonProfitPurpose": "UNRESTRICTED",
"organisation": "UNRESTRICTED",
"person": "UNRESTRICTED",
"profitOrganisation": "UNRESTRICTED",
"profitProfessional": "UNRESTRICTED",
"profitPurpose": "UNRESTRICTED",
"researchPurpose": "UNRESTRICTED"
},
"terms": {
"allowedRecontactTerms": [
"string"
],
"compulsoryRecontactTerms": [
"string"
],
"noAuthorizationTerms": false,
"noCollaborationTerms": false,
"noExpungingTerms": false,
"noIPClaimTerms": false,
"noLinkingTerms": false,
"noPaymentTerms": false,
"noPublicationTerms": false,
"noRecontactTerms": false,
"noReportingTerms": false,
"noSecurityTerms": false,
"noTimelineTerms": false,
"whichAuthorizationTerms": [
"string"
],
"whichCollaborationTerms": [
"string"
],
"whichExpungingTerms": [
"string"
],
"whichIPClaimTerms": [
"string"
],
"whichLinkingTerms": [
"string"
],
"whichPaymentTerms": [
"string"
],
"whichPublicationTerms": [
"string"
],
"whichReportingTerms": [
"string"
],
"whichSecurityTerms": [
"string"
],
"whichTimelineTerms": [
"string"
]
}
},
"consentCodeDataUse": {
"primaryCategory": {
"code": "string",
"description": "string"
},
"requirements": [
{
"code": "string",
"description": "string"
}
],
"secondaryCategories": [
{
"code": "string",
"description": "string"
}
],
"version": "string"
}
},
"description": "string",
"externalUrl": "string",
"id": "string",
"info": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"sampleCount": 0,
"updateDateTime": "string",
"variantCount": 0,
"version": "string"
}
],
"description": "string",
"id": "string",
"info": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"organization": {
"address": "string",
"contactUrl": "string",
"description": "string",
"id": "string",
"info": [
{
"key": "string",
"value": "string"
}
],
"logoUrl": "string",
"name": "string",
"welcomeUrl": "string"
},
"sampleAlleleRequests": [
{
"alternateBases": "string",
"assemblyId": "string",
"datasetIds": [
"string"
],
"end": 0,
"endMax": 0,
"endMin": 0,
"includeDatasetResponses": "ALL",
"referenceBases": "string",
"referenceName": "1",
"start": 0,
"startMax": 0,
"startMin": 0,
"variantType": "string"
}
],
"updateDateTime": "string",
"version": "string",
"welcomeUrl": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
GAVariantSet {
GAVariantSetMetadata {{
"nextPageToken": "string",
"variantSets": [
{
"datasetId": "string",
"id": "string",
"metadata": [
{
"description": "string",
"id": "string",
"info": {},
"key": "string",
"number": "string",
"type": "string",
"value": "string"
}
]
}
]
}
OK
GAVariantSet {
GAVariantSetMetadata {{
"nextPageToken": "string",
"variantSets": [
{
"datasetId": "string",
"id": "string",
"metadata": [
{
"description": "string",
"id": "string",
"info": {},
"key": "string",
"number": "string",
"type": "string",
"value": "string"
}
]
}
]
}
OK
{
"allele": "string",
"chromosome": "string",
"datasetIds": "string",
"errorMessage": "string",
"exists": true,
"start": 0
}
OK
GACallSet {{
"callSets": [
{
"created": 0,
"id": "string",
"info": {},
"name": "string",
"sampleId": "string",
"updated": 0,
"variantSetIds": [
"string"
]
}
],
"nextPageToken": "string"
}
OK
GACallSet {{
"callSets": [
{
"created": 0,
"id": "string",
"info": {},
"name": "string",
"sampleId": "string",
"updated": 0,
"variantSetIds": [
"string"
]
}
],
"nextPageToken": "string"
}
OK
GAVariant {
GACall {
GAKeyValue {{
"nextPageToken": "string",
"variants": [
{
"alternateBases": [
"string"
],
"calls": [
{
"callSetId": "string",
"callSetName": "string",
"genotype": [
0
],
"genotypeLikelihood": [
0
],
"info": [
{
"key": "string",
"value": "string"
}
],
"phaseset": "string"
}
],
"created": 0,
"end": 0,
"id": "string",
"info": {},
"names": [
"string"
],
"referenceBases": "string",
"referenceName": "string",
"start": 0,
"updated": 0,
"variantSetId": "string"
}
]
}
OK
GAVariant {
GACall {
GAKeyValue {{
"nextPageToken": "string",
"variants": [
{
"alternateBases": [
"string"
],
"calls": [
{
"callSetId": "string",
"callSetName": "string",
"genotype": [
0
],
"genotypeLikelihood": [
0
],
"info": [
{
"key": "string",
"value": "string"
}
],
"phaseset": "string"
}
],
"created": 0,
"end": 0,
"id": "string",
"info": {},
"names": [
"string"
],
"referenceBases": "string",
"referenceName": "string",
"start": 0,
"updated": 0,
"variantSetId": "string"
}
]
}
OK
GAVariantSet {
GAVariantSetMetadata {{
"nextPageToken": "string",
"variantSets": [
{
"datasetId": "string",
"id": "string",
"metadata": [
{
"description": "string",
"id": "string",
"info": {},
"key": "string",
"number": "string",
"type": "string",
"value": "string"
}
]
}
]
}
OK
GAVariantSet {
GAVariantSetMetadata {{
"nextPageToken": "string",
"variantSets": [
{
"datasetId": "string",
"id": "string",
"metadata": [
{
"description": "string",
"id": "string",
"info": {},
"key": "string",
"number": "string",
"type": "string",
"value": "string"
}
]
}
]
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
{
"body": {},
"status": {}
}
OK
{
"body": {},
"status": {}
}
Get response to a beacon query for allele information.
successful operation
Indicator of whether the given allele was observed in any of the datasets queried. This should be non-null, unless there was an error, in which case Indicator of whether the given allele was observed in the dataset. This should be non-null, unless there was an error, in which case
BeaconAlleleResponse {error
has to be non-null.
BeaconAlleleRequest {
,string Enum: "ALL", "HIT", "MISS", "NONE"
,string Enum: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "X", "Y", "MT"
BeaconDatasetAlleleResponse {error
has to be non-null.
BeaconError {
KeyValuePair {[
{
"alleleRequest": {
"alternateBases": "string",
"assemblyId": "string",
"datasetIds": [
"string"
],
"end": 0,
"endMax": 0,
"endMin": 0,
"includeDatasetResponses": "ALL",
"referenceBases": "string",
"referenceName": "1",
"start": 0,
"startMax": 0,
"startMin": 0,
"variantType": "string"
},
"apiVersion": "string",
"beaconId": "string",
"datasetAlleleResponses": [
{
"callCount": 0,
"datasetId": "string",
"error": {
"errorCode": 0,
"errorMessage": "string"
},
"exists": false,
"externalUrl": "string",
"frequency": 0,
"info": [
{
"key": "string",
"value": "string"
}
],
"note": "string",
"sampleCount": 0,
"variantCount": 0
}
],
"error": {
"errorCode": 0,
"errorMessage": "string"
},
"exists": false
}
]
Gets response to a beacon query for allele information.
successful operation
Indicator of whether the given allele was observed in any of the datasets queried. This should be non-null, unless there was an error, in which case Indicator of whether the given allele was observed in the dataset. This should be non-null, unless there was an error, in which case
BeaconAlleleResponse {error
has to be non-null.
BeaconAlleleRequest {
,string Enum: "ALL", "HIT", "MISS", "NONE"
,string Enum: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "X", "Y", "MT"
BeaconDatasetAlleleResponse {error
has to be non-null.
BeaconError {
KeyValuePair {[
{
"alleleRequest": {
"alternateBases": "string",
"assemblyId": "string",
"datasetIds": [
"string"
],
"end": 0,
"endMax": 0,
"endMin": 0,
"includeDatasetResponses": "ALL",
"referenceBases": "string",
"referenceName": "1",
"start": 0,
"startMax": 0,
"startMin": 0,
"variantType": "string"
},
"apiVersion": "string",
"beaconId": "string",
"datasetAlleleResponses": [
{
"callCount": 0,
"datasetId": "string",
"error": {
"errorCode": 0,
"errorMessage": "string"
},
"exists": false,
"externalUrl": "string",
"frequency": 0,
"info": [
{
"key": "string",
"value": "string"
}
],
"note": "string",
"sampleCount": 0,
"variantCount": 0
}
],
"error": {
"errorCode": 0,
"errorMessage": "string"
},
"exists": false
}
]
OK
{
"body": {},
"status": {}
}
OK
GACallSet {{
"callSets": [
{
"created": 0,
"id": "string",
"info": {},
"name": "string",
"sampleId": "string",
"updated": 0,
"variantSetIds": [
"string"
]
}
],
"nextPageToken": "string"
}
OK
GACallSet {{
"callSets": [
{
"created": 0,
"id": "string",
"info": {},
"name": "string",
"sampleId": "string",
"updated": 0,
"variantSetIds": [
"string"
]
}
],
"nextPageToken": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
{
"body": {},
"status": {}
}
OK
GAVariant {
GACall {
GAKeyValue {{
"nextPageToken": "string",
"variants": [
{
"alternateBases": [
"string"
],
"calls": [
{
"callSetId": "string",
"callSetName": "string",
"genotype": [
0
],
"genotypeLikelihood": [
0
],
"info": [
{
"key": "string",
"value": "string"
}
],
"phaseset": "string"
}
],
"created": 0,
"end": 0,
"id": "string",
"info": {},
"names": [
"string"
],
"referenceBases": "string",
"referenceName": "string",
"start": 0,
"updated": 0,
"variantSetId": "string"
}
]
}
OK
GAVariant {
GACall {
GAKeyValue {{
"nextPageToken": "string",
"variants": [
{
"alternateBases": [
"string"
],
"calls": [
{
"callSetId": "string",
"callSetName": "string",
"genotype": [
0
],
"genotypeLikelihood": [
0
],
"info": [
{
"key": "string",
"value": "string"
}
],
"phaseset": "string"
}
],
"created": 0,
"end": 0,
"id": "string",
"info": {},
"names": [
"string"
],
"referenceBases": "string",
"referenceName": "string",
"start": 0,
"updated": 0,
"variantSetId": "string"
}
]
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
Inline Model 1 {}
{
"apiVersion": "string",
"error": "string",
"queryOptions": {},
"response": [
{}
],
"time": 0,
"warning": "string"
}
OK
{
"body": {},
"status": {}
}
OK
{
"body": {},
"status": {}
}
OK
{
"body": {},
"status": {}
}