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
  17 h2. create
  18
  19 Create a new Group.
  20
  21 Arguments:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  25 |group|object||query||
  26
  27 h2. delete
  28
  29 Delete an existing Group.
  30
  31 Arguments:
  32
  33 table(table table-bordered table-condensed).
  34 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  35 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  36
  37 h2. get
  38
  39 Gets a Group's metadata by UUID.
  40
  41 Arguments:
  42
  43 table(table table-bordered table-condensed).
  44 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  45 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  46
  47 h2. list
  48
  49 List groups.
  50
  51 Arguments:
  52
  53 table(table table-bordered table-condensed).
  54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  55 |limit|integer (default 100)|Maximum number of groups to return.|query||
  56 |order|string|Order in which to return matching groups.|query||
  57 |filters|array|Conditions for filtering groups.|query||
  58
  59 h2. owned_items
  60
  61 Retrieve a list of items which are owned by the given group.
  62
  63 Arguments:
  64
  65 table(table table-bordered table-condensed).
  66 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  67 {background:#ccffcc}.|uuid|string|The UUID of the group in question.|path||
  68 |include_linked|boolean|If true, results will also include items on which the given group has _can_manage_ permission, even if they are owned by different users/groups.|path|{white-space:nowrap}. @false@ (default)
  69 @true@|
  70
  71 h2. show
  72
  73 show groups
  74
  75 Arguments:
  76
  77 table(table table-bordered table-condensed).
  78 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  79 {background:#ccffcc}.|uuid|string||path||
  80
  81 h2. update
  82
  83 Update attributes of an existing Group.
  84
  85 Arguments:
  86
  87 table(table table-bordered table-condensed).
  88 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  89 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  90 |group|object||query||