X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7a98271d94163cdc4afa5bfcf275db353bc062d2..cd08497d1c914cd75fd8be08f9f3ef3bc75485f2:/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 e09b8177d5..9394d7691e 100644 --- a/doc/api/methods/groups.html.textile.liquid +++ b/doc/api/methods/groups.html.textile.liquid @@ -7,6 +7,9 @@ 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%. @@ -31,16 +34,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. destroy - -destroy groups - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| - h2. get Gets a Group's metadata by UUID. @@ -51,30 +44,29 @@ 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 +h2. list -index groups +List groups. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| +|limit|integer (default 100)|Maximum number of groups to return.|query|| +|order|string|Order in which to return matching groups.|query|| +|filters|array|Conditions for filtering groups.|query|| -h2. list +h2. owned_items -List groups. +Retrieve a list of items which are owned by the given group. Arguments: 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|| +{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