Changes between Version 36 and Version 37 of NewTestbedAPISpec

Timestamp:

Jul 25, 2015 7:10:56 PM (9 years ago)

Author:

faber

Comment:

--

NewTestbedAPISpec

@@ -1261 +1261 @@
 === Viewing Libraries ===
 
-One or more libraried can be viewed by an authorized user assuming that user has the proper permissions.  The search can be a regular expression matched against the library name.  To view libraries, call:
+One or more libraries can be viewed by an authorized user assuming that user has the proper permissions.  The search can be a regular expression matched against the library name.  To view libraries, call:
 
  * '''Service:''' Libraries
@@ -1564 +1564 @@
 Tags are name value pairs associated with a resource or facet thereof.  They are a simple extension mechanism, akin to attributes in [wiki:LayoutAspect#ViewExchangeFormattopdlv2 topdl].
 
-Operations on resources include:
-
+=== Viewing Resources ===
+
+One or more resources can be viewed by an authorized user assuming that user has the proper permissions.  The search can be a regular expression matched against the library name as well as scoping the search by type, realization membership, tags and user visibility.  To view resources, call:
+
+ * '''Service:''' Resources
+ * '''Operation:''' viewResources
+ * '''Input Parameters:'''
+   * Userid - a string, if given return all experiments this user can see
+   * Type - a string, if given return only resources of this type
+   * Regex - a string containing a regular expression matched against experiment names
+   * Realization - an optional string.  If given return only resources in the given realization
+   * Persist - an optional boolean.  If given return only peristent resources
+   * tags - an array of name value pairs.  If given only return resources that are so tagged.
+ * '''Return Values:'''
+   * One or more structures with the following fields
+     * Name - a string containing the resource name
+     * Type - a string containing the type
+     * Description - an optional natural language description
+     * Tags - a list of name value pairs (strings)
+     * Facets - a list of data structures containing
+       * Name - the facet name
+       * Type - the type
+       * Value - the quantity
+       * Units - the units that define value
+       * Tags - a list of name value pairs (strings)
+     * ACL - a list of structures of the form
+       * Name - a string the circle name
+       * Permissions - a list of strings containing this circle's permissions.  Permissions are from [http://www.isi.edu/~faber/tmp/DeterAPI/doc/constant-values.html#net.deterlab.testbed.api.Permissions this table]
+
+Users - primarily administrators - can create or delete resources
 
  * '''Service:''' Resources
  * '''Operation:''' createResource
-String name, String type, Boolean persist, String description, ResourceFacet[] facets, ResourceTag[] tags, AccessMember[] accessLists
-
  * '''Input Parameters:'''
    * Name - a string, the scoped, unique identifier of the resource
@@ -1585 +1611 @@
  * '''Return Values:'''
   * A boolean indicating success
+
+A resource is deleted using:
+ 
+ * '''Service:''' Resources
+ * '''Operation:''' removeResource
+ * '''Input Parameters:'''
+   * Name - a string containing the resource to delete
+ * '''Return Values:'''
+   * a boolean, true on success