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