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 A metadata record that may be used to represent a human subject.
  20
  21 Each Human has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Example|
  25 |properties|hash|||
  26
  27 h2. Methods
  28
  29 h3. create
  30
  31 Create a new Human.
  32
  33 Arguments:
  34
  35 table(table table-bordered table-condensed).
  36 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  37 |human|object||query||
  38
  39 h3. delete
  40
  41 Delete an existing Human.
  42
  43 Arguments:
  44
  45 table(table table-bordered table-condensed).
  46 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  47 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  48
  49 h3. get
  50
  51 Gets a Human's metadata by UUID.
  52
  53 Arguments:
  54
  55 table(table table-bordered table-condensed).
  56 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  57 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  58
  59 h3. list
  60
  61 List humans.
  62
  63 Arguments:
  64
  65 table(table table-bordered table-condensed).
  66 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  67 |limit|integer (default 100)|Maximum number of humans to return.|query||
  68 |order|string|Order in which to return matching humans.|query||
  69 |filters|array|Conditions for filtering humans.|query||
  70
  71 h3. update
  72
  73 Update attributes of an existing Human.
  74
  75 Arguments:
  76
  77 table(table table-bordered table-condensed).
  78 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  79 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  80 |human|object||query||