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