X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b54a5ea817d3d2087eaa07dcf98ec8a82af56d06..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 f897eab2b8..9f20a88a95 100644 --- a/doc/api/methods/groups.html.textile.liquid +++ b/doc/api/methods/groups.html.textile.liquid @@ -6,40 +6,48 @@ title: "groups" ... -h1. 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. create +h2. contents -Create a new Group. +Retrieve a list of items owned by the group. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -|group|object||query|| +{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"]]@| -h2. delete +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. -Delete an existing Group. +h2. create + +Create a new 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|| +|group|object||query|| -h2. destroy +h2. delete -destroy groups +Delete an existing Group. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| +{background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path|| h2. get @@ -51,17 +59,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path|| -h2. index - -index groups - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List groups. @@ -72,9 +69,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of groups to return.|query|| |order|string|Order in which to return matching groups.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching groups.|query|| -|where|object|Conditions for filtering groups.|query|| +|filters|array|Conditions for filtering groups.|query|| h2. show