projects
/
arvados.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge branch '13933-dispatch-batch-size'
[arvados.git]
/
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 22cd7fedc9cc474fdfaa2e793c830842a99678d2..84cb22c99738755dded5f6cea7b35cf02ecfdf2f 100644
(file)
--- a/
doc/api/methods/humans.html.textile.liquid
+++ b/
doc/api/methods/humans.html.textile.liquid
@@
-5,45
+5,47
@@
navmenu: API Methods
title: "humans"
...
title: "humans"
...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+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.
creat
e
+h2.
Resourc
e
-
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).
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%.
-h
2. destroy
+h
3. create
-destroy humans
+Create a new Human.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-
{background:#ccffcc}.|uuid|string||path
||
+
|human|object||query
||
-h
2. get
+h
3. delete
-
Gets a Human's metadata by UUID
.
+
Delete an existing Human
.
Arguments:
Arguments:
@@
-51,29
+53,23
@@
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
-h
2. lis
t
+h
3. ge
t
-
List humans
.
+
Gets a Human's metadata by UUID
.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
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||
-
-h2. show
+{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
-show humans
+h3. list
-Arguments:
+List humans.
-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
-h
2
. update
+h
3
. update
Update attributes of an existing Human.
Update attributes of an existing Human.