Changes between Version 36 and Version 37 of NewTestbedAPISpec


Ignore:
Timestamp:
Jul 25, 2015 7:10:56 PM (9 years ago)
Author:
faber
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • NewTestbedAPISpec

    v36 v37  
    12611261=== Viewing Libraries ===
    12621262
    1263 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:
     1263One 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:
    12641264
    12651265 * '''Service:''' Libraries
     
    15641564Tags 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].
    15651565
    1566 Operations on resources include:
    1567 
     1566=== Viewing Resources ===
     1567
     1568One 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:
     1569
     1570 * '''Service:''' Resources
     1571 * '''Operation:''' viewResources
     1572 * '''Input Parameters:'''
     1573   * Userid - a string, if given return all experiments this user can see
     1574   * Type - a string, if given return only resources of this type
     1575   * Regex - a string containing a regular expression matched against experiment names
     1576   * Realization - an optional string.  If given return only resources in the given realization
     1577   * Persist - an optional boolean.  If given return only peristent resources
     1578   * tags - an array of name value pairs.  If given only return resources that are so tagged.
     1579 * '''Return Values:'''
     1580   * One or more structures with the following fields
     1581     * Name - a string containing the resource name
     1582     * Type - a string containing the type
     1583     * Description - an optional natural language description
     1584     * Tags - a list of name value pairs (strings)
     1585     * Facets - a list of data structures containing
     1586       * Name - the facet name
     1587       * Type - the type
     1588       * Value - the quantity
     1589       * Units - the units that define value
     1590       * Tags - a list of name value pairs (strings)
     1591     * ACL - a list of structures of the form
     1592       * Name - a string the circle name
     1593       * 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]
     1594
     1595Users - primarily administrators - can create or delete resources
    15681596
    15691597 * '''Service:''' Resources
    15701598 * '''Operation:''' createResource
    1571 String name, String type, Boolean persist, String description, ResourceFacet[] facets, ResourceTag[] tags, AccessMember[] accessLists
    1572 
    15731599 * '''Input Parameters:'''
    15741600   * Name - a string, the scoped, unique identifier of the resource
     
    15851611 * '''Return Values:'''
    15861612  * A boolean indicating success
     1613
     1614A resource is deleted using:
     1615 
     1616 * '''Service:''' Resources
     1617 * '''Operation:''' removeResource
     1618 * '''Input Parameters:'''
     1619   * Name - a string containing the resource to delete
     1620 * '''Return Values:'''
     1621   * a boolean, true on success
    15871622
    15881623