Get Param Value Endpoint
GET /api/system/params/{param_name}/value
Get current value of a specific parameter.
Returns the current value of a parameter by name. This endpoint allows the Operator Console to fetch individual parameter values without loading the entire parameter registry.
Path Parameters:
param_name(str): Parameter name (e.g., “etherforce.temperature”)
Returns:
name(str): Parameter namevalue(object): Current parameter valuesuccess(bool): Whether operation succeededmessage(str | None): Optional status message
Example Response:
{
"name": "etherforce.temperature",
"value": 0.7,
"success": true,
"message": null
}Raises:
- HTTPException(503): If instrumentation layer is not available
- HTTPException(404): If parameter not found
- HTTPException(500): If value retrieval fails
Use Cases:
- Operator Console parameter value display
- Real-time parameter monitoring
- Parameter validation before setting
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Parameter name (e.g., ‘etherforce.temperature’)
Parameter name (e.g., ‘etherforce.temperature’)
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