doc/api/methods/humans.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "humans"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@
  12
  13 UUID type: @7a9it@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 Each Human has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Attribute|_. Type|_. Description|_. Example|
  23 |properties|hash|||
  24
  25 h2. Methods
  26
  27 h3. create
  28
  29 Create a new Human.
  30
  31 Arguments:
  32
  33 table(table table-bordered table-condensed).
  34 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  35 |human|object||query||
  36
  37 h3. delete
  38
  39 Delete an existing Human.
  40
  41 Arguments:
  42
  43 table(table table-bordered table-condensed).
  44 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  45 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  46
  47 h3. get
  48
  49 Gets a Human's metadata by UUID.
  50
  51 Arguments:
  52
  53 table(table table-bordered table-condensed).
  54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  55 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  56
  57 h3. list
  58
  59 List humans.
  60
  61 Arguments:
  62
  63 table(table table-bordered table-condensed).
  64 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  65 |limit|integer (default 100)|Maximum number of humans to return.|query||
  66 |order|string|Order in which to return matching humans.|query||
  67 |filters|array|Conditions for filtering humans.|query||
  68
  69 h3. update
  70
  71 Update attributes of an existing Human.
  72
  73 Arguments:
  74
  75 table(table table-bordered table-condensed).
  76 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  77 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  78 |human|object||query||