Update a generic relay component's steady state

Update a generic relay component’s steady state

POST /api/component/updateIntegratedGenericRelaySteadyState

Update a generic relay component's steady state

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/component/updateIntegratedGenericRelaySteadyState \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "component": {
    "createdAtMillis": 123,
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "originator": {
      "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "grantedToName": "<string>",
      "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "supportUserEmail": "<string>",
      "supportUsername": "<string>"
    },
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "port": {
      "boardNum": 123,
      "portNum": 123
    },
    "portImmutable": true,
    "relayDurationSec": 123,
    "stateChangedAtMillis": 123,
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Authorizations

x-auth-apikey · string · header · required

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

x-auth-scheme · enum<string> · default: api-token · required

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

componentUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

steadyState · enum<string>

Available options: ACTIVE, INACTIVE, UNKNOWN

Response

200 - application/json

OK

component · object

Show child attributes