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 {% include 'notebox_begin_warning' %}
  14 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
  15 {% include 'notebox_end' %}
  16
  17 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@
  18
  19 Object type: @j58dm@
  20
  21 Example UUID: @zzzzz-j58dm-0123456789abcde@
  22
  23 h2. Resource
  24
  25 A metadata record that may be used to represent a biological specimen.
  26
  27 Each Specimen has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  28
  29 table(table table-bordered table-condensed).
  30 |_. Attribute|_. Type|_. Description|_. Example|
  31 |material|string|||
  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 Specimen.
  43
  44 Arguments:
  45
  46 table(table table-bordered table-condensed).
  47 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  48 |specimen|object||query||
  49
  50 h3. delete
  51
  52 Delete an existing Specimen.
  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 Specimen in question.|path||
  59
  60 h3. get
  61
  62 Gets a Specimen'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 Specimen in question.|path||
  69
  70 h3. list
  71
  72 List specimens.
  73
  74 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  75
  76 h3. update
  77
  78 Update attributes of an existing Specimen.
  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 Specimen in question.|path||
  85 |specimen|object||query||