Changes between Version 25 and Version 26 of NewTestbedAPISpec


Ignore:
Timestamp:
Sep 11, 2013 5:58:42 PM (11 years ago)
Author:
faber
Comment:

experiment update

Legend:

Unmodified
Added
Removed
Modified

  • NewTestbedAPISpec

    v25 v26  
    10001000 * '''Operation:''' viewExperiments
    10011001 * '''Input Parameters:'''
    1002    * Userid - the user making the request
     1002   * Userid - a string, if given return all experiments this user can see (equivalent to giving userid:userid as the circle parameter)
    10031003   * ExperimentRE - a string containing a regular expression matched against project names (may be omitted)
    10041004   * Owner - a string holding the owner of experiments to find (may be omitted)
    1005    * Components - a 32-bit integer containing a mask of fields to include
     1005   * Circle - a string holding a circle name, if given restrict the results to those that can be read by this circle
     1006   * Components - a list of strings containing the fields to include.  Each is one of
    10061007     * EXPERIMENT_TOPOLOGY - include the topology
    10071008     * EXPERIMENT_ACTIONS - include the actions
    … …  
    10121013     * EXPERIMENT_LOG - include realization log and fault
    10131014     * EXPERIMENT_PERMISSIONS - include project permissions
    1014    * TopologyFormat - an optional 32-bit int naming the topology format
     1015   * TopologyFormat - a optional string naming the topology format.  It is one of
    10151016     * TOPOLOGY_TOPDL - return a topdl file
    10161017     * TOPOLOGY_NS2 - return an ns2 file
    … …  
    10521053        * ErrorString - a string describing the broad error
    10531054        * DetailString - a string describing the details that caused the error
    1054      * ReadProjects - a list of project names allowed to read this experiment
    1055      * WriteProjects - a list of project names allowed to modify this experiment
    1056      * RealizeProjects - a list of project names allowed to realize this experiment
     1055     * A list of strings giving the permissions of this user with respect to this experiment.  It can include
     1056       * EXPERIMENT_READ - the permission to read the experiment data structure
     1057       * EXPERIMENT_WRITE - the permission to modify the experiment data structure
     1058       * EXPERIMENT_REALIZE - the permission to realize the experiment
     1059     * list of circles and their corresponding permissions.  A user's permissions is the union of the circles it is in.  Each entry in the list contains
     1060        * Circle name
     1061        * A list of strings giving the permissions of this circle with respect to this experiment.  It can include
     1062          * EXPERIMENT_READ - the permission to read the experiment data structure
     1063          * EXPERIMENT_WRITE - the permission to modify the experiment data structure
     1064          * EXPERIMENT_REALIZE - the permission to realize the experiment
    10571065
    10581066=== Creating and Deleting Experiments ===
    … …  
    10691077   * Constraints - an optional file describing the experiment constraints s
    10701078   * DataCollection - an optional file describing the experiment data collection
    1071    * ReadProjects - a list of project names allowed to read this experiment
    1072    * WriteProjects - a list of project names allowed to modify this experiment
    1073    * RealizeProjects - a list of project names allowed to realize this experiment
    1074  * '''Return Values:'''
    1075    * None
     1079   * list of circles and their corresponding permissions.  A user's permissions is the union of the circles it is in.  Each entry in the list contains
     1080     * Circle name
     1081     * A list of strings giving the permissions of this circle with respect to this experiment.  It can include
     1082       * EXPERIMENT_READ - the permission to read the experiment data structure
     1083       * EXPERIMENT_WRITE - the permission to modify the experiment data structure
     1084       * EXPERIMENT_REALIZE - the permission to realize the experiment
     1085 * '''Return Values:'''
     1086   * a boolean, true if the creation succeeded
    10761087
    10771088An experiment is modified using:
    … …  
    10871098   * Constraints - an optional file describing the experiment constraints s
    10881099   * DataCollection - an optional file describing the experiment data collection
    1089    * ReadProjects - a list of project names allowed to read this experiment
    1090    * WriteProjects - a list of project names allowed to modify this experiment
    1091    * RealizeProjects - a list of project names allowed to realize this experiment
    1092  * '''Return Values:'''
    1093    * None
     1100   * list of circles and their corresponding permissions.  A user's permissions is the union of the circles it is in.  Each entry in the list contains
     1101     * Circle name
     1102     * A list of strings giving the permissions of this circle with respect to this experiment.  It can include
     1103       * EXPERIMENT_READ - the permission to read the experiment data structure
     1104       * EXPERIMENT_WRITE - the permission to modify the experiment data structure
     1105       * EXPERIMENT_REALIZE - the permission to realize the experiment
     1106 * '''Return Values:'''
     1107   * a boolean, true if the creation succeeded
     1108
    10941109
    10951110Omitted arguments are not overwritten.  To delete a field supply an empty description.