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 owned by the group.
  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 |limit|integer (default 100)|Maximum number of items to return.|query||
  27 |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"@|
  28 |filters|array|Conditions for filtering items.|query|@[["uuid", "is_a", "arvados#job"]]@|
  29
  30 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.
  31
  32 h2. create
  33
  34 Create a new Group.
  35
  36 Arguments:
  37
  38 table(table table-bordered table-condensed).
  39 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  40 |group|object||query||
  41
  42 h2. delete
  43
  44 Delete an existing Group.
  45
  46 Arguments:
  47
  48 table(table table-bordered table-condensed).
  49 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  50 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  51
  52 h2. get
  53
  54 Gets a Group's metadata by UUID.
  55
  56 Arguments:
  57
  58 table(table table-bordered table-condensed).
  59 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  60 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  61
  62 h2. list
  63
  64 List groups.
  65
  66 Arguments:
  67
  68 table(table table-bordered table-condensed).
  69 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  70 |limit|integer (default 100)|Maximum number of groups to return.|query||
  71 |order|string|Order in which to return matching groups.|query||
  72 |filters|array|Conditions for filtering groups.|query||
  73
  74 h2. show
  75
  76 show groups
  77
  78 Arguments:
  79
  80 table(table table-bordered table-condensed).
  81 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  82 {background:#ccffcc}.|uuid|string||path||
  83
  84 h2. update
  85
  86 Update attributes of an existing Group.
  87
  88 Arguments:
  89
  90 table(table table-bordered table-condensed).
  91 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  92 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  93 |group|object||query||