Changes between Version 27 and Version 28 of NewTestbedAPISpec

Timestamp:

Jul 8, 2014 2:55:14 PM (10 years ago)

Author:

faber

Comment:

--

NewTestbedAPISpec

@@ -1161 +1161 @@
 After {{{releaseExperiment}}} succeeds, experiment state remains in the testbed, but containers are stopped and resources are returned to the testbed.
 
+=== Experiment Profiles ===
+
+Experiments have profiles attached to them, as users, circles, and projects do.  Information in a profile is metadata about the experiment, intended for human consumption.  This is in opposition to an aspect which is intended for the testbed or experiment infrastructure to interpret.
+
+The calls for manipulating an experiment profile are very similar to other profiles:
+
+To get a profile schema, for example to create an empty web page,
+
+ * '''Service:''' Experiments
+ * '''Operation:''' getProfileDescription
+ * '''Input Parameters:'''
+ * '''Return Values:'''
+   * ExperimentId - always empty
+   * A list of profile elements each containing
+     * Name - a string, the element's name
+     * DataType - a string giving the element's
+       * string
+       * integer
+       * double
+       * binary/opaque
+     * Value - a string containing the element's value
+     * Access - a string describing the access values (values [http://www.isi.edu/~faber/tmp/DeterAPI/doc/constant-values.html here])
+     * Optional - a flag true if the field is optional (must be present but may be empty)
+     * Removable - a flag true if the field can be removed
+     * Description - a string explaining the field
+     * Format - a regular expression that can be used to validate the field entry (may be null, and generally is for optional fields)
+     * FormatDescription - A brief, natural language description of the field input constraints, e.g. "A valid e-mail address" or "only numbers and spaces".
+     * OrderingHint - an integer suggesting where to present the attribute. Lower numbers come first
+     * LengthHint - an integer suggesting how long an input firld should be presented
+
+To read an experiment's profile.
+
+ * '''Service:''' Experiments
+ * '''Operation:''' getExperimentProfile
+ * '''Input Parameters:'''
+  * eid - a string naming the experiment to be retrieved
+ * '''Return Values:'''
+   * ExperimentId - the experiment whose profile is returned
+   * A list of profile elements each containing
+     * Name - a string, the element's name
+     * DataType - a string giving the element's
+       * string
+       * integer
+       * double
+       * binary/opaque
+     * Value - a string containing the element's value
+     * Access - a string describing the access values (Defined [http://www.isi.edu/~faber/tmp/DeterAPI/doc/constant-values.html here])
+     * Optional - a flag true if the field is optional (must be present but may be empty)
+     * Removable - a flag true if the field can be removed
+     * Description - a string explaining the field
+     * Format - a regular expression that can be used to validate the field entry (may be null, and generally is for optional fields)
+     * FormatDescription - A brief, natural language description of the field input constraints, e.g. "A valid e-mail address" or "only numbers and spaces".
+     * OrderingHint - an integer suggesting where to present the attribute. Lower numbers come first
+     * LengthHint - an integer suggesting how long an input field should be presented
+
+Finally a user can modify an experiment profile:
+ 
+ * '''Service:''' Experiments
+ * '''Operation:''' changeExperimentProfile
+ * '''Input Parameters:'''
+   * Eid - the experiment's profile to modify
+   * A list of change requests. Each request contains
+     * Name - the name of the field to change
+     * Value - the new value of the field
+     * Delete - a flag, if true delete the field rather than modify it
+ * '''Return Values:'''
+   * A list of responses each containing
+    * Name - astring with the name of the field
+    * Success - a flag indicating if the request succeeded
+    * Reason - a string indicating the reason if Success is false
+
+
+=== Manipulating Profile Attributes ===
+
+Administrators may add attributes to experiment profiles or remove them.  That is to say, add a schema (including format constraints and descriptions), not set a value for a project.
+
+Creating an attribute:
+
+* '''Service:''' Experiments
+ * '''Operation:''' createExperimentAttribute
+ * '''Input Parameters:'''
+   * Name - the attribute name
+   * Type - the type (STRING, INT, FLOAT, OPAQUE)
+   * Optional - a boolean, true if this attribute is optional
+   * Access - a string: the user's ability to modify (READ_WRITE, READ_ONLY, WRITE_ONLY, NO_ACCESS)
+   * Description - natural language description of the field (optional)
+   * Format - a regular expression describing the format (optional)
+   * Formatdescription - a natural language explanation of the format (optional)
+   * OrderingHint - an integer suggesting where to present the attribute. Lower numbers come first
+   * LengthHint - an integer suggesting how long an input 
+   * Def - default value of the attribute (will be set for all users)
+ * '''Return Values:'''
+  * a boolean, true if the attribute was created 
+
+And removing an attribute:
+
+* '''Service:''' Experiments
+ * '''Operation:''' removeExperimentAttribute
+ * '''Input Parameters:'''
+   * Name - the attribute name
+ * '''Return Values:'''
+  * a boolean, true if the attribute was removed 
+
+Finally administrators can modify profile attributes:
+
+* '''Service:''' Experiments
+ * '''Operation:''' modifyExperimentAttribute
+ * '''Input Parameters:'''
+   * Name - the attribute name
+   * Type - the type (STRING, INT, FLOAT, OPAQUE)
+   * Optional - a boolean, true if this attribute is optional
+   * Access - a string: the user's ability to modify (READ_WRITE, READ_ONLY, WRITE_ONLY, NO_ACCESS)
+   * Description - natural language description of the field (optional)
+   * Format - a regular expression describing the format (optional)
+   * Formatdescription - a natural language explanation of the format (optional)
+   * OrderingHint - an integer suggesting where to present the attribute. Lower numbers come first
+   * LengthHint - an integer suggesting how long an input 
+ * '''Return Values:'''
+  * a boolean, true if the attribute was created 
+
+
 == Admin ==