Thing management API.
Create thing
Create thing from given name and description, and get thing's id back.
The page API REST Tip does not exist.
1. Request
POST /<api-version>/things.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Request Body
New thing attributes:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| name | x | string | - | New thing name |
| description | string | null | New thing description |
The page Spacer does not exist.
3. Response Status
The page API HTTP Response - Get does not exist.
4. Response Body
The string ID of a created thing
5. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
thing |
x | object | - |
Thing details to create |
| →name | x | string | - | Thing name |
| →description | string | null | Thing description |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request | |
|
result |
x | string | - |
Created thing ID |
3. Example
The page API Mosquitto does not exist.
Request
Response
Get thing details
Get thing information by ID.
The page API REST Tip does not exist.
1. Request
GET /<api-version>/things/<thingId>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
| x | string | - |
Identifier of a thing. |
|
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Get does not exist.
3. Response Body
Thing attributes:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | x | string | - | thing id |
| name | x | string | - | thing name |
| description | string | null | thing description |
The page Spacer does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
| x | string | - |
Identifier of a thing. |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request | |
|
result |
object | null |
Thing details or null if not found |
|
| →id | x | string | - | Thing ID |
| →name | x | string | - | Thing name |
| →description | string | null | Thing description |
3. Example
The page API Mosquitto does not exist.
Request
Response
Get things
Obtain list of things.
The page API REST Tip does not exist.
1. Request
GET /<api-version>/things.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Get does not exist.
3. Response Body
Array with thing information:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | x | string | - | thing id |
| name | x | string | - | thing name |
The page Spacer does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request | |
|
result |
x | array | - |
Array of information about things |
| →id | x | string | - | Thing Id |
| →name | x | string | - | Thing name |
3. Example
The page API Mosquitto does not exist.
Request
Response
Get code of thing
Get JavaScript code of thing by ID of thing.
The page API REST Tip does not exist.
1. Request
GET /<api-version>/things/<thingId>/code.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
| thingId | x | string | - | Identifier of a thing. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Get does not exist.
3. Response Body
JavaScript code of thing.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
thing |
x | object | - |
Thing details to create |
| →name | x | string | - | Thing name |
| →description | string | null | Thing description |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request | |
|
result |
x | string | - |
Created thing ID |
3. Example
The page API Mosquitto does not exist.
Request
Response
Update thing
Update thing details
The page API REST Tip does not exist.
1. Request
PUT /<api-version>/things/<thingId>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
| x | string | - |
Identifier of a thing. |
|
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Request Body
Thing attributes:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| name | x | string | - | New thing name |
| description | string | null | New thing description |
The page Spacer does not exist.
3. Response Status
The page API HTTP Response - Update does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
| x | string | - |
Identifier of a thing. |
|
| thing | x | object | - | Thing information to update |
| →name | x | string | - | Thing name |
| →description | string | null | Thing description |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request |
3. Example
The page API Mosquitto does not exist.
Request
Response
Update code of thing
Update JavaScript code of thing from given one.
The page API REST Tip does not exist.
1. Request
PUT /<api-version>/things/<thingId>/code.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
| thingId | x | string | - | Identifier of a thing. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Request Body
Body contains JavaScript code:
3. Response Status
The page API HTTP Response - Update does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
thing |
x | object | - |
Thing details to create |
| →name | x | string | - | Thing name |
| →description | string | null | Thing description |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request | |
|
result |
x | string | - |
Created thing ID |
3. Example
The page API Mosquitto does not exist.
Request
Response
Delete thing
Delete thing by ID.
The page API REST Tip does not exist.
1. Resource URL
DELETE /<api-version>/things/<thingId>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
| x | string | - |
Identifier of a thing. |
|
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Update does not exist.
3. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
| x | string | - |
Identifier of a thing. |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request |
3. Example
The page API Mosquitto does not exist.
Request
Response