EntryPoint

CDIFCore::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]	Documentation Original Reference schema:description Definition A description of the item. Scope Domain: Thing (https://schema.org/Thing). Range: Text (https://schema.org/Text), TextObject (https://schema.org/TextObject). CDIF Definition A short summary describing a dataset. This text will be indexed by search applications, so the more information here, the better. Scope schema:description - description of the entry point.
urlTemplate	string	[1]	Documentation Original Reference schema:urlTemplate Definition An url template (RFC6570) that will be used to construct the target of the execution of the action. Scope Domain: EntryPoint (https://schema.org/EntryPoint). Range: Text (https://schema.org/Text). CDIF Definition a templated URL; parameters are enclosed in curly braces ({..}); parameters are not required. If included, parameters MUST be documented in the query-input element. Template should be consitent with URI Template (https://datatracker.ietf.org/doc/html/rfc6570) examples: - http://portal.chordsrt.com/api/v1/data.{encoding}; single parameter - http://portal.chordsrt.com/api/v1/data.{encoding}?instruments={instruments}&start={start}&end={end} ; multiple parameters - {endpoint}{encoding}; endpoint URL path is a parameter,should only appear in potential actions for API specification descriptions, which are generic-not specific to a particular endpoint. Scope schema:urlTemplate - templated URL (RFC 6570); curly-brace parameters are documented in the Action's query-input.
httpMethod	string	[0..*]	Documentation Original Reference schema:httpMethod Definition An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP. Scope Domain: EntryPoint (https://schema.org/EntryPoint). Range: Text (https://schema.org/Text). CDIF Definition only applicable if protocol is http or a protocol that tunnels on http Scope schema:httpMethod - HTTP method(s) (GET, PUT, POST, PATCH, DELETE, ...); applicable when the protocol is HTTP.
contentType	string	[0..*]	Documentation Original Reference schema:contentType Definition The supported content type(s) for an EntryPoint response. Scope Domain: EntryPoint (https://schema.org/EntryPoint). Range: Text (https://schema.org/Text). CDIF Definition The supported content type(s) for an EntryPoint response. a MIME type (https://www.iana.org/assignments/media-types/media-types.xhtml) that specifies the content type for messages in resonses from the service endpoint. This is a schema.org property, and is redundant with encodingFormat in the result property for the Action. Scope schema:contentType - supported MIME content type(s) for the endpoint response.

Associations

Role	Target	Multiplicity	Kind
target	← Action	[1]	association