Action

Breadcrumb: Thing > 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.

Parent types

Thing

Properties

Properties for Action

Property	Expected type	Defined on	Description
actionProcess	HowTo	Action	Description of the process by which the action was performed.
actionStatus	ActionStatusType	Action	Indicates the current disposition of the Action.
agent	Organization, Person	Action	The direct performer or driver of the action (animate or inanimate). E.g. John wrote a book.
endTime	DateTime, Time	Action	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 performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
error	Thing	Action	For failed actions, more information on the cause of the failure. Consider using the Error type.
instrument	Thing	Action	The object that helped the agent perform the action. E.g. John wrote a book with a pen.
location	Place, PostalAddress, Text, VirtualLocation	Action	The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
object	Thing	Action	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 doesn't). E.g. John read a book.
participant	Organization, Person	Action	Other co-agents that participated in the action indirectly. E.g. John wrote a book with Steve.
provider	Organization, Person	Action	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.
result	Thing	Action	The result produced in the action. E.g. John wrote a book.
startTime	DateTime, Time	Action	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 performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
target	EntryPoint, URL	Action	Indicates a target EntryPoint, or url, for an Action.

Inherited properties

Property	Expected type	Inherited from	Description
additionalType	Text, URL	Thing	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. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
alternateName	Text	Thing	An alias for the item.
description	Text, TextObject	Thing	A description of the item.
disambiguatingDescription	Text	Thing	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.
identifier	PropertyValue, Text, URL	Thing	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.
image	ImageObject, URL	Thing	An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage	CreativeWork, URL	Thing	Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
name	Text	Thing	The name of the item.
owner	Organization, Person	Thing	A person or organization who owns this Thing.
potentialAction	Action	Thing	Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs	URL	Thing	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	CreativeWork, Event	Thing	A CreativeWork or Event about this Thing.
url	URL	Thing	URL of the item.

Sub-types

AchieveAction, AssessAction, ConsumeAction, ControlAction, CreateAction, FindAction, InteractAction, MoveAction, OrganizeAction, PlayAction, SearchAction, SeekToAction, SolveMathAction, TradeAction, TransferAction, UpdateAction

Example

{
  "@context": "https://schema.org",
  "@type": "Action",
  "name": "Example Name",
  "description": "A short description.",
  "url": "/example",
  "actionProcess": "Example value",
  "actionStatus": "Example value"
}