X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/153056777f77f09a6d29543e73db315a7fb6b0fb..d8856736576e492edf08eba46b523880569e5123:/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 671ea1a49d..9f20a88a95 100644 --- a/doc/api/methods/groups.html.textile.liquid +++ b/doc/api/methods/groups.html.textile.liquid @@ -7,10 +7,28 @@ title: "groups" ... +See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html + +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. + h2. create Create a new Group. @@ -53,6 +71,16 @@ table(table table-bordered table-condensed). |order|string|Order in which to return matching groups.|query|| |filters|array|Conditions for filtering groups.|query|| +h2. show + +show groups + +Arguments: + +table(table table-bordered table-condensed). +|_. Argument |_. Type |_. Description |_. Location |_. Example | +{background:#ccffcc}.|uuid|string||path|| + h2. update Update attributes of an existing Group.