Merge branch '9486-retry-instance-limit-exceeded' closes #9486
[arvados.git] / doc / api / methods / groups.html.textile.liquid
index e6e1e28e2730345df6f380e33a9ffbe3f7ae53ac..cd9633db427aa1807d4a600f6533225f543e4b34 100644 (file)
@@ -16,7 +16,7 @@ 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).
+Retrieve a list of items owned by the group.
 
 Arguments:
 
@@ -27,6 +27,10 @@ table(table table-bordered table-condensed).
 |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 @<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.
+
 h2. create
 
 Create a new Group.