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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "specimens"
   6 ...
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 p=. *Deprecated, likely to be removed in a future version.  The recommended way to store metadata is "collection properties":collections.html*
  14
  15 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@
  16
  17 Object type: @j58dm@
  18
  19 Example UUID: @zzzzz-j58dm-0123456789abcde@
  20
  21 h2. Resource
  22
  23 A metadata record that may be used to represent a biological specimen.
  24
  25 Each Specimen has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  26
  27 table(table table-bordered table-condensed).
  28 |_. Attribute|_. Type|_. Description|_. Example|
  29 |material|string|||
  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 Specimen.
  41
  42 Arguments:
  43
  44 table(table table-bordered table-condensed).
  45 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  46 |specimen|object||query||
  47
  48 h3. delete
  49
  50 Delete an existing Specimen.
  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 Specimen in question.|path||
  57
  58 h3. get
  59
  60 Gets a Specimen'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 Specimen in question.|path||
  67
  68 h3. list
  69
  70 List specimens.
  71
  72 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  73
  74 h3. update
  75
  76 Update attributes of an existing Specimen.
  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 Specimen in question.|path||
  83 |specimen|object||query||