Reference
Classes
A class is a kind of record. Every record is an Action or an Entity, descended from Base. A class inherits every property of the classes above it.
Actions
Something that happened, such as reading an article, sending a message, or visiting a place.
-
Action
Something that happened, such as reading an article, sending a message, or visiting a place.
- AcceptAction The agent accepted what was put forward, such as merging a changeset into the work it changes.
-
AssessAction
The agent took a stance on the object, such as by liking, reacting to, rating, or reviewing it.
-
ReactAction
The agent took a stance on the object with no content, such as a like.
- LikeAction The agent liked the object.
- UnlikeAction The agent withdrew a like of the object, such as by removing a favorite.
- RespondAction The agent responded to the object with content, such as an emoji reaction, a comment, a rating, or a review.
-
ReactAction
The agent took a stance on the object with no content, such as a like.
- CancelAction The agent withdrew a plan or intended activity, such as a task.
- CompleteAction The agent finished an activity or piece of work, such as a task or a book.
-
ConsumeAction
The agent took in the object, such as by reading, watching, listening to, eating, or drinking it.
- DrinkAction The agent drank the object.
- EatAction The agent ate the object, a Meal.
- ListenAction The agent listened to the object, such as a recording or a podcast episode.
- ReadAction The agent read the object, such as a book, an article, or a document.
- ViewAction The agent looked at the object, such as a web page visited, a photo opened, or a document viewed.
- WatchAction The agent watched the object, such as a video, a film, or a show.
-
CreateAction
The agent brought a work into being.
- AnnotateAction The agent wrote a note on something, such as a comment on a highlighted passage, a note on a work, or a note in the margin of a page.
- PhotographAction The agent took a photograph.
- PublishAction The agent published or released a work, such as a post, a video, or a pull request.
- QuoteAction The agent selected a passage of the object, such as a highlight in a book or an excerpt from a page.
- RecordAction The agent recorded sound or video, such as a voice memo, a video clip, or a screen recording.
- ScreenshotAction The agent captured what a screen showed, such as a web page or an app.
- DeleteAction The agent removed an entity from its source, such as by moving an item to the trash.
- ExecuteAction The agent ran a command or a piece of software.
-
ExperienceAction
The subject went through a period of life or a life event, such as a logged block of time, a job, or a relationship.
- JoinAction The subject joined the object organization or realm, starting a membership.
- LeaveAction The subject left the object organization or realm, ending a membership that a JoinAction started.
- SleepAction The agent slept from startTime to endTime, such as for a night or a nap, including any brief wakings.
- FindAction The agent searched on a platform.
-
InteractAction
The agent engaged with others, such as by communicating with them or following them.
-
CommunicateAction
The agent conveyed something to others, such as by sending a message, making a call, or checking in.
- CallAction The agent made a phone or video call.
- CheckInAction The agent announced that they were at the object, a Venue.
- ShareAction The agent shared the object with others, such as by sending a photo in a conversation.
- FollowAction The agent started following the object, such as an account, a feed, or a collection.
-
CommunicateAction
The agent conveyed something to others, such as by sending a message, making a call, or checking in.
- MeasureAction The agent took a measurement of the object, such as a person's heart rate or weight.
- MessageAction The agent sent a message.
-
MoveAction
The agent moved from the object to the target.
- NavigateAction The agent took one step through an information space, from the object to the target, such as following a link from one web page to another.
-
OrganizeAction
The agent arranged or planned things, such as by saving, bookmarking, or scheduling.
- BookmarkAction The agent saved the object for later, such as a bookmarked page, an article saved to a reading list, or a book shelved as to-read.
- PlanAction The agent decided to do something, such as by creating a to-do item.
- RejectAction The agent declined what was put forward, such as closing a changeset without taking it in.
-
TradeAction
The agent exchanged something of value with another agent, such as by buying, selling, or paying.
- PayAction The agent paid money to another agent, such as for a purchase with a card.
- TravelAction The agent travelled from the object place to the target place, from startTime to endTime.
- UpdateAction The agent changed an existing entity, such as by editing a task's title or notes.
- VisitAction The agent stayed at the object place from startTime to endTime.
Entities
A thing a source describes, such as a person, place, document, or web page. An entity is the thing itself. An Action records what happened to it or with it.
-
Entity
A thing a source describes, such as a person, place, document, or web page.
-
Agent
An entity that can act, such as a person, an organization, or a piece of software.
-
Organization
A group of people acting as one, such as a company, an institution, a club, or a school.
-
PerformingGroup
An organization that performs, such as a band, a troupe, or an ensemble.
- MusicGroup A musical act, such as a band, an orchestra, or a solo artist as a performer.
-
PerformingGroup
An organization that performs, such as a band, a troupe, or an ensemble.
- Person A human being, such as a participant in a conversation or the user of a computer.
- SoftwareAgent Software that acts as a participant, such as an assistant, a bot, or an automation.
-
Organization
A group of people acting as one, such as a company, an institution, a club, or a school.
- Command An instruction given to a computer, such as a shell command.
-
CreativeWork
A work made by an agent, such as a text, a recording, a post, a message, or a document.
- Article A written piece published on the web or in a periodical, such as a news story, a blog post, or a feed item.
- Book A book, in one edition.
- Changeset A set of changes to a work, made as a unit, such as a pull request, a suggested edit to a document, or the text a writer added to a note in one sitting.
- Channel A named place where several participants post messages, such as a workspace channel, a group chat, or a chat room.
-
Collection
A group of entities that a source declares, such as a list, an area of responsibility, or a section of a project.
- Calendar A calendar of events, such as a person's primary calendar, a shared team calendar, or a subscribed holiday calendar.
- Directory A filesystem directory.
- Project An undertaking that groups related work toward an outcome.
- Thread A conversation that its source groups together, such as an email thread or a chat with an assistant.
-
MediaObject
A media file, such as an image, an audio recording, a video, or a document.
- AudioObject A sound recording, such as a voice message or a music file.
- DocumentObject A document file, such as a PDF, a text file, or a document attachment.
- ImageObject An image file, such as a photo's file, a screenshot, or an image attachment.
- VideoObject A video file, such as a recorded clip or a video attachment.
- Message A communication sent to one or more agents, such as a text message, an email, or a chat reply.
- MovingImage A video as a work, such as one recorded with a camera or of a screen: what it shows, apart from the files that hold it.
- MusicAlbum A released collection of music recordings.
- MusicRecording A recording of a piece of music, such as a track on an album.
- Note A text that its author keeps and edits, such as a note in a notes app or a page in a personal wiki.
- PodcastEpisode One episode of a podcast.
- PodcastSeries A podcast, a series of episodes published through a webFeed by a publisher.
- Post A work published to a social or media platform, such as a feed post, a story, a reel, or a tweet.
- Query A search query as it was entered.
- Quotation A passage selected from a work, such as a highlight or an excerpt.
- Repository A store of files and their history under version control, hosted on a forge or kept locally.
-
Response
A response to something, with content.
- Comment A response written in prose.
- Revision A version of a work in its history, such as a commit to a repository or a revision of a document or wiki page.
-
Software
A program, such as an application, an operating system, or a model.
- AIModel A trained model that generates or interprets content, such as a language model or a speech recognizer.
- OperatingSystem An operating system, or one release of it, that applications run on, such as a phone's or a computer's.
- SoftwareApplication A software application used to do work.
- SoftwareSourceCode Source code as a work, such as a snippet, a script, or a program's code.
- StillImage A still picture as a work, such as a photograph or a screenshot: what it shows, apart from the files that hold it.
- Event A named happening with a planned start and end, such as a calendar entry, a concert, or a picnic.
-
Intangible
An entity that is neither physical nor a creative work, such as a term, a selector, or a category.
-
DefinedTerm
A word or code from a vocabulary that classifies other entities, such as a tag or a category.
- Category A classification from a fixed set of kinds.
- FinancialAccount An account that money is counted in, as one line of a chart of accounts.
- FinancialPosting One side of a FinancialTransaction: the change it made to one FinancialAccount.
- FinancialTransaction A movement of money, such as a card purchase, a transfer between accounts, or a trade.
- PaymentCard A numbered card that payments draw on, such as a credit card or a debit card.
-
Selector
A position within a resource, such as where a passage is in a book, a page, or a media file.
- EpubCfiSelector A position in an EPUB, given by a Canonical Fragment Identifier.
- PageSelector A position in a paginated document, given by page number.
-
DefinedTerm
A word or code from a vocabulary that classifies other entities, such as a tag or a category.
- Meal A meal or snack that the subject ate.
-
PhysicalObject
A physical object the subject owns or uses, such as a device, a vehicle, or a musical instrument.
- Device A physical computing device the subject runs software on, such as a computer, a phone, a tablet, or a watch.
-
Place
A place in the world with an identity of its own, such as a venue, a city, a region, or a country.
- Venue A specific place that people go to, such as a café, a shop, a park, a home, or an office.
- ProductModel A kind of product, such as a line of phones or one model of camera, rather than one particular product.
- Realm A bounded account or computing domain, such as a workspace, a computer system, or an email domain.
-
Session
A period of one person's activity or experience, such as a night's sleep, a logged block of work, a trip across town, or their time on a call.
- CallSession One person's time on a phone or video call.
- DeviceSession A period of using a device, such as a block of time with one app in focus.
- Enrollment A period of study at a school.
- Journey A recorded stretch of travel, with its travelMode, its distance, and its route as its path.
- Membership A period of belonging to an organization or realm.
- Relationship A period of romantic partnership.
- SleepSession A period of sleep, such as a night or a nap.
- SleepStage A stretch of one stage of sleep, such as deep sleep, that isStageOf a SleepSession.
- Tenure A period of employment.
- Tag A label a source uses to categorize entities.
- Task A unit of work to be done, such as a to-do item.
-
Agent
An entity that can act, such as a person, an organization, or a piece of software.
StructuredValues
A value made of several fields that together state one fact, such as a position and its address. It describes something but has no identity of its own.
-
StructuredValue
A value made of several fields that together state one fact, such as a position and its address.
- Location A geographic position and address.
- MonetaryAmount A sum of money: its value in its currency.
Datatypes
Plain values carried directly by properties. They have no identity of their own.
- DateRange A stretch of time, all of it included.
- DateTime A point in time, written in a subset of EDTF (ISO 8601-2).
-
JSONObject
A JSON object whose values are text or numbers, such as
{"FNumber": 1.8, "LensModel": "EF50mm f/1.8 STM"}. - Number A number, whole or decimal.
- Text A string of characters, such as a name or an identifier.
-
URL
An absolute URL, such as
https://example.com/article.