Summary endpoint revision and updates

reo/exceptions.py

@@ -159,11 +159,11 @@ class UnexpectedError(REoptError):
 
     __name__ = 'UnexpectedError'
 
-    def __init__(self, exc_type, exc_value, exc_traceback, task='', run_uuid='', user_uuid='', message=None):
+    def __init__(self, exc_type, exc_value, exc_traceback, task='', run_uuid='', user_uuid='', portfolio_uuid='', message=None):
         debug_msg = "exc_type: {}; exc_value: {}; exc_traceback: {}".format(exc_type, exc_value, exc_traceback)
         if message is None:
             message = "Unexpected Error."
-        super(UnexpectedError, self).__init__(task=task, name=self.__name__, run_uuid=run_uuid, user_uuid=user_uuid,
+        super(UnexpectedError, self).__init__(task=task, name=self.__name__, run_uuid=run_uuid, user_uuid=user_uuid, portfolio_uuid=portfolio_uuid,
                                               message=message, traceback=debug_msg)
 
 

reoptjl/api.py

@@ -95,6 +95,16 @@ def obj_create(self, bundle, **kwargs):
         else:
             webtool_uuid = None
 
+        if 'portfolio_uuid' in bundle.data.keys():
+
+            if type(bundle.data['portfolio_uuid']) == str:
+                if len(bundle.data['portfolio_uuid']) == len(run_uuid):
+                    portfolio_uuid = bundle.data['portfolio_uuid']
+                else:
+                    portfolio_uuid = ''
+        else:
+            portfolio_uuid = None
+
         meta = {
             "run_uuid": run_uuid,
             "api_version": 3,
@@ -110,6 +120,9 @@ def obj_create(self, bundle, **kwargs):
 
         if api_key != "":
             bundle.data['APIMeta']['api_key'] = api_key
+
+        if portfolio_uuid is not None:
+            bundle.data['APIMeta']['portfolio_uuid'] = portfolio_uuid
 
         log.addFilter(UUIDFilter(run_uuid))
 

reoptjl/migrations/0061_portfoliounlinkedruns_apimeta_portfolio_uuid_and_more.py

@@ -0,0 +1,32 @@
+# Generated by Django 4.0.7 on 2024-08-20 16:09
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('reoptjl', '0060_processheatloadinputs_addressable_load_fraction_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='PortfolioUnlinkedRuns',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('portfolio_uuid', models.UUIDField()),
+                ('user_uuid', models.UUIDField()),
+                ('run_uuid', models.UUIDField(unique=True)),
+            ],
+        ),
+        migrations.AddField(
+            model_name='apimeta',
+            name='portfolio_uuid',
+            field=models.TextField(blank=True, default='', help_text='The unique ID of a portfolio (set of associated runs) created by the REopt Webtool. Note that this ID can be shared by several REopt API Scenarios and one user can have one-to-many portfolio_uuid tied to them.'),
+        ),
+        migrations.AlterField(
+            model_name='apimeta',
+            name='reopt_version',
+            field=models.TextField(blank=True, default='', help_text='Version number of the Julia package for REopt that is used to solve the problem.', null=True),
+        ),
+    ]

reoptjl/models.py

@@ -185,6 +185,12 @@ class APIMeta(BaseModel, models.Model):
         default="",
         help_text="NREL Developer API key of the user"
     )
+    portfolio_uuid = models.TextField(
+        blank=True,
+        default="",
+        help_text=("The unique ID of a portfolio (set of associated runs) created by the REopt Webtool. Note that this ID can be shared by "
+                   "several REopt API Scenarios and one user can have one-to-many portfolio_uuid tied to them.")
+    )
 
 class UserUnlinkedRuns(models.Model):
     run_uuid = models.UUIDField(unique=True)
@@ -196,6 +202,17 @@ def create(cls, **kwargs):
         obj.save()
         return obj
 
+class PortfolioUnlinkedRuns(models.Model):
+    portfolio_uuid = models.UUIDField(unique=False)
+    user_uuid = models.UUIDField(unique=False)
+    run_uuid = models.UUIDField(unique=True)
+
+    @classmethod
+    def create(cls, **kwargs):
+        obj = cls(**kwargs)
+        obj.save()
+        return obj
+
 class UserProvidedMeta(BaseModel, models.Model):
     """
     User provided values that are not necessary for running REopt

reoptjl/urls.py

@@ -17,9 +17,12 @@
     re_path(r'^user/(?P<user_uuid>[0-9a-f-]+)/summary/?$', views.summary),
     re_path(r'^user/(?P<user_uuid>[0-9a-f-]+)/summary_by_chunk/(?P<chunk>[0-9]+)/?$', views.summary_by_chunk),
     re_path(r'^user/(?P<user_uuid>[0-9a-f-]+)/unlink/(?P<run_uuid>[0-9a-f-]+)/?$', views.unlink),
+    re_path(r'^user/(?P<user_uuid>[0-9a-f-]+)/unlink_from_portfolio/(?P<portfolio_uuid>[0-9a-f-]+)/(?P<run_uuid>[0-9a-f-]+)/?$', views.unlink_from_portfolio),
     re_path(r'^ghp_efficiency_thermal_factors/?$', views.ghp_efficiency_thermal_factors),
     re_path(r'^peak_load_outage_times/?$', views.peak_load_outage_times),
     re_path(r'^invalid_urdb/?$', reoviews.invalid_urdb),
     re_path(r'^schedule_stats/?$', reoviews.schedule_stats),
     re_path(r'^get_existing_chiller_default_cop/?$', views.get_existing_chiller_default_cop),
+    re_path(r'^summary_by_runuuids/?$', views.summary_by_runuuids),
+    re_path(r'^link_run_to_portfolios/?$', views.link_run_uuids_to_portfolio_uuid)
 ]