X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/715869b9a22e22ac68a7dbefa96f27150017f75d..0f361d9a0748e2b470ed5bc73351cb2eaf3e02e3:/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 a0e715b58e..c4f2fd6215 100644 --- a/doc/api/methods/humans.html.textile.liquid +++ b/doc/api/methods/humans.html.textile.liquid @@ -6,44 +6,41 @@ title: "humans" ... -h1. humans +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@ -Required arguments are displayed in %{background:#ccffcc}green%. +Object type: @7a9it@ +Example UUID: @zzzzz-7a9it-0123456789abcde@ -h2. create +h2. Resource -Create a new Human. +A metadata record that may be used to represent a human subject. -Arguments: +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|| - -h2. delete +|_. Attribute|_. Type|_. Description|_. Example| +|properties|hash||| -Delete an existing Human. +h2. Methods -Arguments: +See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path|| +Required arguments are displayed in %{background:#ccffcc}green%. -h2. destroy +h3. create -destroy humans +Create a new Human. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| +|human|object||query|| -h2. get +h3. delete -Gets a Human's metadata by UUID. +Delete an existing Human. Arguments: @@ -51,42 +48,23 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path|| -h2. index +h3. get -index humans +Gets a Human's metadata by UUID. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| +{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|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching humans.|query|| -|where|object|Conditions for filtering humans.|query|| - -h2. show - -show humans - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index -h2. update +h3. update Update attributes of an existing Human.