NAME

SemanticWeb::Schema::Action - An action performed by a direct agent and indirect participants upon a direct object

VERSION

version v23.0.0

DESCRIPTION

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](http://blog.schema.org/2014/04/announcing-schemaorg-actions.html) and [Actions overview document](http://schema.org/docs/actions.html).

ATTRIBUTES

action_status

actionStatus

Indicates the current disposition of the Action.

A action_status should be one of the following types:

InstanceOf['SemanticWeb::Schema::ActionStatusType']

_has_action_status

A predicate for the "action_status" attribute.

agent

The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.

A agent should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

_has_agent

A predicate for the "agent" attribute.

end_time

endTime

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.

A end_time should be one of the following types:

Str

_has_end_time

A predicate for the "end_time" attribute.

error

For failed actions, more information on the cause of the failure.

A error should be one of the following types:

InstanceOf['SemanticWeb::Schema::Thing']

_has_error

A predicate for the "error" attribute.

instrument

The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.

A instrument should be one of the following types:

InstanceOf['SemanticWeb::Schema::Thing']

_has_instrument

A predicate for the "instrument" attribute.

location

The location of, for example, where an event is happening, where an organization is located, or where an action takes place.

A location should be one of the following types:

InstanceOf['SemanticWeb::Schema::Place']
InstanceOf['SemanticWeb::Schema::PostalAddress']
InstanceOf['SemanticWeb::Schema::VirtualLocation']
Str

_has_location

A predicate for the "location" attribute.

object

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*.

A object should be one of the following types:

InstanceOf['SemanticWeb::Schema::Thing']

_has_object

A predicate for the "object" attribute.

participant

Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.

A participant should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

_has_participant

A predicate for the "participant" attribute.

provider

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.

A provider should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

_has_provider

A predicate for the "provider" attribute.

result

The result produced in the action. E.g. John wrote *a book*.

A result should be one of the following types:

InstanceOf['SemanticWeb::Schema::Thing']

_has_result

A predicate for the "result" attribute.

start_time

startTime

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.

A start_time should be one of the following types:

Str

_has_start_time

A predicate for the "start_time" attribute.

target

Indicates a target EntryPoint, or url, for an Action.

A target should be one of the following types:

InstanceOf['SemanticWeb::Schema::EntryPoint']
Str

_has_target

A predicate for the "target" attribute.

SEE ALSO

SemanticWeb::Schema::Thing

SOURCE

The development version is on github at https://github.com/robrwo/SemanticWeb-Schema and may be cloned from git://github.com/robrwo/SemanticWeb-Schema.git

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/SemanticWeb-Schema/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Robert Rothenberg <rrwo@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2023 by Robert Rothenberg.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)