Discord

CompleteDataFeed Type

A [[CompleteDataFeed]] is a [[DataFeed]] whose standard representation includes content for every item currently in the feed.

This is the equivalent of Atom's element as defined in Feed Paging and Archiving RFC 5005, For example (and as defined for Atom), when using data from a feed that represents a collection of items that varies over time (e.g. "Top Twenty Records") there is no need to have newer entries mixed in alongside older, obsolete entries. By marking this feed as a CompleteDataFeed, old entries can be safely discarded when the feed is refreshed, since we can assume the feed has provided descriptions for all current items.

Inherited Properties
Properties inherited from @schema/Data­FeedExpected TypeDescription
@schema/data­Feed­Element or 

An item within in a data feed. Data feeds may have many elements.

Properties inherited from @schema/DatasetExpected TypeDescription
@schema/catalog

A data catalog which contains this dataset.

@schema/dataset­Time­Interval

The range of temporal applicability of a dataset, e.g. for a 2011 census dataset, the year 2011 (in ISO 8601 time interval format).

@schema/distribution

A downloadable form of this dataset, at a specific location, in a specific format.

@schema/included­Data­Catalog

A data catalog which contains this dataset (this property was previously 'catalog', preferred name is now 'includedInDataCatalog').

@schema/included­In­Data­Catalog

A data catalog which contains this dataset.

@schema/issn

The International Standard Serial Number (ISSN) that identifies this serial publication. You can repeat this property to identify different formats of, or the linking ISSN (ISSN-L) for, this serial publication.

@schema/measurement­Technique or 

A technique or technology used in a [[Dataset]] (or [[DataDownload]], [[DataCatalog]]), corresponding to the method used for measuring the corresponding variable(s) (described using [[variableMeasured]]). This is oriented towards scientific and scholarly dataset publication but may have broader applicability; it is not intended as a full representation of measurement, but rather as a high level summary for dataset discovery.

For example, if [[variableMeasured]] is: molecule concentration, [[measurementTechnique]] could be: "mass spectrometry" or "nmr spectroscopy" or "colorimetry" or "immunofluorescence".

If the [[variableMeasured]] is "depression rating", the [[measurementTechnique]] could be "Zung Scale" or "HAM-D" or "Beck Depression Inventory".

If there are several [[variableMeasured]] properties recorded for some given data object, use a [[PropertyValue]] for each [[variableMeasured]] and attach the corresponding [[measurementTechnique]].

@schema/variable­Measured or 

The variableMeasured property can indicate (repeated as necessary) the variables that are measured in some dataset, either described as text or as pairs of identifier and description using PropertyValue.

Properties inherited from @schema/Creative­WorkExpected TypeDescription
@schema/about

The subject matter of the content.

@schema/abstract

An abstract is a short description that summarizes a [[CreativeWork]].

@schema/access­Mode

The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual.

@schema/access­Mode­Sufficient

A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual.

@schema/accessibility­API

Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values).

@schema/accessibility­Control

Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values).

@schema/accessibility­Feature

Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values).

@schema/accessibility­Hazard

A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values).

@schema/accessibility­Summary

A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."

@schema/accountable­Person

Specifies the Person that is legally accountable for the CreativeWork.

@schema/acquire­License­Page or 

Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.

@schema/aggregate­Rating

The overall rating, based on a collection of reviews or ratings, of the item.

@schema/alternative­Headline

A secondary title of the CreativeWork.

@schema/assesses or 

The item being described is intended to assess the competency or learning outcome defined by the referenced term.

@schema/associated­Media

A media object that encodes this CreativeWork. This property is a synonym for encoding.

@schema/audience

An intended audience, i.e. a group for whom something was created.

@schema/audio or 

An embedded audio object.

@schema/author or 

The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.

@schema/award

An award won by or for this item.

@schema/awards

Awards won by or for this item.

@schema/character

Fictional person connected with a creative work.

@schema/citation or 

A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.

@schema/comment

Comments, typically from users.

@schema/comment­Count

The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.

@schema/conditions­Of­Access

Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".

@schema/content­Location

The location depicted or described in the content. For example, the location in a photograph or painting.

@schema/content­Rating or 

Official rating of a piece of content—for example,'MPAA PG-13'.

@schema/content­Reference­Time

The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.

@schema/contributor or 

A secondary contributor to the CreativeWork or Event.

@schema/copyright­Holder or 

The party holding the legal copyright to the CreativeWork.

@schema/copyright­Notice

Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.

@schema/copyright­Year

The year during which the claimed copyright for the CreativeWork was first asserted.

@schema/correction or 

Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.

@schema/creative­Work­Status or 

The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.

@schema/creator or 

The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.

