X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/153056777f77f09a6d29543e73db315a7fb6b0fb..aec1081434d75a6bb73baf096139d1d214dd1f47:/doc/api/methods/humans.html.textile.liquid diff --git a/doc/api/methods/humans.html.textile.liquid b/doc/api/methods/humans.html.textile.liquid index bc9473bd8a..e08e941cf6 100644 --- a/doc/api/methods/humans.html.textile.liquid +++ b/doc/api/methods/humans.html.textile.liquid @@ -5,13 +5,37 @@ navmenu: API Methods title: "humans" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} +p=. *Deprecated, likely to be removed in a future version. The recommended way to store metadata is "collection properties":collections.html* -Required arguments are displayed in %{background:#ccffcc}green%. +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@ + +Object type: @7a9it@ + +Example UUID: @zzzzz-7a9it-0123456789abcde@ + +h2. Resource + +A metadata record that may be used to represent a human subject. + +Each Human has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: + +table(table table-bordered table-condensed). +|_. Attribute|_. Type|_. Description|_. Example| +|properties|hash||| +h2. Methods -h2. create +See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. + +Required arguments are displayed in %{background:#ccffcc}green%. + +h3. create Create a new Human. @@ -21,7 +45,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |human|object||query|| -h2. delete +h3. delete Delete an existing Human. @@ -31,7 +55,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path|| -h2. get +h3. get Gets a Human's metadata by UUID. @@ -41,19 +65,13 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path|| -h2. list +h3. list List humans. -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|limit|integer (default 100)|Maximum number of humans to return.|query|| -|order|string|Order in which to return matching humans.|query|| -|filters|array|Conditions for filtering humans.|query|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index -h2. update +h3. update Update attributes of an existing Human.