Reference
Properties
A property is a field of a record: a plain value or a link to another record. The ontology's SHACL shapes set how
many values a property takes: one means at most one value
(sh:maxCount 1), many means a list, and
required means a record of that class must have it
(sh:minCount 1).
On Base
On Action
| Property | Expected type | Description |
|---|---|---|
| agent one | Agent | Who performed the action. |
| endTime one | DateTime | When the action ended. |
| instrument many | Entity | The tool, device, application, or model used to perform an action. |
| location one | Location or Place | Where the action happened, or where the entity or event is. |
| object one | Entity | The entity an action was carried out on, such as the article read, the photo shared, or the place visited. |
| result one | Entity | What the action produced, such as a work or a session. |
| startTime one | DateTime | When the action started. |
| target one | Entity | What an action is directed toward, as distinct from the object it is carried out on. |
| timestamp one | DateTime | When the action occurred. |
On Entity
| Property | Expected type | Description |
|---|---|---|
| about many | Entity | What the entity is about, such as a topic or a tag. |
| alternateName many | Text | Another name the entity was shown with, such as the display name a message gave its sender or a recipient. |
| body one | Text | The text content of an entity, such as a shell command or a message. |
| category many | Text |
A text label that classifies the entity, such as breakfast for a Meal or car for a PhysicalObject.
|
| contains many | MediaObject | A media file that is part of the entity, such as an attachment to a Message, the photo in a Post, or the images and videos in a carousel. |
| description one | Text | Text that describes an entity, such as a task's notes or a project's summary. |
| emblem one | ImageObject | The image an entity presents itself by, such as an avatar, a poster, a cover, a logo, or a favicon. |
| handle one | Text | An identifier for an entity within a namespace, such as a username, a channel slug, or a tag label. |
| inAccount many | Agent or FinancialAccount | The account that holds the entity. |
| inRealm one | Realm | The realm the entity is in, such as the computer system that holds a conversation or a file. |
| isPartOf many | Entity | A whole that the entity is part of, such as a task's project, the page an excerpt comes from, or the transaction a posting belongs to. |
| location one | Location or Place | Where the action happened, or where the entity or event is. |
| name one | Text | The name or title of an entity, such as a person's display name, a document's title, or a place's name. |
| references many | Entity | An entity this one refers to, such as one it @mentions, a page it links to, or a work it cites. |
| sameAs many | Entity or Text |
Another reference to the same entity, either an entity or a text reference such as @me.
|
| tags many | Text | A text label for the entity. |
| url one | URL | A URL at which the entity can be found, such as a web page's address or a link to the record in its source. |
On Location
On MonetaryAmount
On Agent
On CreativeWork
| Property | Expected type | Description |
|---|---|---|
| author many | Agent | An agent who wrote the work, such as a person or a software assistant. |
| creator many | Agent | An agent who brought the work into being, such as by writing, producing, or releasing it. |
| dateCovered one | DateRange | A period the work is about, such as the day a journal entry describes, the month a recap covers, or the years a novel is set in. |
| datePublished one | DateTime | When the work was published or released. |
| genre many | Text | A genre of the work. |
| isBasedOn many | CreativeWork | A work this one was derived from, such as the earlier version a revision follows or the repository a fork was copied from. |
| publisher many | Organization | The organization that published the work. |
| references many | Entity | An entity this one refers to, such as one it @mentions, a page it links to, or a work it cites. |
| rendition many | MediaObject | A file that holds the work, such as a picture's image file, a video's video file, or an episode's audio file. |
| series many | CreativeWork | The series that this work is one of, such as the podcast an episode belongs to or the series a book was published in. |
| sourceFormat one | Text | The platform's own format for the work, among works of the same type. |
| visibility one | Text | How widely the work is shared. |
| webFeed many | URL | The URL of an RSS or Atom feed that publishes the work's items, such as a podcast's episodes or a blog's posts. |
On Event
On PhysicalObject
On Session
| Property | Expected type | Description |
|---|---|---|
| isStageOf one | Session | The session that this session is a stage of, such as the night that a stretch of deep sleep is a stage of. |
| references many | Entity | An entity this one refers to, such as one it @mentions, a page it links to, or a work it cites. |
| subject many | Entity | The resource the session was spent on, such as the document, page, or media in focus. |
| workingDirectory one | Directory | The directory a session took place in, such as a terminal's working directory or a folder open in a file manager. |
On Tag
On Organization
On Person
| Property | Expected type | Description |
|---|---|---|
| activeEnergyBurned one | Number | The energy burned by moving, beyond what the body burns at rest, in kilocalories. |
| diastolicBloodPressure one | Number | The blood pressure between heartbeats, in millimeters of mercury. |
| heartRate one | Number | The heart rate, in beats per minute. |
| heartRateRecovery one | Number | How far the heart rate fell in the minute after exercise, in beats per minute. |
| heartRateVariabilitySdnn one | Number | The variation in time between heartbeats as SDNN: the standard deviation of the intervals between beats over the measurement's period, in milliseconds. |
| heartRhythm one | Text |
The rhythm of the heart, as an electrocardiogram classifies it, such as sinus rhythm or atrial fibrillation.
|
| oxygenSaturation one | Number |
The fraction of hemoglobin in the blood that carries oxygen, from 0 to 1, such as 0.97.
|
| respiratoryRate one | Number | The breathing rate, in breaths per minute. |
| restingHeartRate one | Number | The heart rate at rest, in beats per minute. |
| sleepingWristTemperature one | Number | The skin temperature at the wrist during sleep, in degrees Celsius. |
| stepCount one | Number | The number of steps taken. |
| systolicBloodPressure one | Number | The blood pressure while the heart beats, in millimeters of mercury. |
| walkingHeartRate one | Number | The average heart rate while walking, in beats per minute. |
| weight one | Number | The person's body weight, as a mass in kilograms. |
On Book
On Channel
On MediaObject
| Property | Expected type | Description |
|---|---|---|
| contentPath one | Text | The absolute filesystem path of the local file that holds the media. |
| contentSize one | Number | The size of the file, in bytes. |
| mimeType one | Text |
The MIME type of the media, such as image/jpeg, audio/mp4, or application/pdf.
|
| snapshotOf many | Entity | The resource this media captured at a moment, such as the web page in a screenshot or an archive. |
On Message
| Property | Expected type | Description |
|---|---|---|
| author many | Agent | An agent who wrote the work, such as a person or a software assistant. |
| inReplyTo many | Message | The message this message replies to. |
| recipient many | Agent | An agent the message, call, or transaction was directed to, such as each other participant in a group conversation or the merchant that was paid. |
On MovingImage
On MusicAlbum
| Property | Expected type | Description |
|---|---|---|
| artist many | MusicGroup | The musical act that created or performed the recording or album. |
On MusicRecording
| Property | Expected type | Description |
|---|---|---|
| artist many | MusicGroup | The musical act that created or performed the recording or album. |
| duration one | Text | How long the recording or media lasts. |
| inAlbum one | MusicAlbum | The album the recording appears on. |
On PodcastEpisode
| Property | Expected type | Description |
|---|---|---|
| duration one | Text | How long the recording or media lasts. |
| transcript one | Text | The words spoken in a recording or an episode, written out, such as a voice memo's transcript, a podcast episode's transcript, or a video's captions. |
On Quotation
| Property | Expected type | Description |
|---|---|---|
| annotationStyle one | Text |
The kind of visual annotation, such as highlight, underline, strikethrough, squiggly, box, or margin.
|
| color one | Text |
A color associated with the entity, as a hex code or a name, such as #ffcc00 or yellow.
|
| selector many | Selector | A position of the quotation in its work. |
On StillImage
On FinancialAccount
| Property | Expected type | Description |
|---|---|---|
| financialAccountType one | Text |
The kind of FinancialAccount, one of asset, liability, equity, income, or expense.
|
On FinancialPosting
| Property | Expected type | Description |
|---|---|---|
| amount one | MonetaryAmount | How much money moved. |
On FinancialTransaction
| Property | Expected type | Description |
|---|---|---|
| amount one | MonetaryAmount | How much money moved. |
| recipient many | Agent | An agent the message, call, or transaction was directed to, such as each other participant in a group conversation or the merchant that was paid. |
On Selector
| Property | Expected type | Description |
|---|---|---|
| selectorLabel one | Text |
The position as people read it, such as pt3ch1p40, p215, or 23:43.
|
| selectorValue one | Text | The position as machines read it, such as an EPUB CFI, a media fragment, or a page number. |
On CallSession
On Enrollment
On Journey
On Membership
| Property | Expected type | Description |
|---|---|---|
| role one | Text | The role or title held in a Tenure or Membership, or the kind of Relationship. |
On Relationship
| Property | Expected type | Description |
|---|---|---|
| role one | Text | The role or title held in a Tenure or Membership, or the kind of Relationship. |
On Tenure
| Property | Expected type | Description |
|---|---|---|
| role one | Text | The role or title held in a Tenure or Membership, or the kind of Relationship. |
On AudioObject
| Property | Expected type | Description |
|---|---|---|
| artist many | MusicGroup | The musical act that created or performed the recording or album. |
| duration one | Text | How long the recording or media lasts. |
| genre many | Text | A genre of the work. |
| transcript one | Text | The words spoken in a recording or an episode, written out, such as a voice memo's transcript, a podcast episode's transcript, or a video's captions. |
On DocumentObject
On ImageObject
| Property | Expected type | Description |
|---|---|---|
| caption one | Text | A caption or description of the picture or video, written by a person. |
| exifData one | JSONObject | What the image's file records about how it was taken, as EXIF tags. |
| height one | Number | The height of the image or video, in pixels. |
| width one | Number | The width of the image or video, in pixels. |
On VideoObject
| Property | Expected type | Description |
|---|---|---|
| duration one | Text | How long the recording or media lasts. |
| height one | Number | The height of the image or video, in pixels. |
| transcript one | Text | The words spoken in a recording or an episode, written out, such as a voice memo's transcript, a podcast episode's transcript, or a video's captions. |
| width one | Number | The width of the image or video, in pixels. |