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 {% include 'notebox_begin_warning' %}
  15 This is a legacy API.  This endpoint is deprecated, disabled by default in new installations, and is slated to be removed entirely in a future major release of Arvados.  The recommended way to store metadata is with "'properties' field on collections and projects.":../properties.html
  16 {% include 'notebox_end' %}
  17
  18 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@
  19
  20 Object type: @7a9it@
  21
  22 Example UUID: @zzzzz-7a9it-0123456789abcde@
  23
  24 h2. Resource
  25
  26 A metadata record that may be used to represent a human subject.
  27
  28 Each Human has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Attribute|_. Type|_. Description|_. Example|
  32 |properties|hash|||
  33
  34 h2. Methods
  35
  36 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  37
  38 Required arguments are displayed in %{background:#ccffcc}green%.
  39
  40 h3. create
  41
  42 Create a new Human.
  43
  44 Arguments:
  45
  46 table(table table-bordered table-condensed).
  47 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  48 |human|object||query||
  49
  50 h3. delete
  51
  52 Delete an existing Human.
  53
  54 Arguments:
  55
  56 table(table table-bordered table-condensed).
  57 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  58 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  59
  60 h3. get
  61
  62 Gets a Human's metadata by UUID.
  63
  64 Arguments:
  65
  66 table(table table-bordered table-condensed).
  67 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  68 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  69
  70 h3. list
  71
  72 List humans.
  73
  74 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  75
  76 h3. update
  77
  78 Update attributes of an existing Human.
  79
  80 Arguments:
  81
  82 table(table table-bordered table-condensed).
  83 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  84 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
  85 |human|object||query||