EntryPoint inherited from CDIFCore
CDIFProvenance::Classes::EntryPoint
Definition
Documentation
Original
Reference
schema:EntryPoint
Definition
An entry point, within some Web-based protocol.
Scope
Parent class(es): Intangible (https://schema.org/Intangible).
CDIF
Definition
schema:EntryPoint - documents the URL endpoint and request syntax used to invoke an Action.
Diagram
Inheritance
No generalization relationships.
Attributes
| Name | Type | Multiplicity | Description |
|---|---|---|---|
| description | string | [0..1] | DocumentationOriginalReferenceschema:description DefinitionA description of the item. ScopeDomain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text), TextObject (https://schema.org/TextObject). CDIFDefinitionText description of what this activity did Scopeschema:description - description of the entry point. |
| urlTemplate | string | [1] | DocumentationOriginalReferenceschema:urlTemplate DefinitionAn url template (RFC6570) that will be used to construct the target of the execution of the action. ScopeDomain: EntryPoint (https://schema.org/EntryPoint). Range: Text (https://schema.org/Text). CDIFDefinitionschema:urlTemplate - templated URL (RFC 6570); curly-brace parameters are documented in the Action's query-input. |
| httpMethod | string | [0..*] | DocumentationOriginalReferenceschema:httpMethod DefinitionAn HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP. ScopeDomain: EntryPoint (https://schema.org/EntryPoint). Range: Text (https://schema.org/Text). CDIFDefinitionschema:httpMethod - HTTP method(s) (GET, PUT, POST, PATCH, DELETE, ...); applicable when the protocol is HTTP. |
| contentType | string | [0..*] | DocumentationOriginalReferenceschema:contentType DefinitionThe supported content type(s) for an EntryPoint response. ScopeDomain: EntryPoint (https://schema.org/EntryPoint). Range: Text (https://schema.org/Text). CDIFDefinitionschema:contentType - supported MIME content type(s) for the endpoint response. |
Associations
| Role | Target | Multiplicity | Kind |
|---|---|---|---|
| target | ← Action | [1] | association |