Skip to content
GitHub
Twitter

Beacon DEPRECATED Profile

Version: 0.2-DRAFT-2018_04_23 (23 April 2018)

A convention for beacon to self-describe.


If you spot any errors or omissions with this type, please file an issue in our GitHub.


Key to specification table

CD = Cardinality

Property Expected Type Description CD Controlled Vocabulary Example
Marginality: Minimum.
@context URL Used to provide the context (namespaces) for the JSON-LD file.
Not needed in other serialisations.
ONE
@type Text Schema.org/Bioschemas class for the resource declared using JSON-LD syntax. For other serialisations please use the appropriate mechanism.
While it is permissible to provide multiple types, it is preferred to use a single type.
MANY Schema.org, Bioschemas
@id IRI Used to distinguish the resource being described in JSON-LD. For other serialisations use the appropriate approach. ONE
dct:conformsTo IRI Used to state the Bioschemas profile that the markup relates to. The versioned URL of the profile must be used.
Note that we use a CURIE in the table here but the full URL for Dublin Core terms must be used in the markup (http://purl.org/dc/terms/conformsTo), see example.
ONE Bioschemas profile versioned URL
dataset DataCatalog
Schema:

A dataset contained in this catalog. inverse property: includedInDataCatalog.


Bioschemas:

Datasets served by this Beacon.

MANY
name Text
Schema:

The name of the item.


Bioschemas:

Name of this Beacon.

ONE
potentialAction Action
Schema:

Indicates a potential Action, which describes an idealized action in which this thing would play an ‘object’ role.


Bioschemas:

List of Actions that can be performed on this Beacon.

MANY
provider Organization
Person
Schema:

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier.


Bioschemas:

Contact information for this Beacon.

MANY
rdf:type URL
Bioschemas:

This is used by validation tools to indentify the profile used. You must use the value specified in the Controlled Vocabulary column.

ONE
supportedRefs Text
Bioschemas:

Supported Genome ID references.

MANY
url URL
Schema:

URL of the item.


Bioschemas:

Welcome Page of this Beacon.

ONE
Marginality: Recommended.
aggregator Boolean
Bioschemas:

True if Beacon is an agregator of other Beacon Datasets.

ONE
description Text
Schema:

A description of the item.


Bioschemas:

Description of this Beacon.

ONE
identifier PropertyValue
Text
URL
Schema:

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.


Bioschemas:

Unique identifier of the Beacon.

ONE
version Number
Text
Schema:

The version of the CreativeWork embodied by a specified resource.


Bioschemas:

Beacon API version number.

ONE
Marginality: Optional.
sameAs URL
Schema:

URL of a reference Web page that unambiguously indicates the item’s identity. E.g. the URL of the item’s Wikipedia page, Wikidata entry, or official website.


Bioschemas:

Alternative URL for this Beacon.

MANY