ActionStatusType

ActionStatusType is a 4-value StatusEnumeration used on Action.actionStatus. Values: PotentialActionStatus (the action is available but not started), ActiveActionStatus (in progress), CompletedActionStatus (finished successfully), FailedActionStatus (attempted and failed).

Full example of schema.org/ActionStatusType json-ld markup

The markup is verified as valid with Rich Results Test from Google.

schema.org/ActionStatusType

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "ReserveAction",
  "name": "Reserved a table",
  "agent": { "@type": "Person", "name": "Sam Xoo" },
  "object": { "@type": "FoodEstablishmentReservation", "reservationId": "RX-47" },
  "actionStatus": "https://schema.org/CompletedActionStatus"
}
</script>

Minimal valid version

The smallest markup that still produces a valid ActionStatusType entity. Use it as the floor. Reach for the advanced example above when you want search engines and AI agents to understand more about your content.

schema.org/ActionStatusType (minimal)

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Action",
  "actionStatus": "https://schema.org/CompletedActionStatus"
}
</script>

Google rich results this unlocks

ActionStatusType is a structural type. It does not produce a rich result on its own.

Its value comes from combining it with a primary type whose markup earns a rich result (Article, Product, Event, and so on). ActionStatusType becomes the trunk that the primary type branches off viamainEntityorbreadcrumb. Include it on every page as the backbone of your markup.

Common ActionStatusType mistakes

Mistakes that pass validation but silently fail to earn rich results or mislead consumers walking the graph. Avoid these and your markup will be ahead of most sites in the wild.

01
actionStatus as a string
Wrong
```
"actionStatus": "completed"
```
Right
```
"actionStatus": "https://schema.org/CompletedActionStatus"
```
Only the four URIs are recognised; free text is silently dropped.

Schema properties in this example

ActionStatusType StatusEnumeration actionStatus PotentialActionStatus ActiveActionStatus CompletedActionStatus FailedActionStatus

Also mentioned in 1 other example

ActionStatusType also appears in StatusEnumeration. See the full ActionStatusType schema page for every reference.

About the example data

"CompletedActionStatus" on every retrospective Action node in the Xoo Code activity log.

Comments

Loading comments...