sb-beacon-api entryTypeDefinition [ ↗ ]

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

Attributes

Type: object
Description: Definition of an element or entry type including the Beacon v2 required and suggested attributes. This schema purpose is to describe each type of entities included in a Beacon, hence Beacon clients could have some metadata about such entities.

The id attribute is the key that should be used in other parts of the Beacon Model to allow Beacon clients to identify the different parts (e.g. endpoints, filteringTerms, request parameters, etc.) that fully describe an entry type.

Properties

PropertyType
$schema../common/beaconCommonComponents.json#/definitions/$schema
aCollectionOf
additionallySupportedSchemasarray of "../common/referenceToAnSchema.json"
defaultSchema../common/referenceToAnSchema.json
descriptionstring
filteringTermsstring
idstring
namestring
nonFilteredQueriesAllowed../common/beaconCommonComponents.json#/definitions/NonFilteredQueriesAllowed
ontologyTermForThisType../common/ontologyTerm.json
partOfSpecificationstring

$schema

aCollectionOf

If the entry type is a collection of other entry types, (e.g. a Dataset is a collection of Records), then this attribute must list the entry types that could be included. One collection type could be defined as included more than one entry type (e.g. a Dataset could include Individuals or Genomic Variants), in such cases the entries are alternative, meaning that a given instance of this entry type could be of only one of the types (e.g. a given Dataset contains Individuals, while another Dataset could contain Genomic Variants, but not both at once).

additionallySupportedSchemas

List of additional schemas that could be used for this concept in this instance of Beacon.

defaultSchema

Description of the default schema used for this concept.

description

A textual description for the element.

filteringTerms

Reference to the file with the list of filtering terms that could be used to filter this concept in this instance of Beacon. The referenced file could be used to populate the filteringTermsendpoint. Having it independently should allow for updating the list of accepted filtering terms when it is necessary.

id

A (unique) identifier of the element.

name

A distinctive name for the element.

nonFilteredQueriesAllowed

ontologyTermForThisType

partOfSpecification

This is label to group together entry types that are part of the same specification.

partOfSpecification Value Example
"Beacon v2.0"