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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "humans"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 p=. *Deprecated, likely to be removed in a future version.  The recommended way to store metadata is "collection properties":collections.html*
  15
  16 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@
  17
  18 Object type: @7a9it@
  19
  20 Example UUID: @zzzzz-7a9it-0123456789abcde@
  21
  22 h2. Resource
  23
  24 A metadata record that may be used to represent a human subject.
  25
  26 Each Human has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  27
  28 table(table table-bordered table-condensed).
  29 |_. Attribute|_. Type|_. Description|_. Example|
  30 |properties|hash|||
  31
  32 h2. Methods
  33
  34 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  35
  36 Required arguments are displayed in %{background:#ccffcc}green%.
  37
  38 h3. create
  39
  40 Create a new Human.
  41
  42 Arguments:
  43
  44 table(table table-bordered table-condensed).
  45 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  46 |human|object||query||
  47
  48 h3. delete
  49
  50 Delete an existing Human.
  51
  52 Arguments:
  53
  54 table(table table-bordered table-condensed).
  55 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  56 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  57
  58 h3. get
  59
  60 Gets a Human's metadata by UUID.
  61
  62 Arguments:
  63
  64 table(table table-bordered table-condensed).
  65 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  66 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  67
  68 h3. list
  69
  70 List humans.
  71
  72 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  73
  74 h3. update
  75
  76 Update attributes of an existing Human.
  77
  78 Arguments:
  79
  80 table(table table-bordered table-condensed).
  81 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  82 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  83 |human|object||query||