X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/6d2128ae15825ef03472897e09710b176e3cc1d9..f00a2304c3668e74c6ab53e27793166b02b709d2:/doc/api/methods/groups.html.textile.liquid diff --git a/doc/api/methods/groups.html.textile.liquid b/doc/api/methods/groups.html.textile.liquid index 9394d7691e..cd9633db42 100644 --- a/doc/api/methods/groups.html.textile.liquid +++ b/doc/api/methods/groups.html.textile.liquid @@ -14,6 +14,23 @@ API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@ Required arguments are displayed in %{background:#ccffcc}green%. +h2. contents + +Retrieve a list of items owned by the group. + +Arguments: + +table(table table-bordered table-condensed). +|_. Argument |_. Type |_. Description |_. Location |_. Example | +{background:#ccffcc}.|uuid|string|The UUID of the group in question.|path|| +|limit|integer (default 100)|Maximum number of items to return.|query|| +|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"@| +|filters|array|Conditions for filtering items.|query|@[["uuid", "is_a", "arvados#job"]]@| + +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. + +Note: Use filters with the attribute format @.@ 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. + h2. create Create a new Group. @@ -56,18 +73,6 @@ table(table table-bordered table-condensed). |order|string|Order in which to return matching groups.|query|| |filters|array|Conditions for filtering groups.|query|| -h2. owned_items - -Retrieve a list of items which are owned by the given group. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the group in question.|path|| -|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) -@true@| - h2. show show groups