Instance Information for SDF
draft-ietf-asdf-instance-information-00
| Document | Type | Active Internet-Draft (asdf WG) | |
|---|---|---|---|
| Authors | Carsten Bormann , Jan Romann | ||
| Last updated | 2025-12-23 | ||
| Replaces | draft-bormann-asdf-instance-information | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Intended RFC status | (None) | ||
| Formats | |||
| Additional resources | Mailing list discussion | ||
| Stream | WG state | WG Document | |
| Document shepherd | (None) | ||
| IESG | IESG state | I-D Exists | |
| Consensus boilerplate | Unknown | ||
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-ietf-asdf-instance-information-00
A Semantic Definition Format for Data and Interactions of ThingsC. Bormann
Internet-Draft Universität Bremen TZI
Intended status: Standards Track J. Romann
Expires: 26 June 2026 Universität Bremen
23 December 2025
Instance Information for SDF
draft-ietf-asdf-instance-information-00
Abstract
This document discusses types of Instance Information to be used in
conjunction with the Semantic Definition Format (SDF) for Data and
Interactions of Things (draft-ietf-asdf-sdf) and will ultimately
define Representation Formats for them as well as ways to use SDF
Models to describe them.
// The present revision is the first one after the adoption by the
// ASDF Working Group. Content-wise, it is unchanged compared to the
// preceding individual draft revision.
About This Document
This note is to be removed before publishing as an RFC.
Status information for this document may be found at
https://datatracker.ietf.org/doc/draft-ietf-asdf-instance-
information/.
Discussion of this document takes place on the A Semantic Definition
Format for Data and Interactions of Things Working Group mailing list
(mailto:asdf@ietf.org), which is archived at
https://mailarchive.ietf.org/arch/browse/asdf/. Subscribe at
https://www.ietf.org/mailman/listinfo/asdf/.
Source for this draft and an issue tracker can be found at
https://github.com/ietf-wg-asdf/instance-information.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Bormann & Romann Expires 26 June 2026 [Page 1]
Internet-Draft SDF Instance Information December 2025
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 26 June 2026.
Copyright Notice
Copyright (c) 2025 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Conventions and Definitions . . . . . . . . . . . . . . . 4
1.2. Terms we are trying not to use . . . . . . . . . . . . . 6
2. Instance Information and SDF . . . . . . . . . . . . . . . . 6
2.1. Axioms for instance-related messages . . . . . . . . . . 8
2.2. Context Information . . . . . . . . . . . . . . . . . . . 8
3. Message Format . . . . . . . . . . . . . . . . . . . . . . . 9
3.1. Information Block . . . . . . . . . . . . . . . . . . . . 9
3.2. Namespaces Block . . . . . . . . . . . . . . . . . . . . 10
3.3. Instance-of Block . . . . . . . . . . . . . . . . . . . . 11
3.4. Instance Block . . . . . . . . . . . . . . . . . . . . . 11
4. Message Archetypes . . . . . . . . . . . . . . . . . . . . . 12
4.1. State Reports . . . . . . . . . . . . . . . . . . . . . . 13
4.2. Construction Messages . . . . . . . . . . . . . . . . . . 13
4.3. State Report Updates . . . . . . . . . . . . . . . . . . 13
4.4. State Patches . . . . . . . . . . . . . . . . . . . . . . 14
5. Message Purposes and Usecases . . . . . . . . . . . . . . . . 14
5.1. Context Snapshots . . . . . . . . . . . . . . . . . . . . 15
5.2. Proofshots . . . . . . . . . . . . . . . . . . . . . . . 16
5.3. Construction Messages . . . . . . . . . . . . . . . . . . 17
Bormann & Romann Expires 26 June 2026 [Page 2]
Internet-Draft SDF Instance Information December 2025
5.4. Delta Messages . . . . . . . . . . . . . . . . . . . . . 18
5.5. Patch Messages . . . . . . . . . . . . . . . . . . . . . 19
5.6. Identity Manifest . . . . . . . . . . . . . . . . . . . . 21
6. Linking sdfProtocolMap and sdfContext via JSON Pointers . . . 21
7. Examples for SDF Constructors . . . . . . . . . . . . . . . . 24
8. Discussion . . . . . . . . . . . . . . . . . . . . . . . . . 26
9. Security Considerations . . . . . . . . . . . . . . . . . . . 26
10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 26
11.1. Normative References . . . . . . . . . . . . . . . . . . 26
11.2. Informative References . . . . . . . . . . . . . . . . . 27
Appendix A. Example SDF Model . . . . . . . . . . . . . . . . . 29
Appendix B. Formal Syntax of Instance-related Messages . . . . . 31
Appendix C. Roads Not Taken . . . . . . . . . . . . . . . . . . 33
C.1. Using SDF Models as Proofshots . . . . . . . . . . . . . 33
C.1.1. Alternative Instance Keys . . . . . . . . . . . . . . 36
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 37
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 37
1. Introduction
The Semantic Definition Format for Data and Interactions of Things
(SDF, [I-D.ietf-asdf-sdf]) is a format for domain experts to use in
the creation and maintenance of data and interaction models in the
Internet of Things.
SDF is an Interaction Modeling format, enabling a modeler to describe
the digital interactions that a class of Things (devices) offers,
including the abstract data types of messages used in these
interactions.
SDF is designed to be independent of specific ecosystems that specify
conventions for performing these interactions, e.g., over Internet
protocols or over ecosystem-specific protocol stacks.
SDF does not define representation formats for the _Instance
Information_ that is exchanged in, or the subject of such,
interactions; this is left to the specific ecosystems, which tend to
have rather different ways to represent this information.
Bormann & Romann Expires 26 June 2026 [Page 3]
Internet-Draft SDF Instance Information December 2025
This document discusses Instance Information in different types and
roles. It defines an _abstraction_ of this, as an eco-system
independent way to reason about this information. This abstraction
can be used at a _conceptual_ level, e.g., to define models that
govern the instance information. However, where this is desired, it
also can be used as the basis for a concrete _neutral representation_
(Format) that can actually be used for interchange to exchange
information and parameters for interactions to be performed. In
either case, the structure and semantics of this information are
governed by SDF Models.
This document is truly work in progress. It freely copies examples
from the [I-D.ietf-asdf-sdf-nonaffordance] document that evolves in
parallel, with a goal of further synchronizing the development where
that hasn't been fully achieved yet. After the discussion
stabilizes, we'll need to discuss how the information should be
distributed into the different documents and/or how documents should
be merged.
1.1. Conventions and Definitions
The definitions of [RFC6690], [RFC8288], and [I-D.ietf-asdf-sdf]
apply.
Terminology may need to be imported from [LAYERS].
Representation: As defined in Section 3.2 of RFC 9110 [STD97], but
understood to analogously apply to other interaction styles than
Representational State Transfer [REST] as well.
Message: A Representation that is exchanged in, or is the subject
of, an Interaction. Messages are "data in flight", not instance
"data at rest" (the latter are called "Instance" and are modeled
by the interaction model).
Depending on the specific message, an abstract data model for the
message may be provided by the sdfData definitions (or of
declarations that look like these, such as sdfProperty) of an SDF
model.
Deriving an ecosystem specific representation of a message may be
aided by _mapping files_ [I-D.bormann-asdf-sdf-mapping] that apply
to the SDF model providing the abstract data model.
Instantiation: Instantiation is a process that takes a Model, some
Context Information, and possibly information from a Device and
creates an Instance.
Bormann & Romann Expires 26 June 2026 [Page 4]
Internet-Draft SDF Instance Information December 2025
Instance: Anything that can be interacted with based on the SDF
model. E.g., the Thing itself (device), a Digital Twin, an Asset
Management system... Instances are modeled as "data at rest", not
"data in flight" (the latter are called "Message" and actually
are/have a Representation). Instances that relate to a single
Thing are bound together by some form of identity. Instances
become useful if they are "situated", i.e., with a physical or
digital "address" that they can be found at and made the subject
of an interaction.
Instance-related Message: A message that describes the state or a
state change of a specific instance. (TBC -- also: do we need
this additional term?)
Message Archetype: In the context of instance-related messages: A
message with specific content and effect, covering a wider set of
different use cases. In this document, we are observing a total
of four instance-related message archetypes.
Proofshot: A message that attempts to describe the state of an
Instance at a particular moment (which may be part of the
context). We are not saying that the Proofshot _is_ the instance
because there may be different ways to make one from an Instance
(or to consume one in updating the state of the Instance), and
because the proofshot, being a message, is not situated.
Proofshots are snapshots, and they are "proofs" in the
photographic sense, i.e., they may not be of perfect quality. Not
all state that is characteristic of an Instance may be included in
a Proofshot (e.g., information about an active action that is not
embedded in an action resource). Proofshots may depend on
additional context (such as the identity of the Instance and a
Timestamp).
An interaction affordance to obtain a Proofshot may not be
provided by every Instance. An Instance may provide separate
Construction affordances instead of simply setting a Proofshot.
Discuss Proofshots of a Thing (device) and of other components.
Discuss concurrency problems with getting and setting Proofshots.
Discuss Timestamps appropriate for Things (Section 4.4 of
[I-D.ietf-iotops-7228bis], [I-D.amsuess-t2trg-raytime]).
TODO: Also mention the other message types we had so far (context
snapshot, context patch, identity manifest) here?
Bormann & Romann Expires 26 June 2026 [Page 5]
Internet-Draft SDF Instance Information December 2025
Construction: Construction messages enable the creation of a digital
Instance, e.g., initialization/commissioning of a device or
creation of its digital twins. They are like proofshots, in that
they embody a state, however this state needs to be precise so the
construction can actually happen.
Discuss YANG config=true approach.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
[BCP14] (RFC2119) (RFC8174) when, and only when, they appear in all
capitals, as shown here.
1.2. Terms we are trying not to use
Non-affordance: Originally a term for information that is the
subject of interactions with other Instances than the Thing
(called "offDevice" now), this term is now considered confusing as
it would often just be an affordance of another Instance than the
Thing. In this draft version, we are trying to use a new keyword
called sdfContext that is supposed to be slightly more accurate,
replacing the $context concept that was used in previous draft
versions.
2. Instance Information and SDF
The instantiation of an SDF model does not directly express an
instance, which is, for example, a physical device or a digital twin.
Instead, the instantiation produces an instance-related _message_,
which adheres to a uniform message format and is always controlled by
the corresponding SDF model. Depending on the recipient and its
purpose, a message can be interpreted as a report regarding the state
of a Thing or the instruction to change it when consumed by the
recipient.
Taking into account previous revisions of this document as well as
[I-D.ietf-asdf-sdf-nonaffordance], we identified two main dimensions
for covering the potential use cases for instance-related messages:
1. the intended effect of a message, which can either be a report or
an update of a Thing's state, and
2. the actual content of the message, which may be freestanding
(without a reference to a previous message or state) or relative
(with such a reference).
Bormann & Romann Expires 26 June 2026 [Page 6]
Internet-Draft SDF Instance Information December 2025
Based on these considerations (as illustrated by the systematization
in Table 1), we can identify the following four message archetypes:
1. _State reports_ that may contain contain both affordance-related
and context information, including information about a Thing's
identity,
2. _Construction messages_, which trigger a Thing's initial
configuration process or its commissioning,
3. _State report updates_ that indicate changes that have occurred
since a reference state report, and
4. _State patches_ that update the Thing's state.
+=======================+==============================+
| | Content |
+=======================+==============+===============+
| | Freestanding | Relative |
+============+==========+==============+===============+
| (Intended) | State | Status | Status Report |
| Effect | Exposure | Report | Update |
| +==========+--------------+---------------+
| | State | Construction | State Patch |
| | Change | | |
+============+==========+--------------+---------------+
Table 1: Systematization of instance-related
messages along the dimensions "Content" and
"(Intended) Effect".
The uniform message format can be used for all four message
archetypes. Appendix B specifies the formal syntax of instance-
related messages that all normative statements as well as the
examples in this document will adhere to. This syntax can serve to
describe both the abstract structure and the concrete shape of the
messages that can be used as a neutral form in interchange.
In the following, we will first outline a number of general
principles for instance-related messages, before detailing the
specific archetypes we define in this document. The specification
text itself will be accompanied by examples that have been inspired
by [I-D.ietf-asdf-sdf-nonaffordance] and
[I-D.lee-asdf-digital-twin-09] that each correspond with one of the
four archetypes.
Bormann & Romann Expires 26 June 2026 [Page 7]
Internet-Draft SDF Instance Information December 2025
2.1. Axioms for instance-related messages
Instance-related messages can be messages that relate to a property,
action, or event (input or output data), or they can be "proofshots"
(extracted state information, either in general or in a specific form
such as a context snapshot etc.).
Instance-related messages are controlled by a _model_ (class-level
information), which normally is the interaction model of the device.
That interaction model may provide a model of the interaction during
which the instance-related message is interchanged (at least
conceptually), or it may be a "built-in" interaction (such as a
proofshot, a context snapshot, ...) that is implicitly described by
the entirety of the interaction model. This may need to be
augmented/composed in some way, as device modeling may be separate
from e.g. asset management system modeling or digital twin modeling.
Instance-related messages use JSON pointers into the model in order
to link the instance-related information to the model.
Instance-related messages are conceptual and will often be mapped
into ecosystem-specific protocol messages (e.g., a bluetooth
command). It is still useful to be able to represent them in a
neutral ("red-star") format, which we build here as an adaption of
the JSON-based format of the models themselves. An ecosystem might
even decide to use the neutral format as its ecosystem-specific
format (or as an alternative format).
Instance-related messages may be plain messages, or they may be
deltas (from a previous state) and/or patches (leading from a
previous or the current state to a next state). Several media types
can be defined for deltas/patches; JSON merge-patch [RFC7396] is
already in use in SDF (for sdfRef) and therefore is a likely
candidate. (Assume that some of the models will be using Conflict-
free replicated data types (CRDTs) (https://en.wikipedia.org/wiki/
Conflict-free_replicated_data_type) to facilitate patches.)
To identify the reference state for a delta/patch, we need
* device identity (thingId?)
* state info (timestamp? state/generation identifier?)
2.2. Context Information
Messages always have context, typically describing the "me" and the
"you" of the interaction, the "now" and "here", allowing deictic
statements such as "the temperature here" or "my current draw".
Bormann & Romann Expires 26 June 2026 [Page 8]
Internet-Draft SDF Instance Information December 2025
Messages may have to be complemented by this context for
interpretation, i.e., the context needed may need to be reified in
the message (compare the use of SenML "n"). Information that enables
interactions via application-layer protocols (such as an IP address)
can also be considered context information.
For this purpose, we are using the sdfContext keyword introduced by
[I-D.ietf-asdf-sdf-nonaffordance]. Note that sdfContext _could_ also
be modelled via sdfProperty.
TODO: explain how [RFC9039] could be used to obtain device names
(using urn:dev:org in the example).
3. Message Format
The data model of instance-related messages makes use of the
structural features of SDF models (e.g., when it comes to metadata
and namespace information), but is also different in crucial aspects.
TODO: Decide where we want to keep this:
One interesting piece of offDevice information is the model itself,
including information block and the default namespace. This is of
course not about the device or its twin (or even its asset
management), because models and devices may want to associate freely.
Multiple models may apply to the same device (including but not only
revisions of the same models).
3.1. Information Block
The information block contains the same qualities as an SDF model
and, additionally, a mandatory messageId to uniquely identify the
message. Furthermore, "status report update" messages can utilize
the previousMessageId in order to link two messages and indicate the
state change.
Bormann & Romann Expires 26 June 2026 [Page 9]
Internet-Draft SDF Instance Information December 2025
+===================+=========+=================================+
| Quality | Type | Description |
+===================+=========+=================================+
| title | string | A short summary to be displayed |
| | | in search results, etc. |
+-------------------+---------+---------------------------------+
| description | string | Long-form text description (no |
| | | constraints) |
+-------------------+---------+---------------------------------+
| version | string | The incremental version of the |
| | | definition |
+-------------------+---------+---------------------------------+
| modified | string | Time of the latest modification |
+-------------------+---------+---------------------------------+
| copyright | string | Link to text or embedded text |
| | | containing a copyright notice |
+-------------------+---------+---------------------------------+
| license | string | Link to text or embedded text |
| | | containing license terms |
+-------------------+---------+---------------------------------+
| messageId | string | Unique identifier of this |
| | | instance-related message |
+-------------------+---------+---------------------------------+
| previousMessageId | string | Identifier used to connect this |
| | | instance-related message to a |
| | | previous one |
+-------------------+---------+---------------------------------+
| features | array | List of extension features used |
| | of | |
| | strings | |
+-------------------+---------+---------------------------------+
| $comment | string | Source code comments only, no |
| | | semantics |
+-------------------+---------+---------------------------------+
Table 2: Qualities of the Information Block
3.2. Namespaces Block
Similar to SDF models, instance-related messages contain a namespaces
block with a namespace map and the defaultNamespace setting. In
constrast to models, including a namespace quality is mandatory as at
least one namespace reference is needed to be able to refer to the
SDF model the instance-related message corresponds with.
Bormann & Romann Expires 26 June 2026 [Page 10]
Internet-Draft SDF Instance Information December 2025
+==================+========+===================================+
| Quality | Type | Description |
+==================+========+===================================+
| namespace | map | Defines short names mapped to |
| | | namespace URIs, to be used as |
| | | identifier prefixes |
+------------------+--------+-----------------------------------+
| defaultNamespace | string | Identifies one of the prefixes in |
| | | the namespace map to be used as a |
| | | default in resolving identifiers |
+------------------+--------+-----------------------------------+
Table 3: Namespaces Block
3.3. Instance-of Block
Distinct from SDF models are two instance-specific blocks, the first
of which is identified via the sdfInstanceOf keyword. Via the model
keyword, this quality defines the entry point the sdfInstance quality
from the next section is referring to. Furthermore, via the
patchMethod field, a patch algorithm different from JSON Merge Patch
can be specified.
+=============+========+===========================================+
| Quality | Type | Description |
+=============+========+===========================================+
| model | string | Defines the entry point for sdfInstance |
| | | by pointing to an sdfObject or an |
| | | sdfThing. Has to be based on a namespace |
| | | identifier from the namespaces map. |
+-------------+--------+-------------------------------------------+
| patchMethod | string | Allows for overriding the default patch |
| | | method (JSON Merge Patch) by providing a |
| | | registered value. |
+-------------+--------+-------------------------------------------+
| $comment | string | Source code comments only, no semantics |
+-------------+--------+-------------------------------------------+
Table 4: Instance-of Block
3.4. Instance Block
In the instance block, state information for properties, actions, and
events as well as context information can be included. Depending on
the archetype, this information will either be used to report a
Thing's current state, to report state _changes_, or to update state
via a patch or reconfiguration.
Bormann & Romann Expires 26 June 2026 [Page 11]
Internet-Draft SDF Instance Information December 2025
Since we are using the sdfInstance keyword as an entry point at the
location pointed to via the model specfied in sdfInstanceOf, the
instance-related message has to follow the structure of this part of
the model (although, depending on the archetype, information that has
not changed or will not be updated can be left out.)
The alternating structure of the SDF model (e. g.,
sdfObject/envSensor/sdfProperty/temperature) is repeated within the
instance-related message, with the top-level sdfObject or sdfThing
being replaced by sdfInstance at the entry point. Note that we also
have to replicate a nested structure via sdfThing and/or sdfObject if
present in the referenced SDF model.
+=============+======+==================================+
| Quality | Type | Description |
+=============+======+==================================+
| sdfThing | map | Values for the thing entries in |
| | | the referenced SDF definition |
+-------------+------+----------------------------------+
| sdfObject | map | Values for the object entries in |
| | | the referenced SDF definition |
+-------------+------+----------------------------------+
| sdfContext | map | Values for the context entries |
| | | in the referenced SDF definition |
+-------------+------+----------------------------------+
| sdfProperty | map | Values for the properties in the |
| | | referenced SDF definition |
+-------------+------+----------------------------------+
| sdfAction | map | Values for the actions in the |
| | | referenced SDF definition |
+-------------+------+----------------------------------+
| sdfEvent | map | Values for the events in the |
| | | referenced SDF definition |
+-------------+------+----------------------------------+
Table 5: Instance Block
4. Message Archetypes
Based on the common message format defined in Section 3 and the
systematization from Table 1, we can derive a set of four archetypes
that serve different use cases and recipients.
TODO: Decide whether we want to add specific CDDL schemas for the
four archetypes via extension points in the "base schema"
Bormann & Romann Expires 26 June 2026 [Page 12]
Internet-Draft SDF Instance Information December 2025
TODO: The description of the individual messages probably has to be
expanded. Maybe some of the content from the six example messages
should be moved here.
4.1. State Reports
This instance-related message contains information on a Thing's
state, both in terms of context information and the state of
individual affordances. In the message, the previousMessageId field
in the information block MUST NOT be present. Furthermore, when
transmitting this message in its JSON format, the content type
application/sdf-state-report+json MUST be indicated if supported by
the protocol used for transmission.
State reports MAY only contain values for a _subset_ of all possible
affordances and context information exposed by a Thing. Security-
related aspects, e.g. regarding authentication and authorization,
MUST be taken into account when issueing a state report for a
requesting party.
4.2. Construction Messages
(These might not be covered here but via dedicated actions.)
Construction messages are structurally equivalent to state reports,
with the main difference being that the recipient is supposed to
initiate a configuration or comissioning process upon when receiving
it. Furthermore, construction messages MUST be indicated by a
different media type, namely application/sfd-construction+json.
4.3. State Report Updates
State report updates are messages that only describe updates relative
to a previous message. For this purpose, a previousMessageId MUST be
present in the info block. When transmitting state report updates,
the media type application/sdf-state-report-update+json MUST be used
if possible.
By default, the values contained in the message are applied to the
preceding message(s) via the JSON Merge Patch algorithm. Via the
patchMethod quality, different patch algorithms MAY be indicated.
Bormann & Romann Expires 26 June 2026 [Page 13]
Internet-Draft SDF Instance Information December 2025
4.4. State Patches
State patches are structurally equivalent to state report updates.
However, they utilize the patch mechanism (using the provided
patchMethod) to alter the state of a Thing instead of reporting state
changes. Since they are not referring to a preceding message, a
previosMessageId MUST NOT be present in the information block. When
transmitting state patches, the media type application/sdf-state-
patch+json MUST be used if possible.
5. Message Purposes and Usecases
The four archetypes can be further subdivided into (at least) six
kinds of messages that all deal with different use cases. While the
archetypes each have their own media type that can be used to
identity them during a message exchange, the six concete messages in
this section are may only be identified by their content.
TODO: Consider only describing the different kinds of state reports
State Reports can be used as
* _Context snapshots_ that only report context information about a
Thing,
* _Proofshots_ that report a Thing's state (or parts of it), which
may include context information, or
* _Identity manifests_ that report information related to a Thing's
identity.
In the case of state report updates, we have _Deltas_ that indicate
state changes compared to a previous context snapshot, proofshot
message, or identity manifest.
State patches can appear as _Patch messages_ that indicate state
changes that should be _applied_ to a Thing.
And finally, we have the _Construction Messages_ that initiate a
Thing's (re)configuration or its comissioning
As we can see, the great amount of variation within the state report
archetype in the case of messages 1 to 3 comes from the different
kinds and the characteristic of the information that is the reported
in the eventual message. However, the message format stays identical
across the three manifestations of the archetype.
Bormann & Romann Expires 26 June 2026 [Page 14]
Internet-Draft SDF Instance Information December 2025
In the remainder of this section, we will discuss the differences of
these three messages in particular and will also deal with the
potential modelling of construction messages.
5.1. Context Snapshots
Context snapshots are state reports that only include context
information via the sdfContext keyword.
Figure 1 gives an example for this kind of instance-related message
by showing a status report message that only contains context
information.
{
"info": {
"messageId": "75532020-8f64-4daf-a241-fcb0b6dc4a42"
},
"namespace": {
"models": "https://example.com/models",
"sensors": "https://example.com/sensors"
},
"defaultNamespace": "models",
"sdfInstanceOf": {
"model": "sensors:#/sdfObject/envSensor"
},
"sdfInstance": {
"sdfContext": {
"timestamp": "2025-07-01T12:00:00Z",
"thingId": "envSensor:abc123",
"installationInfo": {
"floor": 3,
"mountType": "ceiling",
"indoorOutdoor": "indoor"
}
}
}
}
Figure 1: Example of an SDF context snapshot.
This kind of message may become especially relevant later in
conjunction with the sdfProtocolMap introduced in
[I-D.ietf-asdf-sdf-protocol-mapping] for complementing protocol-
specific information at the model-level with instance-related context
information such as IP addresses.
Bormann & Romann Expires 26 June 2026 [Page 15]
Internet-Draft SDF Instance Information December 2025
5.2. Proofshots
(See defn above.)
Proofshots are similar to context snapshots, with the important
difference that they are not only reporting the context information
associated with an entity but also state information associated with
its interaction affordances (properties, actions, and events). As in
the case of the Context Snapshot, the Proofshot may also contain
concrete values that reflect context information associated with a
device via the sdfContext keyword [I-D.ietf-asdf-sdf-nonaffordance].
TODO: Note that while the format for describing the state of
properties is clearly governed by the schema information from the
corresponding sdfProperty definition, it is still unclear how to best
model the state of sdfActions and sdfEvents.
The following examples are based on [I-D.ietf-asdf-sdf-nonaffordance]
and [I-D.lee-asdf-digital-twin-09]. Figure 2 shows a proofshot that
captures the state of a sensor. Here, every property and context
definition of the corresponding SDF model (see Figure 10) is mapped
to a concrete value that satisfies the associated schema.
{
"info": {
"messageId": "75532020-8f64-4daf-a241-fcb0b6dc4a42"
},
"namespace": {
"models": "https://example.com/models",
"sensors": "https://example.com/sensor"
},
"defaultNamespace": "models",
"sdfInstanceOf": {
"model": "sensors:#/sdfObject/envSensor"
},
"sdfInstance": {
"sdfContext": {
"timestamp": "2025-07-01T12:00:00Z",
"thingId": "envSensor:abc123",
"installationInfo": {
"mountType": "ceiling"
}
},
"sdfProperty": {
"temperature": 23.124
}
}
}
Bormann & Romann Expires 26 June 2026 [Page 16]
Internet-Draft SDF Instance Information December 2025
Figure 2: SDF proofshot example.
5.3. Construction Messages
Construction messages enable the creation of the digital instance,
e.g., initialization/commissioning of a device or creation of its
digital twins. Construction messages are like proofshots, in that
they embody a state, however this state needs to be precise so the
construction can actually happen.
A construction message for a temperature sensor might assign an
identity and/or complement it by temporary identity information
(e.g., an IP address); its processing might also generate
construction output (e.g., a public key or an IP address if those are
generated on device). This output -- which can once again be modeled
as an instance-related message -- may be referred to as an _identity
manifest_ when it primarily contains identity-related context
information.
Construction messages need to refer to some kind of constructor in
order to be able to start the actual construction process. In
practice, these constructors are going to be modeled as an sdfAction,
although the way the sdfAction is going to be used exactly is not
entirely clear yet. As the device that is being constructed will not
be initialized before the construction has finished, the sdfAction
has to be modeled as an external or "off-device" action. This raises
the question whether the sdfAction still belongs into the SDF model
that corresponds with the class the resulting device instance belongs
to.
(Note that it is not quite clear what a destructor would be for a
physical instance -- apart from a scrap metal press, but according to
RFC 8576 we would want to move a system to a re-usable initial state,
which is pretty much a constructor.)
Figure 3 shows a potential SDF construction message that initializes
a device, setting its manufacturer and firmwareVersion as context
information.
Bormann & Romann Expires 26 June 2026 [Page 17]
Internet-Draft SDF Instance Information December 2025
{
"info": {
"messageId": "75532020-8f64-4daf-a241-fcb0b6dc4a42"
},
"namespace": {
"models": "https://example.com/models",
"sensors": "https://example.com/sensor"
},
"defaultNamespace": "models",
"sdfInstanceOf": {
"model": "sensors:#/sdfObject/envSensor"
},
"sdfInstance": {
"sdfContext": {
"timestamp": "2025-07-01T08:15:00Z",
"thingId": "envSensor:unit42",
"deviceIdentity": {
"manufacturer": "HealthTech Inc.",
"firmwareVersion": "1.4.3"
}
}
}
}
Figure 3: Example for an SDF construction message
5.4. Delta Messages
TODO: Reword
When the state of a device at a given point in time is known (e.g.,
due to a previous instance-related message), an external entity might
only be interested in the changes since that point in time. Or it
might want to adjust its state and/or context the device operates in.
For both purposes, instance-related messages can be used.
Figure 4 shows an example that contains an instance-related message
reporting a "proofshot delta", that is the state changes that occured
compared to the ones reported in the previous message (identified via
its previousMessageId). In this example, only the temperature as
measured by the sensor has changed, so only that information is
included.
Delta messages could be used in the Series Transfer Pattern [STP],
which may be one way to model a telemetry stream from a device.
Bormann & Romann Expires 26 June 2026 [Page 18]
Internet-Draft SDF Instance Information December 2025
{
"info": {
"title": "Example SDF delta message",
"previousMessageId": "026c1f58-7bb9-4927-81cf-1ca0c25a857b",
"messageId": "75532020-8f64-4daf-a241-fcb0b6dc4a42"
},
"namespace": {
"cap": "https://example.com/capability/cap",
"models": "https://example.com/models"
},
"defaultNamespace": "cap",
"sdfInstanceOf": {
"model": "models:/sdfObject/envSensor"
},
"sdfInstance": {
"sdfProperty": {
"temperature": 24
}
}
}
Figure 4: Example of an SDF instance-related message that serves
as a delta.
5.5. Patch Messages
Yet another purpose for instance-related messages is the application
of updates to a device's configuration via a so-called patch message.
Such a message is shown in Figure 5, where a change of the device's
mountType is reflected. This message type might be especially
relevant for digital twins [I-D.lee-asdf-digital-twin-09], where
changes to physical attributes (such as the location) need to be
reflected somehow.
Bormann & Romann Expires 26 June 2026 [Page 19]
Internet-Draft SDF Instance Information December 2025
{
"info": {
"messageId": "75532020-8f64-4daf-a241-fcb0b6dc4a42"
},
"namespace": {
"models": "https://example.com/models",
"sensors": "https://example.com/sensor"
},
"defaultNamespace": "models",
"sdfInstanceOf": {
"model": "sensors:#/sdfObject/envSensor",
"patchMethod": "merge-patch"
},
"sdfInstance": {
"sdfContext": {
"installationInfo": {
"mountType": "wall"
}
}
}
}
Figure 5: Example of an SDF context patch message that uses the
common instance-related message format.
TODO: Maybe the following can be shortened or even removed
When comparing Figure 4 and Figure 5, we can see that the main
difference between the messages is the _purpose_ these message are
being used for. This purpose could be implicitly reflected by the
nature of the resource that accepts or returns the respective message
type. It would also be possible to indicate the purpose more
explicitly by using a different content format when transferring the
messages over the wire. Another difference, however, lays in the
fact that the context patch is not including a previousMessageId,
which might be sufficient to distinguish the two message types.
Despite their different purpose, both messages will apply some kind
of patch algorithm. JSON Merge Patch [RFC7396] is probably a strong
contender for the default algorithm that will be used a little bit
differently depending on the message type (the context patch will be
applied "internally" by the device, while the delta message will be
processed together with its predecessor by a consumer). As there
might be cases where the Merge Patch algorithm is not sufficient,
different algorithms (that can be IANA registered) are going to be
settable via the patchMethod field within the sdfInstanceOf quality.
Bormann & Romann Expires 26 June 2026 [Page 20]
Internet-Draft SDF Instance Information December 2025
5.6. Identity Manifest
Identity manifests belong like proofshots and context snapshots to
the Status Report archetype. However, their use case is tied more
strongly to identity information which may be modeled as context
information.
Figure 6 shows an example of an identity manifest, that is
structurally identical to the construction message shown in Figure 3.
What makes qualifies the message as an identity manifest is its media
type, which differs from the construction message, as well as the
circumstances under which the message might be emitted -- for
instance, as the _result_ of a construction.
{
"info": {
"messageId": "75532020-8f64-4daf-a241-fcb0b6dc4a42"
},
"namespace": {
"models": "https://example.com/models",
"sensors": "https://example.com/sensor"
},
"defaultNamespace": "models",
"sdfInstanceOf": {
"model": "sensors:#/sdfObject/envSensor"
},
"sdfInstance": {
"sdfContext": {
"timestamp": "2025-07-01T08:15:00Z",
"thingId": "envSensor:unit42",
"deviceIdentity": {
"manufacturer": "HealthTech Inc.",
"firmwareVersion": "1.4.3"
}
}
}
}
Figure 6: Example for an SDF construction message
6. Linking sdfProtocolMap and sdfContext via JSON Pointers
(This section is currently still experimental.)
When using the sdfProtocolMap concept introduced in
[I-D.ietf-asdf-sdf-protocol-mapping], some protocols may need context
information such as a hostname or an IP address to actually be usable
for interactions. This corresponds with the fact that the parameters
Bormann & Romann Expires 26 June 2026 [Page 21]
Internet-Draft SDF Instance Information December 2025
related to application-layer protocols are often _class-level_
information and therefore not necessarily instance-specific: All
instances of a smart light may use similar CoAP resources, with the
only difference being the concrete IP address they are using.
Therefore, we can utilize context information that varies between
instances to complement the model information provided via an
sdfProtocolMap.
Figure 7 illustrates the potential relationship between the two
concepts in an SDF model. A (hypothetical) CoAP protocol mapping
specification could define an interface for parameters such as an IP
address. Via a contextMap (this name is still under discussion), the
sdfProtocolMapping definition within a model could point (via a JSON
pointer) to a compatible sdfContext definition that may further
restrict the set of allowed values via its schema.
Bormann & Romann Expires 26 June 2026 [Page 22]
Internet-Draft SDF Instance Information December 2025
=============== NOTE: '\' line wrapping per RFC 8792 ================
{
"namespace": {
"models": "https://example.com/models",
"sensors": "https://example.com/sensor"
},
"defaultNamespace": "models",
"sdfObject": {
"sensor": {
"sdfContext": {
"ipAddress": {
"type": "string"
}
},
"sdfProperty": {
"temperature": {
"type": "number",
"sdfProtocolMap": {
"coap": {
"contextMap": {
"ipAddress": "#/sdfObject/sensor/sdfContext/\
ipAddress"
},
"read": {
"method": "GET",
"href": "/temperature",
"contentType": 60
}
}
}
}
}
}
}
}
Figure 7: Example of an SDF model where a CoAP-based protocol map
points to the definition of relevant context information: an IP
address.
Figure 8 shows how a status report (in the "old" terminology, the
message would be called a context snapshot) can provide the necessary
IP address that is needed to actually retrieve the temperature value
from the sensor described by the SDF model above.
Bormann & Romann Expires 26 June 2026 [Page 23]
Internet-Draft SDF Instance Information December 2025
{
"info": {
"messageId": "75532020-8f64-4daf-a241-fcb0b6dc4a47"
},
"namespace": {
"models": "https://example.com/models",
"sensors": "https://example.com/sensor"
},
"defaultNamespace": "models",
"sdfInstanceOf": {
"model": "sensors:#/sdfObject/sensor"
},
"sdfInstance": {
"sdfContext": {
"ipAddress": "192.168.1.5"
}
}
}
Figure 8: Example of a status report message that provides the IP
address needed to perform a CoAP-based interaction with the
sensor from the previous figure.
This approach can become very verbose in a nested model and may need
refinement in future draft revisions. The general principle,
however, is promising as it follows the principle of cleanly
separating class from instance-related information.
7. Examples for SDF Constructors
TODO: This section needs to be updated/reworked/removed
Figure 9 shows a potential approach for describing constructors via
the sdfAction keyword with a set of construction parameters contained
in its sdfInputData.
As the constructor action is modeled as being detached from the
device and performed by an external constructor in this example, both
the resulting model and the initial instance description (which can
be considered an identity manifest) are returned. The schema
information that governs the shape of both the model and the instance
message are referred to via the sdfRef keyword.
DISCUSS: Note that the action may also return a pointer to an
external SDF model and provide the additional information from the
constructor via an SDF Mapping File. These are aspects that still
require discussion, examples, and implementation experience.
Bormann & Romann Expires 26 June 2026 [Page 24]
Internet-Draft SDF Instance Information December 2025
=============== NOTE: '\' line wrapping per RFC 8792 ================
{
"info": {
"title": "Example document for SDF with actions as constructors \
for instantiation",
"version": "2019-04-24",
"copyright": "Copyright 2019 Example Corp. All rights reserved.",
"license": "https://example.com/license"
},
"namespace": {
"sdf": "https://example.com/common/sdf/definitions",
"cap": "https://example.com/capability/cap"
},
"defaultNamespace": "cap",
"sdfObject": {
"constructor": {
"sdfAction": {
"construct": {
"sdfInputData": {
"$comment": "DISCUSS: Do we need to establish a \
connection between constructor parameters and the resulting instance\
-related message?",
"type": "object",
"properties": {
"temperatureUnit": {
"type": "string"
},
"ipAddress": {
"type": "string"
}
},
"required": [
"temperatureUnit"
]
},
"sdfOutputData": {
"$comment": "Would we point to the JSON Schema \
definitions here?",
"type": "object",
"properties": {
"model": {
"type": "object",
"properties": {
"sdfRef": "sdf:#/sdf/model/format"
}
},
"instance": {
Bormann & Romann Expires 26 June 2026 [Page 25]
Internet-Draft SDF Instance Information December 2025
"type": "object",
"properties": {
"sdfRef": "sdf:#/instance/message/format"
}
}
}
}
}
}
}
}
}
Figure 9: Example for SDF model with constructors
8. Discussion
(TODO)
9. Security Considerations
* Pieces of instance-related information might only be available in
certain scopes, e.g. certain security-related configuration
parameters
(TODO)
10. IANA Considerations
TODO: Add media type registrations
11. References
11.1. Normative References
[BCP14] Best Current Practice 14,
<https://www.rfc-editor.org/info/bcp14>.
At the time of writing, this BCP comprises the following:
Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
Bormann & Romann Expires 26 June 2026 [Page 26]
Internet-Draft SDF Instance Information December 2025
[I-D.ietf-asdf-sdf]
Koster, M., Bormann, C., and A. Keränen, "Semantic
Definition Format (SDF) for Data and Interactions of
Things", Work in Progress, Internet-Draft, draft-ietf-
asdf-sdf-25, 13 October 2025,
<https://datatracker.ietf.org/doc/html/draft-ietf-asdf-
sdf-25>.
[I-D.ietf-asdf-sdf-nonaffordance]
Hong, J. and H. Lee, "Semantic Definition Format (SDF)
Extension for Non-Affordance Information", Work in
Progress, Internet-Draft, draft-ietf-asdf-sdf-
nonaffordance-02, 20 October 2025,
<https://datatracker.ietf.org/doc/html/draft-ietf-asdf-
sdf-nonaffordance-02>.
[RFC8288] Nottingham, M., "Web Linking", RFC 8288,
DOI 10.17487/RFC8288, October 2017,
<https://www.rfc-editor.org/rfc/rfc8288>.
[STD97] Internet Standard 97,
<https://www.rfc-editor.org/info/std97>.
At the time of writing, this STD comprises the following:
Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke,
Ed., "HTTP Semantics", STD 97, RFC 9110,
DOI 10.17487/RFC9110, June 2022,
<https://www.rfc-editor.org/info/rfc9110>.
11.2. Informative References
[I-D.amsuess-t2trg-raytime]
Amsüss, C., "Raytime: Validating token expiry on an
unbounded local time interval", Work in Progress,
Internet-Draft, draft-amsuess-t2trg-raytime-03, 19 October
2024, <https://datatracker.ietf.org/doc/html/draft-
amsuess-t2trg-raytime-03>.
[I-D.bormann-asdf-sdf-mapping]
Bormann, C. and J. Romann, "Semantic Definition Format
(SDF): Mapping files", Work in Progress, Internet-Draft,
draft-bormann-asdf-sdf-mapping-07, 20 July 2025,
<https://datatracker.ietf.org/doc/html/draft-bormann-asdf-
sdf-mapping-07>.
[I-D.ietf-asdf-sdf-protocol-mapping]
Mohan, R., Brinckman, B., and L. Corneo, "Protocol Mapping
for SDF", Work in Progress, Internet-Draft, draft-ietf-
Bormann & Romann Expires 26 June 2026 [Page 27]
Internet-Draft SDF Instance Information December 2025
asdf-sdf-protocol-mapping-02, 2 December 2025,
<https://datatracker.ietf.org/doc/html/draft-ietf-asdf-
sdf-protocol-mapping-02>.
[I-D.ietf-iotops-7228bis]
Bormann, C., Ersue, M., Keränen, A., and C. Gomez,
"Terminology for Constrained-Node Networks", Work in
Progress, Internet-Draft, draft-ietf-iotops-7228bis-03, 4
November 2025, <https://datatracker.ietf.org/doc/html/
draft-ietf-iotops-7228bis-03>.
[I-D.lee-asdf-digital-twin-09]
Lee, H., Hong, J., Youn, J., and Y. Hong, "Semantic
Definition Format (SDF) modeling for Digital Twin", Work
in Progress, Internet-Draft, draft-lee-asdf-digital-twin-
09, 4 July 2025, <https://datatracker.ietf.org/doc/html/
draft-lee-asdf-digital-twin-09>.
[LAYERS] "Terminology for Layers", WISHI Wiki,
<https://github.com/t2trg/wishi/wiki/NOTE:-Terminology-
for-Layers>.
[REST] Fielding, R., "Architectural Styles and the Design of
Network-based Software Architectures", Ph.D. Dissertation,
University of California, Irvine, 2000,
<http://www.ics.uci.edu/~fielding/pubs/dissertation/
fielding_dissertation.pdf>.
[RFC6690] Shelby, Z., "Constrained RESTful Environments (CoRE) Link
Format", RFC 6690, DOI 10.17487/RFC6690, August 2012,
<https://www.rfc-editor.org/rfc/rfc6690>.
[RFC7396] Hoffman, P. and J. Snell, "JSON Merge Patch", RFC 7396,
DOI 10.17487/RFC7396, October 2014,
<https://www.rfc-editor.org/rfc/rfc7396>.
[RFC9039] Arkko, J., Jennings, C., and Z. Shelby, "Uniform Resource
Names for Device Identifiers", RFC 9039,
DOI 10.17487/RFC9039, June 2021,
<https://www.rfc-editor.org/rfc/rfc9039>.
[STP] Bormann, C. and K. Hartke, "The Series Transfer Pattern
(STP)", Work in Progress, Internet-Draft, draft-bormann-
t2trg-stp-03, 7 April 2020,
<https://datatracker.ietf.org/doc/html/draft-bormann-
t2trg-stp-03>.
Bormann & Romann Expires 26 June 2026 [Page 28]
Internet-Draft SDF Instance Information December 2025
Appendix A. Example SDF Model
Figure 10 shows the model all of the examples for instance-related
messages are pointing to in this document. Note how the namespace is
managed here to export the envSensor component into
models:#/sdfObject/envSensor, which is the "entry point" used in the
instance messages within the main document.
Bormann & Romann Expires 26 June 2026 [Page 29]
Internet-Draft SDF Instance Information December 2025
{
"namespace": {
"models": "https://example.com/models",
"sensors": "https://example.com/sensors"
},
"defaultNamespace": "models",
"sdfObject": {
"envSensor": {
"sdfContext": {
"timestamp": {
"type": "string"
},
"thingId": {
"type": "string"
},
"deviceIdentity": {
"manufacturer": {
"type": "string"
},
"firmwareVersion": {
"type": "string"
}
},
"installationInfo": {
"type": "object",
"properties": {
"floor": {
"type": "integer"
},
"mountType": {
"enum": [
"ceiling",
"wall"
]
}
}
}
},
"sdfProperty": {
"temperature": {
"type": "number",
"unit": "Cel"
}
}
}
}
}
Bormann & Romann Expires 26 June 2026 [Page 30]
Internet-Draft SDF Instance Information December 2025
Figure 10: SDF Model that serves as a reference point for the
instance-related messages in this draft
Appendix B. Formal Syntax of Instance-related Messages
start = sdf-instance-message-syntax
sdf-instance-message-syntax = {
; info will be required in most process policies
? info: sdfinfo
namespace: named<text>
? defaultNamespace: text
? sdfInstanceOf: sdf-instance-of
? sdfInstance: sdf-instance
}
sdfinfo = {
? title: text
? description: text
? version: text
? copyright: text
? license: text
? messageId: text
; Identifier used to connect this instance message to a previous
; one:
; Allows this instance message to only contain values that have
; actually changed, turning it into a "Delta" or a "Patch",
; depending on the purpose of the message.
? previousMessageId: text
? modified: modified-date-time
? features: [
]
optional-comment
}
sdf-instance-of = {
model: text
? patchMethod: text ; default is merge-patch
optional-comment
}
optional-comment = (
? $comment: text ; source code comments only, no semantics
)
; Shortcut for a map that gives names to instances of X
; (has keys of type text and values of type X)
named<X> = { * text => X }
Bormann & Romann Expires 26 June 2026 [Page 31]
Internet-Draft SDF Instance Information December 2025
commonqualities = (
optional-comment
)
; For describing the state of instances at a given point in time
;
; An sdfInstance can refer to either an sdfThing or an sdfObject.
; Structurally, it is equivalent to that of an sdfThing.
sdf-instance = thingqualities
objectqualities = {
commonqualities
cpaedataqualities
}
thingqualities = {
sdfThing: named<thingqualities>
sdfObject: named<objectqualities>
commonqualities
cpaedataqualities
}
cpaedataqualities = (
? sdfContext: named<allowed-types>
; Models the current state of the instance's properties
? sdfProperty: named<allowed-types>
; Models the current state of the instance's action affordances
;
; DISCUSS: How should the state of actions be modeled?
? sdfAction: named<any>
; Models an history for every event affordance
? sdfEvent: named<eventhistory>
)
eventhistory = [* eventqualities]
eventqualities = {
outputValue: allowed-types
timestamp: modified-date-time
}
Bormann & Romann Expires 26 June 2026 [Page 32]
Internet-Draft SDF Instance Information December 2025
allowed-types = number / text / bool / null
/ [* number] / [* text] / [* bool]
/ {* text => any}
modified-date-time = text .abnf modified-dt-abnf
modified-dt-abnf = "modified-dt" .det rfc3339z
; RFC 3339 sans time-numoffset, slightly condensed
rfc3339z = '
date-fullyear = 4DIGIT
date-month = 2DIGIT ; 01-12
date-mday = 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on
; month/year
time-hour = 2DIGIT ; 00-23
time-minute = 2DIGIT ; 00-59
time-second = 2DIGIT ; 00-58, 00-59, 00-60 based on leap sec
; rules
time-secfrac = "." 1*DIGIT
DIGIT = %x30-39 ; 0-9
partial-time = time-hour ":" time-minute ":" time-second
[time-secfrac]
full-date = date-fullyear "-" date-month "-" date-mday
modified-dt = full-date ["T" partial-time "Z"]
'
Appendix C. Roads Not Taken
This appendix documents previous modelling approaches that we
eventually decided against pursuing further. Its main purpose is to
illustrate our development process, showing which kind of
alternatives we considered before choosing a particular way to
describe instance information. We will remove this appendix as soon
as this document is about to be finished.
C.1. Using SDF Models as Proofshots
As shown in Figure 11, the proofshot format could have also been
modeled via SDF models where all sdfProperty definitions are given
constvalues. However, this concept is not capable of capturing
actions and events.
Bormann & Romann Expires 26 June 2026 [Page 33]
Internet-Draft SDF Instance Information December 2025
=============== NOTE: '\' line wrapping per RFC 8792 ================
{
"info": {
"title": "An example model of the heater #1 in the boat #007 (\
that resembles a proofshot)",
"version": "2025-07-15",
"copyright": "Copyright 2025. All rights reserved."
},
"namespace": {
"models": "https://example.com/models"
},
"defaultNamespace": "models",
"sdfThing": {
"boat007": {
"label": "Digital Twin of Boat #007",
"description": "A ship equipped with heating and navigation \
systems",
"sdfContext": {
"scimObjectId": {
"type": "string"
},
"identifier": {
"type": "string",
"const": "urn:boat:007:heater:1"
},
"location": {
"type": "object",
"const": {
"wgs84": {
"latitude": 35.2988233791372,
"longitude": 129.25478376484912,
"altitude": 0.0
},
"postal": {
"city": "Ulsan",
"post-code": "44110",
"country": "South Korea"
},
"w3w": {
"what3words": "toggle.mopped.garages"
}
}
},
"owner": {
"type": "string",
"default": "ExamTech Ltd.",
"const": "ExamTech Ltd."
Bormann & Romann Expires 26 June 2026 [Page 34]
Internet-Draft SDF Instance Information December 2025
}
},
"sdfRequired": "#/sdfThing/boat007/sdfObject/heater1",
"sdfObject": {
"heater": {
"label": "Cabin Heater",
"description": "Temperature control system for cabin \
heating",
"sdfProperty": {
"characteristic": {
"description": "Technical summary of the heater",
"type": "string",
"default": "12V electric heater, 800W, automatic \
cutoff",
"const": "12V electric heater, 800W, automatic cutoff"
},
"status": {
"description": "Current operational status",
"type": "string",
"enum": [
true,
false,
"error"
],
"default": false,
"const": false
},
"report": {
"type": "string",
"const": "On February 24, 2025, the boat #007's \
heater #1 was on from 9 a.m. to 6 p.m."
}
},
"sdfEvent": {
"overheating": {
"$comment": "Note that it is unclear how to properly \
model events or event history with the approach illustrated by this \
example.",
"maintenanceSchedule": "Next scheduled maintenance \
date",
"sdfOutputData": {
"type": "string",
"format": "date-time",
"const": "2025-07-15T07:27:15+0000"
}
}
}
}
Bormann & Romann Expires 26 June 2026 [Page 35]
Internet-Draft SDF Instance Information December 2025
}
}
}
}
Figure 11: SDF instance proposal for Figure 2 in [I-D.lee-asdf-
digital-twin-09]
C.1.1. Alternative Instance Keys
Below you can see an alternative instance modelling approach with IDs
as (part of the) instance keys.
=============== NOTE: '\' line wrapping per RFC 8792 ================
{
"info": {
"title": "A proofshot example for heater #1 on boat #007",
"version": "2025-07-15",
"copyright": "Copyright 2025. All rights reserved.",
"proofshotId": "026c1f58-7bb9-4927-81cf-1ca0c25a857b"
},
"namespace": {
"models": "https://example.com/models",
"boats": "https://example.com/boats"
},
"defaultNamespace": "boats",
"sdfInstance": {
"models:#/sdfThing/boat/007": {
"sdfInstanceOf": "models:#/sdfThing/boat",
"heater": "models:#/sdfThing/boat/sdfObject/heater/001",
"scimObjectId": "a2e06d16-df2c-4618-aacd-490985a3f763",
"identifier": "urn:boat:007:heater:1",
"location": {
"wgs84": {
"latitude": 35.2988233791372,
"longitude": 129.25478376484912,
"altitude": 0
},
"postal": {
"city": "Ulsan",
"post-code": "44110",
"country": "South Korea"
},
"w3w": {
"what3words": "toggle.mopped.garages"
}
},
Bormann & Romann Expires 26 June 2026 [Page 36]
Internet-Draft SDF Instance Information December 2025
"owner": "ExamTech Ltd."
},
"models:#/sdfThing/boat/sdfObject/heater/001": {
"characteristic": "12V electric heater, 800W, automatic cutoff\
",
"status": "error",
"report": "On February 24, 2025, the boat #007's heater #1 \
was on from 9 a.m. to 6 p.m.",
"sdfEvent": {
"maintenanceSchedule": [
{
"outputValue": "2025-04-10",
"timestamp": "2024-04-10T02:00:00Z"
},
{
"outputValue": "2026-04-10",
"timestamp": "2025-04-10T02:00:00Z"
}
]
}
}
}
}
Figure 12: SDF instance proposal (with IDs as part of the
instance keys) for Figure 2 in [I-D.lee-asdf-digital-twin-09]
Acknowledgments
(TODO)
Authors' Addresses
Carsten Bormann
Universität Bremen TZI
Postfach 330440
D-28359 Bremen
Germany
Phone: +49-421-218-63921
Email: cabo@tzi.org
Jan Romann
Universität Bremen
Germany
Email: jan.romann@uni-bremen.de
Bormann & Romann Expires 26 June 2026 [Page 37]