ThingsboardClient methods:
void deleteRpc(@Nonnull String rpcId) // Delete persistent RPC
Rpc getPersistedRpc(@Nonnull String rpcId) // Get persistent RPC request
String getPersistedRpcByDevice(@Nonnull String deviceId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String rpcStatus, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get persistent RPC requests
String handleOneWayDeviceRPCRequestV2(@Nonnull String deviceId, @Nonnull String body) // Send one-way RPC request (handleOneWayDeviceRPCRequestV2)
String handleTwoWayDeviceRPCRequestV2(@Nonnull String deviceId, @Nonnull String body) // Send two-way RPC request (handleTwoWayDeviceRPCRequestV2)
void deleteRpc(@Nonnull String rpcId)
DELETE /api/rpc/persistent/{rpcId}
Delete persistent RPC
Deletes the persistent RPC request. Available for users with 'TENANT_ADMIN' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| rpcId | String | A string value representing the rpc id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' |
null (empty response body)
Rpc getPersistedRpc(@Nonnull String rpcId)
GET /api/rpc/persistent/{rpcId}
Get persistent RPC request
Get information about the status of the RPC call. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| rpcId | String | A string value representing the rpc id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' |
Rpc
String getPersistedRpcByDevice(@Nonnull String deviceId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String rpcStatus, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
GET /api/rpc/persistent/device/{deviceId}
Get persistent RPC requests
Allows to query RPC calls for specific device using pagination. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| deviceId | String | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| pageSize | Integer | Maximum amount of entities in a one page | |
| page | Integer | Sequence number of page starting from 0 | |
| rpcStatus | String | Status of the RPC | [optional] [enum: QUEUED, SENT, DELIVERED, SUCCESSFUL, TIMEOUT, EXPIRED, FAILED] |
| textSearch | String | Not implemented. Leave empty. | [optional] |
| sortProperty | String | Property of entity to sort by | [optional] [enum: createdTime, expirationTime, request, response] |
| sortOrder | String | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] [enum: ASC, DESC] |
String
String handleOneWayDeviceRPCRequestV2(@Nonnull String deviceId, @Nonnull String body)
POST /api/rpc/oneway/{deviceId}
Send one-way RPC request (handleOneWayDeviceRPCRequestV2)
Sends the one-way remote-procedure call (RPC) request to device. Sends the one-way remote-procedure call (RPC) request to device. The RPC call is A JSON that contains the method name ('method'), parameters ('params') and multiple optional fields. See example below. We will review the properties of the RPC call one-by-one below. json { \"method\": \"setGpio\", \"params\": { \"pin\": 7, \"value\": 1 }, \"persistent\": false, \"timeout\": 5000 } ### Server-side RPC structure The body of server-side RPC request consists of multiple fields: * method - mandatory, name of the method to distinct the RPC calls. For example, "getCurrentTime" or "getWeatherForecast". The value of the parameter is a string. * params - mandatory, parameters used for processing of the request. The value is a JSON. Leave empty JSON "{}" if no parameters needed. * timeout - optional, value of the processing timeout in milliseconds. The default value is 10000 (10 seconds). The minimum value is 5000 (5 seconds). * expirationTime - optional, value of the epoch time (in milliseconds, UTC timezone). Overrides timeout if present. * persistent - optional, indicates persistent RPC. The default value is "false". * retries - optional, defines how many times persistent RPC will be re-sent in case of failures on the network and/or device side. * additionalInfo - optional, defines metadata for the persistent RPC that will be added to the persistent RPC events. ### RPC Result In case of persistent RPC, the result of this call is 'rpcId' UUID. In case of lightweight RPC, the result of this call is either 200 OK if the message was sent to device, or 504 Gateway Timeout if device is offline. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| deviceId | String | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| body | String | A JSON object representing the RPC request. |
String
String handleTwoWayDeviceRPCRequestV2(@Nonnull String deviceId, @Nonnull String body)
POST /api/rpc/twoway/{deviceId}
Send two-way RPC request (handleTwoWayDeviceRPCRequestV2)
Sends the two-way remote-procedure call (RPC) request to device. Sends the one-way remote-procedure call (RPC) request to device. The RPC call is A JSON that contains the method name ('method'), parameters ('params') and multiple optional fields. See example below. We will review the properties of the RPC call one-by-one below. json { \"method\": \"setGpio\", \"params\": { \"pin\": 7, \"value\": 1 }, \"persistent\": false, \"timeout\": 5000 } ### Server-side RPC structure The body of server-side RPC request consists of multiple fields: * method - mandatory, name of the method to distinct the RPC calls. For example, "getCurrentTime" or "getWeatherForecast". The value of the parameter is a string. * params - mandatory, parameters used for processing of the request. The value is a JSON. Leave empty JSON "{}" if no parameters needed. * timeout - optional, value of the processing timeout in milliseconds. The default value is 10000 (10 seconds). The minimum value is 5000 (5 seconds). * expirationTime - optional, value of the epoch time (in milliseconds, UTC timezone). Overrides timeout if present. * persistent - optional, indicates persistent RPC. The default value is "false". * retries - optional, defines how many times persistent RPC will be re-sent in case of failures on the network and/or device side. * additionalInfo - optional, defines metadata for the persistent RPC that will be added to the persistent RPC events. ### RPC Result In case of persistent RPC, the result of this call is 'rpcId' UUID. In case of lightweight RPC, the result of this call is the response from device, or 504 Gateway Timeout if device is offline. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| deviceId | String | A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' | |
| body | String | A JSON object representing the RPC request. |
String