All topics contain the <channel> which may be either twin or live.
For the meaning of those two channels see Protocol specification.
Delete a Thing
Deletes the Thing identified by the <namespace> and <thingId> in the topic.
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | / |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | / |
|
| status | code | |
204 |
Success - the Thing was deleted successfully. | |
403 |
Not Deletable - the Thing could not be deleted. | |
404 |
Not Found - the Thing was not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after a thing was deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | / |
Example: Delete a Thing
Delete all Attributes of a Thing
Deletes all Attributes of a Thing identified by the <namespace> and <thingId> in the topic.
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | /attributes |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | /attributes |
|
| status | code | |
204 |
Success - Attributes were deleted successfully. | |
403 |
Not Modifiable - The Attributes could not be deleted as the requester had insufficient permissions (‘WRITE’ is required). | |
404 |
Not Found - The Thing or Attributes were not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after the attributes of a thing were deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | /attributes |
Example: Delete Attributes
Delete a single Attribute of a Thing
Delete a specific Attribute identified by the <attributePath> of the Thing.
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | /attributes/<attributePath> |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | /attributes/<attributePath> |
|
| status | code | |
204 |
Success - The Attribute was deleted successfully. | |
403 |
Not Modifiable - The Attribute could not be deleted as the requester had insufficient permissions (‘WRITE’ is required). | |
404 |
Not Found - The Thing or Attribute was not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after the Attribute of a thing was deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | /attributes/<attributePath> |
Example: Delete a single Attribute
Delete the definition of a Thing
Delete the definition of the Thing.
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | /definition |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | /definition |
|
| status | code | |
204 |
Success - The definition was deleted successfully. | |
403 |
Not Modifiable - The definition could not be deleted as the requester had insufficient permissions (‘WRITE’ is required). | |
404 |
Not Found - The Thing or definition was not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after the definition of a thing was deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | /definition |
Example: Delete a single definition
Delete all Features of a Thing
Delete all Features of a Thing identified by identified by the <namespace> and the <thingId> in the topic.
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | /features |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | /features |
|
| status | code | |
204 |
Success - The Features were deleted successfully. | |
403 |
Not Modifiable - The Features could not be deleted as the requester had insufficient permissions (‘WRITE’ is required). | |
404 |
Not Found - The Thing or Features were not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after the Features of a Thing were deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | /features |
Example: Delete Features
Delete single Feature of a Thing
Delete a specific Feature (identified by the <featureId> in the path) of a Thing.
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | /features/<featureId> |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | /features/<featureId> |
|
| status | code | |
204 |
Success - the Feature was deleted successfully. | |
403 |
Not Modifiable - The Feature could not be deleted as the requester had insufficient permissions (‘WRITE’ is required). | |
404 |
Not Found - The Thing or Feature was not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after a Feature of a Thing was deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | /features/<featureId> |
Example: Delete a single Feature
Delete Definition of a Feature
Delete the Definition of a Feature (identified by the <featureId> in the path) of the Thing
(identified by the <namespace> and the <thingId> in the topic).
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | /features/<featureId>/definition |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | /features/<featureId>/definition |
|
| status | code | |
204 |
Success - the Definition was deleted successfully. | |
403 |
Not Modifiable - The Definition could not be deleted as the requester had insufficient permissions (‘WRITE’ is required). | |
404 |
Not Found - The Thing, Feature or Definition was not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after the Feature Definition of a Thing was deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | /features/<featureId>/definition |
Example: Delete Feature Definition
Delete all Properties of a Feature
Delete all Properties of a Feature (identified by the <featureId> in the path) of the Thing
(identified by the <namespace> and the <thingId> in the topic).
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | /features/<featureId>/properties |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | /features/<featureId>/properties |
|
| status | code | |
204 |
Success - the Properties were deleted successfully. | |
403 |
Not Modifiable - The Properties could not be deleted as the requester had insufficient permissions (‘WRITE’ is required). | |
404 |
Not Found - The Properties were not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after the Feature Properties of a Thing were deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | /features/<featureId>/properties |
Example: Delete Feature Properties
Delete a single Property of a Feature
Delete a specific Property (identified by <propertyPath>) of a Feature (identified by the <featureId> in the path).
Command
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
| path | /features/<featureId>/properties/<propertyPath> |
Response
| Field | Value | |
|---|---|---|
| topic | <namespace>/<thingName>/things/<channel>/commands/delete |
|
| path | /features/<featureId>/properties/<propertyPath> |
|
| status | code | |
204 |
Success - the Property was deleted successfully. | |
403 |
Not Modifiable - The Property could not be deleted as the requester had insufficient permissions (‘WRITE’ is required). | |
404 |
Not Found - The Thing or Property was not found or requester had insufficient permissions. | |
| See Thing Error Responses for examples of other error responses. |
Event
The event emitted by Ditto after a Feature Property of a Thing was deleted.
| Field | Value |
|---|---|
| topic | <namespace>/<thingName>/things/<channel>/events/deleted |
| path | /features/<featureId>/properties/<propertyPath> |
Example: Delete a single Feature Property