X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/35336cd73e444534cb2eda20e3730464cc4e6553..051efbd3d843baa690b334e57fd09fad6a908bb9:/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 dd3fcedb83..0d4b2ccd1a 100644 --- a/doc/api/methods/humans.html.textile.liquid +++ b/doc/api/methods/humans.html.textile.liquid @@ -6,12 +6,25 @@ title: "humans" ... +See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@ + +UUID type: @7a9it@ Required arguments are displayed in %{background:#ccffcc}green%. +h2. Resource + +Each Human has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: + +table(table table-bordered table-condensed). +|_. Attribute|_. Type|_. Description|_. Example| +|properties|hash||| -h2. create +h2. Methods + +h3. create Create a new Human. @@ -21,7 +34,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |human|object||query|| -h2. delete +h3. delete Delete an existing Human. @@ -31,17 +44,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. destroy - -destroy humans - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| - -h2. get +h3. get Gets a Human's metadata by UUID. @@ -51,18 +54,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. index - -index humans - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - -h2. list +h3. list List humans. @@ -72,21 +64,9 @@ 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|| +|filters|array|Conditions for filtering humans.|query|| -h2. update +h3. update Update attributes of an existing Human.