@schema/credit­Text

Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.

@schema/date­Created or 

The date on which the CreativeWork was created or the item was added to a DataFeed.

@schema/date­Modified or 

The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.

@schema/date­Published or 

Date of first broadcast/publication.

@schema/discussion­Url

A link to the page containing the comments of the CreativeWork.

@schema/edit­EIDR or 

An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.

For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".

Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.

@schema/editor

Specifies the Person who edited the CreativeWork.

@schema/educational­Alignment

An alignment to an established educational framework.

This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.

@schema/educational­Level or 

The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.

@schema/educational­Use or 

The purpose of a work in the context of education; for example, 'assignment', 'group work'.

@schema/encoding

A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.

@schema/encoding­Format or 

Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.).

In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.

Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.

@schema/encodings

A media object that encodes this CreativeWork.

@schema/example­Of­Work

A creative work that this work is an example/instance/realization/derivation of.

@schema/expires

Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.

@schema/file­Format or 

Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.

@schema/funder or 

A person or organization that supports (sponsors) something through some kind of financial contribution.

@schema/genre or 

Genre of the creative work, broadcast channel or group.

@schema/has­Part

Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).

@schema/headline

Headline of the article.

@schema/in­Language or 

The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]].

@schema/interaction­Statistic

The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.

@schema/interactivity­Type

The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.

@schema/is­Accessible­For­Free

A flag to signal that the item, event, or place is accessible for free.

@schema/is­Based­On or 

A resource from which this work is derived or from which it is a modification or adaption.

@schema/is­Based­On­Url or 

A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.

@schema/is­Family­Friendly

Indicates whether this content is family friendly.

@schema/is­Part­Of or 

Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.

@schema/keywords or 

Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.

@schema/learning­Resource­Type or 

The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.

@schema/license or 

A license document that applies to this content, typically indicated by URL.

@schema/location­Created

The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.

@schema/main­Entity

Indicates the primary entity described in some page or other CreativeWork.

@schema/maintainer or 

A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.

@schema/material or 

A material that something is made from, e.g. leather, wool, cotton, paper.

@schema/material­Extent or 

The quantity of the materials being described or an expression of the physical space they occupy.

@schema/mentions

Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.

@schema/offers or 

An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.

@schema/pattern or 

A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.

@schema/position or 

The position of an item in a series or sequence of items.

@schema/producer or 

The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.).

@schema/provider or 

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.

@schema/publication

A publication event associated with the item.

@schema/publisher or 

The publisher of the creative work.

@schema/publisher­Imprint

The publishing division which published the comic.

@schema/publishing­Principles or 

The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].

While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.

@schema/recorded­At

The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.

@schema/released­Event

The place and time the release was issued, expressed as a PublicationEvent.

@schema/review

A review of the item.

@schema/reviews

Review of the item.

@schema/schema­Version or 

Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. 10.0 as a simple string, or more explicitly via URL, http://schema.org/docs/releases.html#v10.0. There may be situations in which other schemas might usefully be referenced this way, e.g. http://dublincore.org/specifications/dublin-core/dces/1999-07-02/ but this has not been carefully explored in the community.

@schema/sd­Date­Published

Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]

@schema/sd­License or 

A license document that applies to this structured data, typically indicated by URL.

@schema/sd­Publisher or 

Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit.

@schema/size or 

A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.

@schema/source­Organization

The Organization on whose behalf the creator was working.

@schema/spatial

The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.

@schema/spatial­Coverage

The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.

@schema/sponsor or 

A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event.

@schema/teaches or 

The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.

@schema/temporal or 

The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.

@schema/temporal­Coverage or 

The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".

Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.

@schema/text

The textual content of this CreativeWork.

@schema/thumbnail­Url

A thumbnail image relevant to the Thing.

@schema/time­Required

Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.

@schema/translation­Of­Work

The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species”

@schema/translator or 

Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.

@schema/typical­Age­Range

The typical expected age range, e.g. '7-9', '11-'.

@schema/usage­Info or 

The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.

This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.

@schema/version or 

The version of the CreativeWork embodied by a specified resource.

@schema/video or 

An embedded video object.

@schema/work­Example

Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook.

@schema/work­Translation

A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo.

Properties inherited from @schema/ThingExpected TypeDescription
@schema/additional­Type

An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

@schema/alternate­Name

An alias for the item.

@schema/description

A description of the item.

@schema/disambiguating­Description

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

@schema/identifier or 

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.

@schema/image or 

An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

@schema/main­Entity­Of­Page or 

Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

@schema/name

The name of the item.

@schema/potential­Action

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

@schema/same­As

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.

@schema/subject­Of or 

A CreativeWork or Event about this Thing.

@schema/url

URL of the item.