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