Activate a generic relay for a brief period
curl --request POST \
--url https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelayTransientState \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"activate": true,
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"correlationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"durationMs": 123
}
'import requests
url = "https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelayTransientState"
payload = {
"activate": True,
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"correlationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"durationMs": 123
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
activate: true,
componentUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
correlationUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
deviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA.v0',
durationMs: 123
})
};
fetch('https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelayTransientState', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelayTransientState")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activate\": true,\n \"componentUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"correlationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"deviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA.v0\",\n \"durationMs\": 123\n}")
.asString();{
"success": true
}Component Webservice
Activate a generic relay for a brief period
Activate a generic relay for a brief period
POST
/
api
/
component
/
updateIntegratedGenericRelayTransientState
Activate a generic relay for a brief period
curl --request POST \
--url https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelayTransientState \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"activate": true,
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"correlationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"durationMs": 123
}
'import requests
url = "https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelayTransientState"
payload = {
"activate": True,
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"correlationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"durationMs": 123
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
activate: true,
componentUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
correlationUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
deviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA.v0',
durationMs: 123
})
};
fetch('https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelayTransientState', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelayTransientState")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activate\": true,\n \"componentUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"correlationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"deviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA.v0\",\n \"durationMs\": 123\n}")
.asString();{
"success": true
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
Available options:
api-token, api, partner-api-token, partner-api Body
application/json
base 64 (url-safe) uuid string
Example:
"AAAAAAAAAAAAAAAAAAAAAA"
base 64 (url-safe) uuid string
Example:
"AAAAAAAAAAAAAAAAAAAAAA"
RUUID with optional appended facet information
Example:
"AAAAAAAAAAAAAAAAAAAAAA.v0"
Response
200 - application/json
OK
Last modified on September 15, 2026