WoT

Retrieve WoT Thing Directory

GET
https://ditto.eclipseprojects.io/.well-known/wot

Returns a WoT (Web of Things) Thing Description of the Ditto Thing Directory, as specified by the WoT Discovery specification.

By default, this endpoint is publicly accessible without authentication. This can be configured via the GATEWAY_WOT_DIRECTORY_AUTHENTICATION_REQUIRED environment variable.

Both GET and HEAD methods are supported per the WoT Discovery specification.

Response

200OKWotThingDescription

The WoT Thing Directory description was successfully retrieved.

Response fields application/td+json

A WoT Thing Description version 1.1

@contextArray<string> | stringrequired
Show child attributes
One of
Array<string>https://www.w3.org/2019/wot/td/v1http://www.w3.org/ns/tdhttps://www.w3.org/2022/wot/td/v1.1
stringhttps://www.w3.org/2019/wot/td/v1http://www.w3.org/ns/tdhttps://www.w3.org/2022/wot/td/v1.1
Example
[
  "https://www.w3.org/2022/wot/td/v1.1"
]
titlestringrequired
Example
My fancy Thing
titlesobject
Show child attributes
[key: string]string
descriptionstring
Example
Does fancy stuff with IoT
descriptionsobject
Show child attributes
[key: string]string
@typestring | Array<string>
Show child attributes
One of
string
Array<string>
Example
Thing
idstring
Example
urn:org.eclipse.ditto:my-fancy-thing
basestring<iri-reference>
Example
https://ditto.eclipseprojects.io/api/2/org.eclipse.ditto:my-fancy-thing
versionobject
Show child attributes
modelstring
instancestringrequired
Example
{
  "model": "1.0.0",
  "instance": "1.0.0"
}
securitystring | Array<string>required
Show child attributes
One of
string
Array<string>
Example
basic_sc
securityDefinitionsobjectrequired
Show child attributes
[key: string]object
Example
{
  "basic_sc": {
    "in": "header",
    "scheme": "basic"
  }
}
supportstring<iri-reference>
Example
https://www.eclipse.dev/ditto/
createdstring<date-time>
modifiedstring<date-time>
formsArray<object>
Show child attributes
opstring
hrefstring
htv:methodNamestring
contentTypestring
additionalResponsesArray<object>
Show child attributes
successboolean
schemastring
propertiesobject
Show child attributes
[key: string]object
actionsobject
Show child attributes
[key: string]object
eventsobject
Show child attributes
[key: string]object
uriVariablesobject
Show child attributes
[key: string]object
schemaDefinitionsobject
Show child attributes
[key: string]object
profileArray<string> | string
Show child attributes
One of
Array<string>
string<iri-reference>
401UnauthorizedAdvancedError

The request could not be completed due to missing authentication (when authentication is required).

Response fields application/json
statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

Authorization

OpenIDConnectopenIdConnect

OpenID Connect Discovery URL. The placeholder is replaced by Swagger UI when configured.

NginxBasichttp (basic)

Eclipse Ditto sandbox demo user (demo1 ... demo9) + password (demo)

Bearerhttp (bearer)

A JSON Web Token issued by a supported OAuth 2.0 Identity Provider.

Docs by Sourcey
↑↓ navigate↵ selectesc close