Generic
Generic Model Access.
Create
Endpoint
1 |
|
Authorized Role/Capability
1 |
|
JSON Body Fields
Field | Type | Required | Notes |
---|---|---|---|
_type | string | yes | Database model type |
deviceId | string | Device ID owning the item | |
* | any | Optional item attributes to create |
Response
Query Path
Field | Type | Notes |
---|---|---|
filter | string | Simple filter string to filter |
next | object | Pagination token for the next page |
prev | object | Pagination token for the previous page |
limit | string | Number of items to retrieve. Defaults to 1. |
where | string | Where clause to filter |
Get
Get a data item from a database table.
Endpoint
1 |
|
Authorized Role/Capability
1 |
|
JSON Body Fields
Field | Type | Required | Notes |
---|---|---|---|
_type | string | yes | Database model type |
deviceId | string | Device ID owning the item | |
* | any | Optional item attributes to filter the selected item |
Response
Find
Find data items from a database table.
Endpoint
1 |
|
Authorized Role/Capability
1 |
|
JSON Body Fields
Field | Type | Required | Notes |
---|---|---|---|
_type | string | yes | Database model type |
deviceId | string | Device ID owning the item | |
* | any | Optional item attributes to filter selected items |
Response
An array of data items.
Query Path
Field | Type | Notes |
---|---|---|
filter | string | Simple filter string to filter |
next | object | Pagination token for the next page |
prev | object | Pagination token for the previous page |
limit | string | Number of items to retrieve. Defaults to 1. |
where | string | Where clause to filter |
Remove
Remove a data item.
Endpoint
1 |
|
Authorized Role/Capability
1 |
|
JSON Body Fields
Field | Type | Required | Notes |
---|---|---|---|
_type | string | yes | Database model type |
deviceId | string | Device ID owning the item | |
* | any | Other item attributes sufficient to identify the item |
Update
Update a data item.
Endpoint
1 |
|
Authorized Role/Capability
1 |
|
JSON Body Fields
Field | Type | Required | Notes |
---|---|---|---|
_type | string | yes | Database model type |
deviceId | string | Device ID owning the item | |
* | any | Other item attributes sufficient to identify the item |
Response
The updated data item.