curl --request POST \
--url https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelay \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "GPIO_OUTPUT"
}
}
'{
"component": {
"auxType": "integrated_generic_input",
"baseType": "reader",
"createdAtMillis": 123,
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"originator": {
"grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"grantedToName": "<string>",
"supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"supportUserEmail": "<string>",
"supportUsername": "<string>",
"type": "USER"
},
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerHardwareType": "RASPBERRY_PI_3",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "GPIO_OUTPUT"
},
"portImmutable": true,
"relayDurationSec": 123,
"stateChangedAtMillis": 123,
"steadyState": "ACTIVE",
"type": "RhombusOsdpDoorReader",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Update a generic relay component
curl --request POST \
--url https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelay \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "GPIO_OUTPUT"
}
}
'{
"component": {
"auxType": "integrated_generic_input",
"baseType": "reader",
"createdAtMillis": 123,
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"originator": {
"grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"grantedToName": "<string>",
"supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"supportUserEmail": "<string>",
"supportUsername": "<string>",
"type": "USER"
},
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerHardwareType": "RASPBERRY_PI_3",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "GPIO_OUTPUT"
},
"portImmutable": true,
"relayDurationSec": 123,
"stateChangedAtMillis": 123,
"steadyState": "ACTIVE",
"type": "RhombusOsdpDoorReader",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Documentation Index
Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
Use this file to discover all available pages before exploring further.
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
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.
api-token, api, partner-api-token, partner-api OK
Show child attributes
Was this page helpful?