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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "groups"
   6
   7 ...
   8
   9
  10 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  11
  12 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@
  13
  14 Required arguments are displayed in %{background:#ccffcc}green%.
  15
  16 h2. Resource
  17
  18 Each Group has, in addition to the usual "attributes of Arvados resources":{{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 h3. contents
  31
  32 Retrieve a list of items owned by the group.
  33
  34 Arguments:
  35
  36 table(table table-bordered table-condensed).
  37 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  38 {background:#ccffcc}.|uuid|string|The UUID of the group in question.|path||
  39 |limit|integer (default 100)|Maximum number of items to return.|query||
  40 |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"@|
  41 |filters|array|Conditions for filtering items.|query|@[["uuid", "is_a", "arvados#job"]]@|
  42
  43 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.
  44
  45 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.
  46
  47 h3. create
  48
  49 Create a new Group.
  50
  51 Arguments:
  52
  53 table(table table-bordered table-condensed).
  54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  55 |group|object||query||
  56
  57 h3. delete
  58
  59 Delete an existing Group.
  60
  61 Arguments:
  62
  63 table(table table-bordered table-condensed).
  64 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  65 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  66
  67 h3. get
  68
  69 Gets a Group's metadata by UUID.
  70
  71 Arguments:
  72
  73 table(table table-bordered table-condensed).
  74 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  75 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  76
  77 h3. list
  78
  79 List groups.
  80
  81 Arguments:
  82
  83 table(table table-bordered table-condensed).
  84 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  85 |limit|integer (default 100)|Maximum number of groups to return.|query||
  86 |order|string|Order in which to return matching groups.|query||
  87 |filters|array|Conditions for filtering groups.|query||
  88
  89 h3. show
  90
  91 show groups
  92
  93 Arguments:
  94
  95 table(table table-bordered table-condensed).
  96 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  97 {background:#ccffcc}.|uuid|string||path||
  98
  99 h3. update
 100
 101 Update attributes of an existing Group.
 102
 103 Arguments:
 104
 105 table(table table-bordered table-condensed).
 106 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 107 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
 108 |group|object||query||