Set Relay Jog Duration

Coming Soon

This endpoint is not available in the current version. It will be available in a future release.

Sets the jog (JOG) duration for a specific relay on a device. The duration is persisted on the device and is then used by subsequent jog operations.

Current Phase Notes

• This endpoint is documented early so clients can reserve the configuration capability in their API design
• The permission model is already fixed as device:config
• The request and response shape below reflect the planned stable shape for the first release of this endpoint

Endpoint

PUT /wlte/v1/devices/{deviceId}/relays/{index}/jog-config

Authorization Requirements

Scope	Required	Description
device:config	Yes	Configure the jog duration for the target relay

Request

Full URL:

PUT {baseUrl}/wlte/v1/devices/{deviceId}/relays/{index}/jog-config

Request headers:

Authorization: Bearer {accessToken}
Content-Type: application/json
Accept: application/json

Path parameters:

Parameter	Type	Required	Rule
deviceId	string	Yes	Must not be empty
index	integer	Yes	Positive integer, starting from 1

Request body:

{
  "durationSec": 2
}

Request body fields:

Field	Type	Required	Rule
durationSec	integer	Yes	Positive integer

Success Response

HTTP status:

200 OK

Response body:

{
  "code": "SUCCESS",
  "message": "OK.",
  "requestId": "req_001",
  "data": {
    "deviceId": "abc123456789",
    "relayIndex": 1,
    "durationSec": 2
  }
}

Response data Schema

Field	Type	Required	Description
deviceId	string	Yes	Unique device identifier
relayIndex	integer	Yes	Relay index, starting from 1
durationSec	integer	Yes	The jog duration written to the device, in seconds

Error Responses

Possible responses:

• 400 INVALID_REQUEST: durationSec is missing, not a positive integer, or unknown fields are present
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 403 AUTH_SCOPE_DENIED
• 404 DEVICE_NOT_FOUND
• 422 COMMAND_REJECTED
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR