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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "specimens"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 UUID type: @j58dm@
  12
  13 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 Each Specimen has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Attribute|_. Type|_. Description|_. Example|
  23 |material|string|||
  24 |properties|hash|||
  25
  26 h2. Methods
  27
  28 h3. create
  29
  30 Create a new Specimen.
  31
  32 Arguments:
  33
  34 table(table table-bordered table-condensed).
  35 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  36 |specimen|object||query||
  37
  38 h3. delete
  39
  40 Delete an existing Specimen.
  41
  42 Arguments:
  43
  44 table(table table-bordered table-condensed).
  45 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  46 {background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
  47
  48 h3. get
  49
  50 Gets a Specimen's metadata by UUID.
  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. list
  59
  60 List specimens.
  61
  62 Arguments:
  63
  64 table(table table-bordered table-condensed).
  65 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  66 |limit|integer (default 100)|Maximum number of specimens to return.|query||
  67 |order|string|Order in which to return matching specimens.|query||
  68 |filters|array|Conditions for filtering specimens.|query||
  69
  70 h3. update
  71
  72 Update attributes of an existing Specimen.
  73
  74 Arguments:
  75
  76 table(table table-bordered table-condensed).
  77 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  78 {background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
  79 |specimen|object||query||