X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/172496748cb0a149426e8a10cb4fd1c64e20dbe7..332b0d1b4a9095f4e43893ec741f901b74b36ceb:/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 a5170badd0..e08e941cf6 100644 --- a/doc/api/methods/humans.html.textile.liquid +++ b/doc/api/methods/humans.html.textile.liquid @@ -5,43 +5,57 @@ 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@ -h2. create +Example UUID: @zzzzz-7a9it-0123456789abcde@ -Create a new Human. +h2. Resource -Arguments: +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). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|human|object||query|| +|_. Attribute|_. Type|_. Description|_. Example| +|properties|hash||| -h2. delete +h2. Methods -Delete an existing Human. +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. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path|| +|human|object||query|| -h2. destroy +h3. delete -destroy humans +Delete an existing Human. 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 Human in question.|path|| -h2. get +h3. get Gets a Human's metadata by UUID. @@ -51,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.