EntryPoint
An entry point, within some Web-based protocol.
Property | Expected Type | Description |
---|---|---|
Properties from EntryPoint | ||
actionApplication
|
SoftwareApplication | An application that can complete the request. Supersedes application. |
actionPlatform
|
Text or URL | The high level platform(s) where the Action can be performed for the given URL. To specify a specific application or operating system instance, use actionApplication. |
contentType
|
Text | The supported content type(s) for an EntryPoint response. |
encodingType
|
Text | The supported encoding type(s) for an EntryPoint request. |
httpMethod
|
Text | An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP. |
urlTemplate
|
Text | An url template (RFC6570) that will be used to construct the target of the execution of the action. |
Properties from Thing | ||
additionalType
|
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. |
alternateName
|
Text | An alias for the item. |
description
|
Text | 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 description to be useful for disambiguation. |
identifier
|
PropertyValue or Text or URL | 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 or URL | An image of the item. This can be a URL or a fully described ImageObject. |
mainEntityOfPage
|
CreativeWork or URL | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property: mainEntity. |
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
|
CreativeWork or Event | A CreativeWork or Event about this Thing. Inverse property: about. |
url
|
URL | URL of the item. |
Instances of EntryPoint may appear as values for the following properties
Property | On Types | Description |
---|---|---|
target
|
Action | Indicates a target EntryPoint for an Action. |
Acknowledgement
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.
ExamplesA Restaurant named "Tartine Bakery" with a ViewAction as a potentialAction, with several target endpoints including the simple url http://example.com/player?id=123 and full EntryPoint descriptions for Windows and iOS SoftwareApplication apps.
This example is JSON only.
This example is JSON only.
<script type="application/ld+json"> { "@context": "http://schema.org", "@type": "Restaurant", "name": "Tartine Bakery", "potentialAction": { "@type": "ViewAction", "target": [ "http://www.urbanspoon.com/r/6/92204", { "@type": "EntryPoint", "urlTemplate": "http://api.urbanspoon.com/r/6/92204", "contentType": "application/json+ld" }, "android-app://com.urbanspoon/http/www.urbanspoon.com/r/6/92204", { "@type": "EntryPoint", "urlTemplate": "urbanspoon://r/6/92204", "actionApplication": { "@type": "SoftwareApplication", "@id": "284708449", "name": "Urbanspoon iPhone & iPad App", "operatingSystem": "iOS" } }, { "@type": "EntryPoint", "urlTemplate": "urbanspoon://r/6/92204", "actionApplication": { "@type": "SoftwareApplication", "@id": "5b23b738-bb64-4829-9296-5bcb59bb0d2d", "name": "Windows Phone App", "operatingSystem": "Windows Phone 8" } } ] } } </script>