Issue 47202: Options to reduce payload of getContainers.api response (#51)

Author: labkey-jeckels

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## version 5.1.0-SNAPSHOT
 *Released*: TBD
+* Optional parameters to `GetContainersCommand` to reduce the size of the response payload
 
 ## version 5.0.1
 *Released*: 30 January 2023

src/org/labkey/remoteapi/security/GetContainersCommand.java

@@ -23,6 +23,9 @@
 public class GetContainersCommand extends GetCommand<GetContainersResponse>
 {
     private boolean _includeSubfolders = false;
+    private Boolean _includeChildWorkbooks;
+    private Boolean _includeStandardProperties;
+    private Boolean _includeEffectivePermissions;
 
     public GetContainersCommand()
     {
@@ -39,6 +42,36 @@ public void setIncludeSubfolders(boolean includeSubfolders)
         _includeSubfolders = includeSubfolders;
     }
 
+    public Boolean getIncludeChildWorkbooks()
+    {
+        return _includeChildWorkbooks;
+    }
+
+    public void setIncludeChildWorkbooks(Boolean includeChildWorkbooks)
+    {
+        _includeChildWorkbooks = includeChildWorkbooks;
+    }
+
+    public Boolean getIncludeStandardProperties()
+    {
+        return _includeStandardProperties;
+    }
+
+    public void setIncludeStandardProperties(Boolean includeStandardProperties)
+    {
+        _includeStandardProperties = includeStandardProperties;
+    }
+
+    public Boolean getIncludeEffectivePermissions()
+    {
+        return _includeEffectivePermissions;
+    }
+
+    public void setIncludeEffectivePermissions(Boolean includeEffectivePermissions)
+    {
+        _includeEffectivePermissions = includeEffectivePermissions;
+    }
+
     @Override
     protected GetContainersResponse createResponse(String text, int status, String contentType, JSONObject json)
     {
@@ -50,6 +83,18 @@ protected Map<String, Object> createParameterMap()
     {
         Map<String, Object> params = super.createParameterMap();
         params.put("includeSubfolders", _includeSubfolders);
+        if (_includeChildWorkbooks != null)
+        {
+            params.put("includeChildWorkbooks", _includeChildWorkbooks);
+        }
+        if (_includeStandardProperties != null)
+        {
+            params.put("includeStandardProperties", _includeStandardProperties);
+        }
+        if (_includeEffectivePermissions != null)
+        {
+            params.put("includeEffectivePermissions", _includeEffectivePermissions);
+        }
 
         return params;
     }