Hypermedia Controls Ontology

This document introduces an ontology for links and forms, the main hypermedia controls in use on the Web. This ontology offers, among others, a means to reify RDF statements interpreted as links between Web resources. It also provides a versatile exchange format for links and forms in RESTful Web applications.

Hypermedia controls are of importance in the fields of the Web of Things and the Embedded Web, in particular in the W3C Thing Description model and the IETF Constrained RESTful Application Language.

Axiomatization

Classes

AdditionalExpectedResponse

IRI: https://www.w3.org/2019/wot/hypermedia#AdditionalExpectedResponse

Communication metadata describing the expected response message for additional responses.

In the domain of	`hctl:hasAdditionalOutputSchema` `hctl:isSuccess`
In the range of	`hctl:additionalReturns`

ExpectedResponse

IRI: https://www.w3.org/2019/wot/hypermedia#ExpectedResponse

Communication metadata describing the expected response message for the primary response.

In the range of hctl:returns

Form

IRI: https://www.w3.org/2019/wot/hypermedia#Form

A form can be viewed as a statement of "To perform an operation type operation on form context, make a request method request to submission target" where the optional form fields may further describe the required request. In Thing Descriptions, the form context is the surrounding Object, such as Properties, Actions, and Events or the Thing itself for meta-interactions.

In the domain of	`hctl:additionalReturns` `hctl:forContentCoding` `hctl:forContentType` `hctl:forSubProtocol` `hctl:hasOperationType` `hctl:hasTarget` `hctl:returns`
In the range of	`td:hasForm`

Link

IRI: https://www.w3.org/2019/wot/hypermedia#Link

A link can be viewed as a statement of the form "link context has a relation type resource at link target", where the optional target attributes may further describe the resource.

In the domain of	`hctl:hasAnchor` `hctl:hasRelationType` `hctl:hasSizes` `hctl:hasTarget` `hctl:hintsAtMediaType`
In the range of	`td:hasLink`

Object Properties

additionalReturns

IRI: https://www.w3.org/2019/wot/hypermedia#additionalReturns

This optional term can be used if additional expected responses are possible, e.g. for error reporting. Each additional response needs to be distinguished from others in some way (for example, by specifying a protocol-specific response code), and may also have its own data schema.

Domain includes	`hctl:Form`
Range includes	`hctl:AdditionalExpectedResponse`

hasAdditionalOutputSchema

IRI: https://www.w3.org/2019/wot/hypermedia#hasAdditionalOutputSchema

This optional term can be used to define a data schema for an additional response if it differs from the default output data schema. Rather than a DataSchema object, the name of a previous definition given in a schemaDefinitions map must be used.

Domain includes hctl:AdditionalExpectedResponse

hasAnchor

IRI: https://www.w3.org/2019/wot/hypermedia#hasAnchor

By default, the context, or anchor, of a link conveyed in the Link header field is the URL of the representation it is associated with, as defined in RFC7231, Section 3.1.4.1, and is serialized as a URI.

Domain includes hctl:Link

hasOperationType

IRI: https://www.w3.org/2019/wot/hypermedia#hasOperationType

Indicates the semantic intention of performing the operation(s) described by the form.

Domain includes hctl:Form

hasRelationType

IRI: https://www.w3.org/2019/wot/hypermedia#hasRelationType

A link relation type identifies the semantics of a link.

Domain includes hctl:Link

hasSizes

IRI: https://www.w3.org/2019/wot/hypermedia#hasSizes

Target attribute that specifies one or more sizes for the referenced icon. Only applicable for relation type 'icon'. The value pattern follows {Height}x{Width} (e.g., "16x16", "16x16 32x32")

Domain includes hctl:Link

hasTarget

IRI: https://www.w3.org/2019/wot/hypermedia#hasTarget

target IRI of a link or submission target of a form.

Domain includes hctl:Form
hctl:Link

returns

IRI: https://www.w3.org/2019/wot/hypermedia#returns

This optional term can be used if, e.g., the output communication metadata differ from input metadata (e.g., output contentType differ from the input contentType). The response name contains metadata that is only valid for the reponse messages.

Domain includes	`hctl:Form`
Range includes	`hctl:ExpectedResponse`

Datatype Properties

forContentCoding

IRI: https://www.w3.org/2019/wot/hypermedia#forContentCoding

Content coding values indicate an encoding transformation that has been or can be applied to a representation. Content codings are primarily used to allow a representation to be compressed or otherwise usefully transformed without losing the identity of its underlying media type and without loss of information. Examples of content coding include "gzip", "deflate", etc.

Domain includes	`hctl:Form`
Range includes	`schema:Text`

forContentType

IRI: https://www.w3.org/2019/wot/hypermedia#forContentType

Assign a content type based on a media type [[IANA-MEDIA-TYPES]] (e.g., 'text/plain') and potential parameters (e.g., 'charset=utf-8') for the media type.

