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

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