summaryrefslogtreecommitdiff
path: root/opendc/api/v1/simulations/simulationId/experiments/experimentId/machine-states/endpoint.py
diff options
context:
space:
mode:
Diffstat (limited to 'opendc/api/v1/simulations/simulationId/experiments/experimentId/machine-states/endpoint.py')
-rw-r--r--opendc/api/v1/simulations/simulationId/experiments/experimentId/machine-states/endpoint.py51
1 files changed, 51 insertions, 0 deletions
diff --git a/opendc/api/v1/simulations/simulationId/experiments/experimentId/machine-states/endpoint.py b/opendc/api/v1/simulations/simulationId/experiments/experimentId/machine-states/endpoint.py
new file mode 100644
index 00000000..c5ba0abe
--- /dev/null
+++ b/opendc/api/v1/simulations/simulationId/experiments/experimentId/machine-states/endpoint.py
@@ -0,0 +1,51 @@
+from opendc.models.experiment import Experiment
+from opendc.models.machine_state import MachineState
+from opendc.util import database, exceptions
+from opendc.util.rest import Response
+
+def GET(request):
+ """Get this Experiment's Machine States."""
+
+ # Make sure required parameters are there
+
+ try:
+ request.check_required_parameters(
+ path = {
+ 'simulationId': 'int',
+ 'experimentId': 'int'
+ }
+ )
+
+ except exceptions.ParameterError as e:
+ return Response(400, e.message)
+
+ # Instantiate an Experiment from the database
+
+ experiment = Experiment.from_primary_key((request.params_path['experimentId'],))
+
+ # Make sure this Experiment exisits
+
+ if not experiment.exists():
+ return Response(404, '{} not found.'.format(experiment))
+
+ # Make sure this user is authorized to view this Experiment's Machine States
+
+ if not experiment.google_id_has_at_least(request.google_id, 'VIEW'):
+ return Response(403, 'Forbidden from viewing Machine States for {}.'.format(experiment))
+
+ # Get and return the Machine States
+
+ if 'tick' in request.params_query:
+ machine_states = MachineState.from_experiment_id_and_tick(
+ request.params_path['experimentId'],
+ request.params_query['tick']
+ )
+
+ else:
+ machine_states = MachineState.from_experiment_id(request.params_path['experimentId'])
+
+ return Response(
+ 200,
+ 'Successfully retrieved Machine States for {}.'.format(experiment),
+ [x.to_JSON() for x in machine_states]
+ )