Action
schema:Thing > schema: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.
See also blog post and Actions overview document.
Property | Expected Type | Description |
---|---|---|
Properties from schema:Action | ||
schema:actionStatus
|
schema:ActionStatusType | Indicates the current disposition of the Action. |
schema:agent
|
schema:Organization or schema:Person | The direct performer or driver of the action (animate or inanimate). e.g. *John* wrote a book. |
schema:endTime
|
schema: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 performed. e.g. John wrote a book from January to *December*. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
schema:error
|
schema:Thing | For failed actions, more information on the cause of the failure. |
schema:instrument
|
schema:Thing | The object that helped the agent perform the action. e.g. John wrote a book with *a pen*. |
schema:location
|
schema:Place or schema:PostalAddress | The location of the event, organization or action. |
schema:object
|
schema:Thing | The object upon 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*. |
schema:participant
|
schema:Organization or schema:Person | Other co-agents that participated in the action indirectly. e.g. John wrote a book with *Steve*. |
schema:result
|
schema:Thing | The result produced in the action. e.g. John wrote *a book*. |
schema:startTime
|
schema: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 performed. e.g. John wrote a book from *January* to December. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
schema:target
|
schema:EntryPoint | Indicates a target EntryPoint for an Action. |
Properties from schema:Thing | ||
schema:additionalType
|
schema: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 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:alternateName
|
schema:Text | An alias for the item. |
schema:description
|
schema:Text | A short description of the item. |
schema:image
|
schema:ImageObject or schema:URL | An image of the item. This can be a URL or a fully described ImageObject. |
schema:name
|
schema:Text | The name of the item. |
schema:potentialAction
|
schema:Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
schema:sameAs
|
schema:URL | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website. |
schema:url
|
schema:URL | URL of the item. |
Instances of schema:Action may appear as values for the following properties
Property | On Types | Description |
---|---|---|
schema:potentialAction
|
schema:Thing | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
More specific Types
Prefixes used:
Acknowledgements
The schema.org Actions mechanism benefited from extensive discussions across the Web standards community around W3C, in particular from the Hydra project's community group.Examples
John listened to Pink with Steve at Anna's apartment on his iPod.
This example is JSON only.
This example is JSON only.
<!-- John listened to Pink with Steve at Anna's apartment on his iPod. --> <script type="application/ld+json"> { "@context": "http://schema.org", "@type": "ListenAction", "agent": { "@type": "Person", "name": "John" }, "object": { "@type": "MusicGroup", "name": "Pink!" }, "participant": { "@type": "Person", "name": "Steve" }, "location": { "@type": "Residence", "name": "Ann's apartment" }, "instrument": { "@type": "Product", "name": "iPod" } } </script>
John created an exercise plan with Steve.
This example is JSON only.
This example is JSON only.
<!-- John created an exercise plan with Steve. --> <script type="application/ld+json"> { "@context": "http://schema.org", "@type": "CreateAction", "agent": { "@type": "Person", "name": "John" }, "result": { "@type": "ExercisePlan", "name": "John's weight loss plan" }, "participant": { "@type": "Person", "name": "Steve" } } </script>
BiblioGraph.net Version 1.1
Schema.org Version 1.93
Code Version 1.1