Domain includes	`hctl:Form`
Range includes	`schema:Text`

forSubProtocol

IRI: https://www.w3.org/2019/wot/hypermedia#forSubProtocol

Indicates the exact mechanism by which an interaction will be accomplished for a given protocol when there are multiple options. For example, for HTTP and Events, it indicates which of several available mechanisms should be used for asynchronous notifications such as long polling, websub (also see https://www.w3.org/TR/websub/), or server sent events (also see https://www.w3.org/TR/eventsource/). Please note that there is no restriction on the sub-protocol selection and other mechanisms can also be announced by this subprotocol term.

Domain includes	`hctl:Form`
Range includes	`schema:Text`

hintsAtMediaType

IRI: https://www.w3.org/2019/wot/hypermedia#hintsAtMediaType

Target attribute providing a hint indicating what the media type [IANA-MEDIA-TYPES] of the result of dereferencing the link should be.

Domain includes	`hctl:Link`
Range includes	`schema:Text`

isSuccess

IRI: https://www.w3.org/2019/wot/hypermedia#isSuccess

Signals if the additional response should not be considered an error.

Domain includes	`hctl:AdditionalExpectedResponse`
Range includes	`schema:Boolean`

Usage Examples

JSON Representation of Links & Forms

Same terms as specified by JSON hyper-schema and the TD model.

{
    "@context": {
        "@vocab": "https://www.w3.org/2019/wot/hypermedia#",
        "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
        "href": { "@id": "hasTarget", "@type": "@id" },
        "rel": { "@id": "hasRelationType", "@type": "@vocab" },
        "anchor": { "@id": "hasAnchor", "@type": "@id" },
        "type": { "@id": "hintsAtMediaType" },
        "op": { "@id": "rdf:type"; "@type": "@vocab" },
        "contentType": { "@id": "forContentType" },
        "contentCoding": { "@id": "forContentCoding" },
        "subprotocol": { "@id": "forSubProtocol" },
        "response": { "@id": "returns" },
        "readproperty": { "@id": "ReadPropertyOperation" },
        "writeproperty": { "@id": "WritePropertyOperation" },
        "observeproperty": { "@id": "ObservePropertyOperation" },
        "unobserveproperty": { "@id": "UnobservePropertyOperation" },
        "readmultipleproperties": { "@id": "ReadMultiplePropertiesOperation" },
        "writemultipleproperties": { "@id": "WriteMultiplePropertiesOperation" },
        "readallproperties": { "@id": "ReadAllPropertiesOperation" },
        "writeallproperties": { "@id": "WriteAllPropertiesOperation" },
        "invokeaction": { "@id": "InvokeActionOperation" },
        "subscribeevent": { "@id": "SubscribeEventOperation" },
        "unsubscribeevent": { "@id": "UnsubscribeEventOperation" }
    }
}

OCF example (equivalent to an OpenAPI definition). HTTP in RDF vocabulary.

{
    "@context": [
        ...,
        {
            "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
            "htv": "http://www.w3.org/2011/http#"
        }
    ],
    "@graph": [
        {
            "href": "https://openconnectivityfoundation.github.io/IoTDataModels/TemperatureResURI.swagger.json",
            "rel": "rdfs:seeAlso"
        },
        {
            "href": "/TemperatureResURI",
            "op": "readproperty",
            "htv:methodName": "GET",
            "response": [
                { "htv:statusCodeNumber": 200 },
                { "htv:statusCodeNumber": 403 }
            ]
        },
        {
            "href": "/TemperatureResURI",
            "op": "writeproperty",
            "htv:methodName": "POST",
            "response": [
                { "htv:statusCodeNumber": 200 },
                { "htv:statusCodeNumber": 403 }
            ]
        }
    ]
}

Reified Links

{
    "@context": { "about": "http://schema.org/about" },
    "@id": "https://en.wikipedia.org/wiki/Web_of_Things",
    "about": "http://www.wikidata.org/entity/Q2814098"
}

{
    "@context": [
        ...,
        { "about": "http://schema.org/about" }
    ],
    "links": [
        {
            "anchor": "https://en.wikipedia.org/wiki/Web_of_Things",
            "rel": "about",
            "href": "http://www.wikidata.org/entity/Q2814098"
        }
    ]
}

Either as RDF statements or as reified statements. Primarily for WoT compatibility but also e.g. to include validity metadata.

Introduction

Axiomatization

Classes

AdditionalExpectedResponse

ExpectedResponse

Form

Link

Object Properties

additionalReturns

hasAdditionalOutputSchema

hasAnchor

hasOperationType

hasRelationType

hasSizes

hasTarget

returns

Datatype Properties

forContentCoding

forContentType

forSubProtocol

hintsAtMediaType

isSuccess

Alignments

Hydra

Usage Examples

JSON Representation of Links & Forms

Reified Links

`hctl:Link`	`hydra:Link`
`hctl:Form`	`hydra:Operation`