navsection: api
navmenu: API Methods
title: "specimens"
-
...
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@
+Object type: @j58dm@
-Required arguments are displayed in %{background:#ccffcc}green%.
-
+Example UUID: @zzzzz-j58dm-0123456789abcde@
-h2. create
+h2. Resource
-Create a new Specimen.
+A metadata record that may be used to represent a biological specimen.
-Arguments:
+Each Specimen has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|specimen|object||query||
-
-h2. delete
+|_. Attribute|_. Type|_. Description|_. Example|
+|material|string|||
+|properties|hash|||
-Delete an existing Specimen.
+h2. Methods
-Arguments:
+See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
+Required arguments are displayed in %{background:#ccffcc}green%.
-h2. destroy
+h3. create
-destroy specimens
+Create a new Specimen.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+|specimen|object||query||
-h2. get
+h3. delete
-Gets a Specimen's metadata by UUID.
+Delete an existing Specimen.
Arguments:
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
-h2. index
+h3. get
-index specimens
+Gets a Specimen's metadata by UUID.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|order|string||query||
-|where|object||query||
+{background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
-h2. list
+h3. list
List specimens.
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|limit|integer (default 100)|Maximum number of specimens to return.|query||
-|order|string|Order in which to return matching specimens.|query||
-|pageToken|string|Page token.|query||
-|q|string|Query string for searching specimens.|query||
-|where|object|Conditions for filtering specimens.|query||
-
-h2. show
-
-show specimens
-
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index
-h2. update
+h3. update
Update attributes of an existing Specimen.