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