Skip to end of metadata
Go to start of metadata

Properties provide information about the internal state of a Thing. Several basic operations on properties are defined which can be implemented through a REST API tool or command line tool, such as cURL.

Create property


Create a new thing property.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

POST /<api-version>/things/<thingId>/properties.<format>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingIdxstring-Identifier of thing.

format

xstring-

Request/response format. Currently supported format is json.

 

2. Request Body

New property attributes:

AttributeRequiredTypeDefaultInformation
namexstring-Property name.
typexstring-Property type: persistent,remote, script.
dataTypexstring-Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>.
nullablexboolean-True if property value can be set to null.
privatexboolean-True if property is visible for external calls.
readOnlyxboolean-True if property is read only.
description stringnullProperty description.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

3. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Get'.

 

4. Response Body

The string ID of a created property


5. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client
thingIdxstring-Identifier of a thing.
propertyxobject-Property details to create
namexstring-Property name.
typexstring-Property type: persistent,remote, script.
dataTypexstring-Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>.
nullablexboolean-True if property value can be set to null.
privatexboolean-True if property is visible for external calls.
readOnlyxboolean-True if property is read only.
description stringnull

Property description.

 

2. Response

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier specified in request

result

xstring

Created property ID

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

Get property details


Get property information by the ID.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

GET /<api-version>/things/<thingId>/properties/<propertId>.<format>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingId

xstring-

Identifier of a thing.

propertyIdxstring-Identifier of a property.

format

xstring-

Request/response format. Currently supported format is json.

 

2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Get'.


3. Response Body

Property attributes:

AttributeRequiredTypeDefaultInformation
idxstring-Identifier of a property.
namexstring-Property name.
typexstring-Property type: persistent,remote, script.
dataTypexstring-Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>.
nullablexboolean-True if property value can be set to null.
privatexboolean-True if property is visible for external calls.
readOnlyxboolean-True if property is read only.
description stringnull

Property description.


Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

thingId

xstring

Identifier of a thing.

propertyIdxstring-Identifier of a property.

 

2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client
result objectnullProperty details
idxstring-Identifier of a property.
namexstring-Property name.
typexstring-Property type: persistent,remote, script.
dataTypexstring-Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>.
nullablexboolean-True if property value can be set to null.
privatexboolean-True if property is visible for external calls.
readOnlyxboolean-True if property is read only.
description stringnull

Property description.

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Get properties


Obtain list of a properties.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

GET /<api-version>/things/<thingId>/properties.<format>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingIdxstring-Identifier of thing.

format

xstring-

Request/response format. Currently supported format is json.

 

2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Get'.


3. Response Body

Array with property information:

AttributeRequiredTypeDefaultInformation
idxstring-Property Id.
namexstring-Property name.
typexstring-Property type: persistent,remote, script.
dataTypexstring-Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>.
nullablexboolean-True if property value can be set to null.
privatexboolean-True if property is visible for external calls.
readOnlyxboolean-True if property is read only.
description stringnullProperty description.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client
thingIdxstring-Identifier of a thing.


2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client 
resultxarraynullArray of properties
idxstring-Property Id.
namexstring-Property name.
typexstring-Property type: persistent,remote, script.
dataTypexstring-Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>.
nullablexboolean-True if property value can be set to null.
privatexboolean-True if property is visible for external calls.
readOnlyxboolean-True if property is read only.
description stringnullProperty description.

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Get property value


Get property value.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

GET /<api-version>/things/<thingId>/properties/<propertyId>/value.<format>?cached=<cached>&ignoreNulls=<ignore_nulls>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingId

xstring-

Identifier of a thing.

propertyIdxstring-Identifier of a property.

format

xstring-

Request/response format. Currently supported format is json.

cachedxbooleanfalseUse last server cached value
ignoreNullsxbooleantrueSkip null-value attributes

 

2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Get'.


3. Response Body

Property value.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

thingId

xstring

Identifier of a thing.

propertyIdxstring-Identifier of a property.
cached booleanfalseUse last server cached value
ignoreNulls booleantrueSkip null-value attributes

 

2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client
result objectnullProperty value

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Get values of all properties


Get value of all thing properties.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

GET /<api-version>/things/<thingId>/properties/values.<format>?cached=<cached>&ignoreNulls=<ignore_nulls>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingId

xstring-

Identifier of a thing.

format

xstring-

Request/response format. Currently supported format is json.

cached booleanfalseUse last server cached value
ignoreNulls booleantrueSkip null-value attributes

 

2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Get'.


3. Response Body

PropertyId-Value map.

AttributeRequiredTypeDefaultDescription
propertyIdxstring-Identifier of a property.
valuexobjectnullProperty value

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

thingId

xstring

Identifier of a thing.

cachedxbooleanfalseUse last server cached value
ignoreNullsxbooleantrueSkip null-value attributes

 

2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client
result objectnullMap of propertyId-value
propertyIdxstring-Property Id.
valuexobject-Property value.

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Set property value


Set property value.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

PUT /<api-version>/things/<thingId>/properties/<propertyId>/value.<format>?async=<async>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingId

xstring-

Identifier of a thing.

propertyIdxstring-Identifier of a property.

format

xstring-

Request/response format. Currently supported format is json.

async booleanfalseAsynchronous execution flag.

 

2. Request Body

Property value.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Spacer'.

 

3. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Update'.


4. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

thingId

xstring

Identifier of a thing.

propertyIdxstring-Identifier of a property.
async booleanfalseAsynchronous execution flag.
valuexobject-Property value.

 

2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response

 

Delete property


Delete property.

 

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API REST Tip'.

1. Request

DELETE /<api-version>/things/<thingId>/properties/<propertyId>.<format>

ParameterRequiredTypeDefaultDescription

api-version

xstring-

API version. Currently v1.

thingId

xstring-

Identifier of a thing.

propertyIdxstring-Identifier of a property.

format

xstring-

Request/response format. Currently supported format is json.


2. Response Status

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API HTTP Response - Update'.


3. Examples

Request
Response

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API MAPI Outdated'.
Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Messaging Tip'.

1. Request

AttributeRequiredTypeDefaultDescription
id stringnullRequest identifier established by the client 

thingId

xstring

Identifier of a thing.

propertyIdxstring-Identifier of a property.

 

2. Response

AttributeRequiredTypeDefaultInformation
id stringnullRequest identifier established by the client

 

3. Example

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'API Mosquitto'.

Request
Response
  • No labels