Action
An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.
See also blog post and Actions overview document.
Extends: Thing
Properties
| Property | Expected Type | Description |
|---|---|---|
| actionProcess | HowTo | Description of the process by which the action was performed. |
| actionStatus | ActionStatusType | Indicates the current disposition of the Action. |
| agent | Person, Organization | The direct performer or driver of the action (animate or inanimate). E.g. John wrote a book. |
| endTime | Time, DateTime | The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was perfo... |
| error | Thing | For failed actions, more information on the cause of the failure. |
| instrument | Thing | The object that helped the agent perform the action. E.g. John wrote a book with a pen. |
| location | VirtualLocation, PostalAddress, Text, Place | The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
| object | Thing | The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which do... |
| participant | Organization, Person | Other co-agents that participated in the action indirectly. E.g. John wrote a book with Steve. |
| provider | Person, Organization | 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... |
| result | Thing | The result produced in the action. E.g. John wrote a book. |
| startTime | Time, DateTime | The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was p... |
| target | URL, EntryPoint | Indicates a target EntryPoint, or url, for an Action. |
[Thing](https://schema.org.ai/Thing) Properties
| Property | Expected Type | Description |
|---|---|---|
| additionalType | Text, URL | 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... |
| alternateName | Text | An alias for the item. |
| description | Text, TextObject | A description of the item. |
| disambiguatingDescription | Text | 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 descr... |
| identifier | URL, Text, PropertyValue | 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 re... |
| image | ImageObject, URL | An image of the item. This can be a URL or a fully described ImageObject. |
| mainEntityOfPage | CreativeWork, URL | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
| name | Text | The name of the item. |
| potentialAction | Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
| sameAs | URL | 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. |
| subjectOf | Event, CreativeWork | A CreativeWork or Event about this Thing. |
| url | URL | URL of the item. |
Subtypes
| Type | Description |
|---|---|
| AchieveAction | The act of accomplishing something via previous efforts. It is an instantaneous action rather than an ongoing process. |
| AssessAction | The act of forming one's opinion, reaction or sentiment. |
| ConsumeAction | The act of ingesting information/resources/food. |
| ControlAction | An agent controls a device or application. |
| CreateAction | The act of deliberately creating/producing/generating/building a result out of the agent. |
| FindAction | The act of finding an object. Related actions: * SearchAction: FindAction is generally lead by a SearchAction, but not necessarily. |
| InteractAction | The act of interacting with another person or organization. |
| MoveAction | The act of an agent relocating to a place. Related actions: * TransferAction: Unlike TransferAction, the subject of the move is a living Person or Organiza... |
| OrganizeAction | The act of manipulating/administering/supervising/controlling one or more objects. |
| PlayAction | The act of playing/exercising/training/performing for enjoyment, leisure, recreation, competition or exercise. Related actions: * ListenAction: Unlike Listen... |
| SearchAction | The act of searching for an object. Related actions: * FindAction: SearchAction generally leads to a FindAction, but not necessarily. |
| SeekToAction | This is the Action of navigating to a specific startOffset timestamp within a VideoObject,... |
| SolveMathAction | The action that takes in a math expression and directs users to a page potentially capable of solving/simplifying that expression. |
| TradeAction | The act of participating in an exchange of goods and services for monetary compensation. An agent trades an object, product or service with a participant in exchange for a one time or periodic paym... |
| TransferAction | The act of transferring/moving (abstract or concrete) animate or inanimate objects from one place to another. |
| UpdateAction | The act of managing by changing/editing the state of the object. |