doc/api/methods/groups.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "groups"
   6 ...
   7
   8 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@
   9
  10 Object type: @j7d0g@
  11
  12 Example UUID: @zzzzz-j7d0g-0123456789abcde@
  13
  14 h2. Resource
  15
  16 Groups provides a way to apply the same permissions to a set of Arvados objects.  See "permission model":{{site.baseurl}}/api/permission-model.html for details.
  17
  18 Each Group has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Attribute|_. Type|_. Description|_. Example|
  22 |name|string|||
  23 |group_class|string|Type of group. This does not affect behavior, but determines how the group is presented in the user interface. For example, @project@ indicates that the group should be displayed by Workbench and arv-mount as a project for organizing and naming objects.|@"project"@
  24 null|
  25 |description|text|||
  26 |writable_by|array|List of UUID strings identifying Users and other Groups that have write permission for this Group.  Only users who are allowed to administer the Group will receive a full list.  Other users will receive a partial list that includes the Group's owner_uuid and (if applicable) their own user UUID.||
  27
  28 h2. Methods
  29
  30 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  31
  32 Required arguments are displayed in %{background:#ccffcc}green%.
  33
  34 h3. contents
  35
  36 Retrieve a list of items owned by the group.
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string|The UUID of the group in question.|path||
  43 |limit|integer (default 100)|Maximum number of items to return.|query||
  44 |order|string|Order in which to return matching items.  Sort within a resource type by prefixing the attribute with the resource name and a dot.|query|@"collections.modified_at desc"@|
  45 |filters|array|Conditions for filtering items.|query|@[["uuid", "is_a", "arvados#job"]]@|
  46
  47 Note: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in listed collections.  If you need it, request a "list of collections":{{site.baseurl}}/api/methods/collections.html with the filter @["owner_uuid", "=", GROUP_UUID]@, and @"manifest_text"@ listed in the select parameter.
  48
  49 Note: Use filters with the attribute format @<item type>.<field name>@ to filter items of a specific type. For example: @["pipeline_instances.state", "=", "Complete"]@ to filter @pipeline_instances@ where @state@ is @Complete@. All other types of items owned by this group will be unimpacted by this filter and will still be included.
  50
  51 h3. create
  52
  53 Create a new Group.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  59 |group|object||query||
  60
  61 h3. delete
  62
  63 Delete an existing Group.
  64
  65 Arguments:
  66
  67 table(table table-bordered table-condensed).
  68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  69 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  70
  71 h3. get
  72
  73 Gets a Group's metadata by UUID.
  74
  75 Arguments:
  76
  77 table(table table-bordered table-condensed).
  78 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  79 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  80
  81 h3. list
  82
  83 List groups.
  84
  85 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  86
  87 h3. show
  88
  89 show groups
  90
  91 Arguments:
  92
  93 table(table table-bordered table-condensed).
  94 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  95 {background:#ccffcc}.|uuid|string||path||
  96
  97 h3. update
  98
  99 Update attributes of an existing Group.
 100
 101 Arguments:
 102
 103 table(table table-bordered table-condensed).
 104 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 105 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
 106 |group|object||query||