Changes between Version 26 and Version 27 of SPIDocs


Ignore:
Timestamp:
Sep 26, 2014 5:07:09 PM (8 years ago)
Author:
faber
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • SPIDocs

    v26 v27  
    434434==== Circle Ownership ====
    435435
    436 When a circle is created, an owner for that circle is designated.  It is generally the user who successfully called `createCircle`, though ownership may be designated for projects created by administrators. Ownership primarily means that the owner cannot be removed from the circle and controls the [wiki:SPIDocs#CircleProfileManagement profile contents].
     436When a circle is created, an owner for that circle is designated.  It is generally the user who successfully called `createCircle`, though ownership may be designated for circles created by administrators. Ownership primarily means that the owner cannot be removed from the circle and controls the [wiki:SPIDocs#CircleProfileManagement profile contents].
    437437
    438438The owner (and administrators) can change the owner of a circle by calling the `setOwner` operation in the `Circles` service.
     
    444444==== Circle Profile Management ====
    445445
    446 The `Circles` [wiki:SPIDocs#Services service] supports the operations described in the [wiki:SPIDocs#Profiles profiles] description to allow applications to manipulate project profiles.  Only the owner of a circle can change the contents of its profile.
     446The `Circles` [wiki:SPIDocs#Services service] supports the operations described in the [wiki:SPIDocs#Profiles profiles] description to allow applications to manipulate circle profiles.  Only the owner of a circle can change the contents of its profile.
    447447
    448448==== Viewing Circles ====
     
    472472The layout, procedure, data requirements and constraints on an experiment are sub-abstractions of an experiment called ''aspects''.  An experiment does not necessarily contain all aspects.  When a researcher first comes to DETERLab, their models and ideas are likely to be loosely defined.  We expect them to realize experiments that have only layout aspects.  As their ideas become more concrete and their results more stable, the other aspects become more fleshed out.
    473473
    474 Ee present a worked example of the [LayoutAspect layout aspect] that illustrates this.
     474We present a worked example of the [LayoutAspect layout aspect] that illustrates this.
    475475
    476476Experiments also have [wiki:SPIDocs#Profiles profiles] attached to them so that other users can understand the purpose and goals of a project without investigating the aspects in detail.
     
    557557A user can call `changeExperimentACL` with a list in the same format.  New entries will be added, existing entries will be overwritten, and entries with an empty permission list will be removed.  A partial success is possible and the result of each change is returned.
    558558
     559==== Experiment Ownership ====
     560
     561When an experiment is created, an owner for that experiment is designated.  It is generally the user who successfully called `createExperiment`, though ownership may be designated for experiments created by administrators. An owner retains all permissions to manipulate the experiment regardless of ACLs and  controls the [wiki:SPIDocs#CircleProfileManagement profile contents].
     562
     563The owner (and administrators) can change the owner of a experiment by calling the `setOwner` operation in the `Experiments` service.
     564
     565==== Experiment Profile Management ====
     566
     567The `Experiment` [wiki:SPIDocs#Services service] supports the operations described in the [wiki:SPIDocs#Profiles profiles] description to allow applications to manipulate experiment profiles.  Only the owner of an experiment can change the contents of its profile.
    559568
    560569==== Viewing Experiments ====
    561570
    562 A user can always view circles that they can read.  The `viewExperiments` operation on the `Experiments` [wiki:SPIDocs#Services service] returns summaries of the various experiments.  Experiment descriptions contain more information than the descriptions of circles.  Specifically aspects and ACLs can be selected individually to be shown for each experiment returned.
     571A user can always view circles that they can read.  The `viewExperiments` operation on the `Experiments` [wiki:SPIDocs#Services service] returns descriptions of the various experiments.  Experiment descriptions contain more information than the descriptions of circles.  Specifically aspects and ACLs can be selected individually to be shown for each experiment returned.
    563572
    564573The `viewExperiments` operation takes the following parameters:
     
    567576|| uid || Return experiments this user can read. Admins may successfully view experiments as another user, but most users can only specify their own userid here. ||
    568577|| lib || Restrict returned experiments to those in this [wiki:SPIDocs#Libraries library] ||
    569 || regex || Restrict returned experiments to those that have an experimentid that matches the given [http://en.wikipedia.org/wiki/Regular_expression regular expression]
    570 
    571 
    572 
    573 The description
    574 
    575 The `viewCircles` operation takes the user doing the search and an optional [http://en.wikipedia.org/wiki/Regular_expression regular expression] that scopes the search.  If the regular expression is given, only circleids matching it are returned.  Administrators can use `viewCircles` to get a list of circle descriptions visible to a given user.
    576 
     578|| regex || Restrict returned experiments to those that have an experimentid that matches the given [http://en.wikipedia.org/wiki/Regular_expression regular expression] ||
     579|| queryAspects || Restrict the output aspects of each experiment description to aspects that match one of the list of tuples given.  Each tuple is a (type, sub-type, name) tuple. If the name is not null, it much match. If the type is not null it must also match. If a type is given the sub-type field further scopes the search. A null type field selects aspects without any sub-type. A specific sub-type selects only aspects that match both type and sub-type, and the distinguished value "*" matches any subtype. A sub-type with a null type is invalid. ||
     580|| listOnly || If true, do not return aspect data in the response ||
     581|| offset || Begin returning experiment descriptions at this position of a global list of matching experiments, ordered by creation time.  This allows incremental retrieval of experiment lists ||
     582|| count || Return only this many experiment descriptions ||
     583
     584Each description contains the following information.
     585
     586||= Parameter =||= Meaning =||
     587|| experiment ID || The unique experiment identifier ||
     588|| owner || The userid of the owner ||
     589|| perms || The permissions that the uid can exert on the experiment.  This allows an application to report the permissions without calculating them from the circles in the ACL ||
     590|| ACL || The access control list as a list of (circle, (permissions,...) ) pairs.  Permissions is a list of permissions. ||
     591|| Aspects || The aspects that match the queryAspects parameter as a list of (type, sub-type, name, data block) tuples.  If listOnly was given, the data blocks will be empty. ||
     592
     593==== Administrative Operations ====
     594
     595There are a few more operations that are restricted to administrators.
     596
     597There are [wiki:SPIDocs#Profiles profile] operations to add, remove and change attributes to the experiment profile schema.
     598
     599These are documented below.