- added logging variable 'object_type'
[plcapi.git] / PLC / Methods / GetSliceAttributes.py
index af5deec..d763661 100644 (file)
@@ -9,10 +9,13 @@ from PLC.Auth import Auth
 
 class GetSliceAttributes(Method):
     """
-    Get an array of structs containing the values of slice and sliver
-    attributes. An attribute is a sliver attribute if the node_id
-    field is set. If slice_attribute_id_list is specified, only the
-    specified attributes will be queried, if set.
+    Returns an array of structs containing details about slice and
+    sliver attributes. An attribute is a sliver attribute if the
+    node_id field is set. If slice_attribute_filter is specified and
+    is an array of slice attribute identifiers, or a struct of slice
+    attribute attributes, only slice attributes matching the filter
+    will be returned. If return_fields is specified, only the
+    specified details will be returned.
 
     Users may only query attributes of slices or slivers of which they
     are members. PIs may only query attributes of slices or slivers at
@@ -25,19 +28,21 @@ class GetSliceAttributes(Method):
     accepts = [
         Auth(),
         Mixed([SliceAttribute.fields['slice_attribute_id']],
-              Filter(SliceAttribute.fields))
+              Filter(SliceAttribute.fields)),
+        Parameter([str], "List of fields to return", nullok = True)
         ]
 
     returns = [SliceAttribute.fields]
+    
 
-    def call(self, auth, slice_attribute_filter = None):
+    def call(self, auth, slice_attribute_filter = None, return_fields = None):
        # If we are not admin, make sure to only return our own slice
        # and sliver attributes.
         if 'admin' not in self.caller['roles']:
             # Get slices that we are able to view
             valid_slice_ids = self.caller['slice_ids']
             if 'pi' in self.caller['roles'] and self.caller['site_ids']:
-                sites = Sites(self.api, self.caller['site_ids']).values()
+                sites = Sites(self.api, self.caller['site_ids'])
                 for site in sites:
                     valid_slice_ids += site['slice_ids']
 
@@ -46,7 +51,7 @@ class GetSliceAttributes(Method):
 
             # Get slice attributes that we are able to view
             valid_slice_attribute_ids = []
-            slices = Slices(self.api, valid_slice_ids).values()
+            slices = Slices(self.api, valid_slice_ids)
             for slice in slices:
                 valid_slice_attribute_ids += slice['slice_attribute_ids']
 
@@ -56,7 +61,7 @@ class GetSliceAttributes(Method):
             if slice_attribute_filter is None:
                 slice_attribute_filter = valid_slice_attribute_ids
 
-        slice_attributes = SliceAttributes(self.api, slice_attribute_filter).values()
+        slice_attributes = SliceAttributes(self.api, slice_attribute_filter, return_fields)
 
         # Filter out slice attributes that are not viewable
         if 'admin' not in self.caller['roles']: