smif.http_api.crud module¶
HTTP API endpoint
Summary¶
Classes:
NarrativeAPI |
Implement CRUD operations for narratives configuration data |
NarrativeSetAPI |
Implement CRUD operations for narrative_sets configuration data |
ScenarioAPI |
Implement CRUD operations for scenarios configuration data |
ScenarioSetAPI |
Implement CRUD operations for scenario_sets configuration data |
SectorModelAPI |
Implement CRUD operations for sector_model configuration data |
SmifAPI |
Implement operations for Smif |
SosModelAPI |
Implement CRUD operations for sos_model configuration data |
SosModelRunAPI |
Implement CRUD operations for sos_model_run configuration data |
Functions:
check_timestamp |
Check for timestamp and parse to datetime object |
Reference¶
-
class
smif.http_api.crud.
SmifAPI
[source]¶ Bases:
flask.views.MethodView
Implement operations for Smif
-
methods
= {'GET'}¶
-
-
class
smif.http_api.crud.
SosModelRunAPI
[source]¶ Bases:
flask.views.MethodView
Implement CRUD operations for sos_model_run configuration data
-
get
(sos_model_run_name=None, action=None)[source]¶ Get sos_model_runs all: GET /api/v1/sos_model_runs/ one: GET /api/vi/sos_model_runs/name
-
post
(sos_model_run_name=None, action=None)[source]¶ Create a sos_model_run: - POST /api/v1/sos_model_runs
Perform an operation on a sos_model_run - POST /api/v1/sos_model_runs/<sos_model_run_name>/<action>
Available actions are - start: Start the sos_model_run - kill: Stop a sos_model_run that is currently running - remove: Remove a sos_model_run that is waiting to be executed - resume: Warm start a sos_model_run
-
methods
= {'GET', 'PUT', 'POST', 'DELETE'}¶
-
-
class
smif.http_api.crud.
SosModelAPI
[source]¶ Bases:
flask.views.MethodView
Implement CRUD operations for sos_model configuration data
-
get
(sos_model_name)[source]¶ Get sos_model all: GET /api/v1/sos_model/ one: GET /api/vi/sos_model/name
-
methods
= {'GET', 'PUT', 'POST', 'DELETE'}¶
-
-
class
smif.http_api.crud.
SectorModelAPI
[source]¶ Bases:
flask.views.MethodView
Implement CRUD operations for sector_model configuration data
-
get
(sector_model_name)[source]¶ Get sector_models all: GET /api/v1/sector_models/ one: GET /api/vi/sector_models/name
-
methods
= {'GET', 'PUT', 'POST', 'DELETE'}¶
-
-
class
smif.http_api.crud.
ScenarioSetAPI
[source]¶ Bases:
flask.views.MethodView
Implement CRUD operations for scenario_sets configuration data
-
get
(scenario_set_name)[source]¶ Get scenario_sets all: GET /api/v1/scenario_sets/ one: GET /api/vi/scenario_sets/name
-
methods
= {'GET', 'PUT', 'POST', 'DELETE'}¶
-
-
class
smif.http_api.crud.
ScenarioAPI
[source]¶ Bases:
flask.views.MethodView
Implement CRUD operations for scenarios configuration data
-
get
(scenario_name)[source]¶ Get scenarios all: GET /api/v1/scenarios/ one: GET /api/vi/scenarios/name
-
methods
= {'GET', 'PUT', 'POST', 'DELETE'}¶
-
-
class
smif.http_api.crud.
NarrativeSetAPI
[source]¶ Bases:
flask.views.MethodView
Implement CRUD operations for narrative_sets configuration data
-
get
(narrative_set_name)[source]¶ Get narrative_sets all: GET /api/v1/narrative_sets/ one: GET /api/vi/narrative_sets/name
-
methods
= {'GET', 'PUT', 'POST', 'DELETE'}¶
-