doc/api/schema/Group.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Schema
   5 title: Group
   6
   7 ...
   8
   9 A **Group** represents a set of objects. Groups allow you to organize content, define user roles, and apply permissions to sets of objects.
  10
  11 h2. Methods
  12
  13 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  14
  15 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@
  16
  17 h2. Creation
  18
  19 h3. Prerequisites
  20
  21 Prerequisites for creating a Group.
  22
  23 h3. Side effects
  24
  25 Side effects of creating a Group.
  26
  27 h2. Resources
  28
  29 Each Group has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  30
  31 table(table table-bordered table-condensed).
  32 |_. Attribute|_. Type|_. Description|_. Example|
  33 |name|string|||
  34 |group_class|string|Type of group. This does not affect behavior, but determines how the group is presented in the user interface. For example, @folder@ indicates that the group should be displayed by Workbench and arv-mount as a folder for organizing and naming objects.|@"folder"@
  35 null|
  36 |description|text|||
  37 |updated_at|datetime|||