Set Param Value Endpoint
PUT /api/system/params/{param_name}/value
Set value of a specific parameter.
Updates the value of a parameter by name. This endpoint allows the Operator Console to modify parameter values remotely. The value is validated according to the parameter’s type, min/max constraints, and options before being set.
Path Parameters:
param_name(str): Parameter name (e.g., “etherforce.temperature”)
Request Body:
value(object): New parameter value (must match parameter type and constraints)
Returns:
name(str): Parameter namevalue(object): New parameter value (after validation)success(bool): Whether operation succeededmessage(str | None): Optional status message
Example Request:
{
"value": 0.8
}Example Response:
{
"name": "etherforce.temperature",
"value": 0.8,
"success": true,
"message": "Parameter value updated successfully"
}Raises:
- HTTPException(503): If instrumentation layer is not available
- HTTPException(404): If parameter not found
- HTTPException(400): If parameter is readonly or value is invalid
- HTTPException(500): If value setting fails
Use Cases:
- Operator Console parameter editing
- Remote configuration changes
- Runtime parameter tuning
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Parameter name (e.g., ‘etherforce.temperature’)
Parameter name (e.g., ‘etherforce.temperature’)
Request Body required
Section titled “Request Body required ”Request model for setting instrument parameter values.
Used by instrument_routes for updating runtime parameter values via Operator Console. The value field accepts any JSON-serializable value, which will be validated against the parameter’s type and constraints by the instrumentation layer.
Fields:
value: Parameter value (any JSON-serializable type)
Usage: PUT /api/system/params/{param_name}/value accepts this request model.
JSON Example:
{
"value": 0.8
}Responses
Section titled “ Responses ”Successful Response
Response model for instrument parameter value operations.
Used by instrument_routes for returning parameter values and operation results. Provides confirmation of parameter get/set operations with the actual value that was retrieved or set (after validation/coercion).
Fields:
name: Parameter name (required, string)value: Parameter value (required, object - any JSON-serializable type)success: Whether operation succeeded (required, boolean)message: Optional status message (optional, string)
Usage: GET /api/system/params/{param_name}/value and PUT /api/system/params/{param_name}/value return this response model.
JSON Example:
{
"name": "etherforce.temperature",
"value": 0.8,
"success": true,
"message": "Parameter value updated successfully"
}Validation Error