X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b2979b0db0b6b5ee7ad3001ffcc8f76ff4d96f05..d8616b7126de7e234b901b9bb166b5e4203da3c0:/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 478662eea8..cd9633db42 100644 --- a/doc/api/methods/groups.html.textile.liquid +++ b/doc/api/methods/groups.html.textile.liquid @@ -16,17 +16,20 @@ Required arguments are displayed in %{background:#ccffcc}green%. h2. contents -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). +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|| -|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) -@true@| +|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"]]@| -If @include_linked@ is @true@, the @"links"@ field in the response will contain the "name" links referencing the objects in the @"items"@ field. +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