X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7e52fd153f2d16f94061ef1eabfe653d4a83852a..6d6a0b0f7d5780c92c865ba2e6979195510c27b2:/doc/api/methods/specimens.html.textile.liquid diff --git a/doc/api/methods/specimens.html.textile.liquid b/doc/api/methods/specimens.html.textile.liquid index 316e115b54..6ee79ca3df 100644 --- a/doc/api/methods/specimens.html.textile.liquid +++ b/doc/api/methods/specimens.html.textile.liquid @@ -3,22 +3,24 @@ layout: default navsection: api navmenu: API Methods title: "specimens" - ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html - -UUID type: @j58dm@ +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@ -Required arguments are displayed in %{background:#ccffcc}green%. +Object type: @j58dm@ + +Example UUID: @zzzzz-j58dm-0123456789abcde@ h2. Resource A metadata record that may be used to represent a biological specimen. -Each Specimen has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: +Each Specimen has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| @@ -27,6 +29,10 @@ table(table table-bordered table-condensed). h2. Methods +See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. + +Required arguments are displayed in %{background:#ccffcc}green%. + h3. create Create a new Specimen. @@ -61,13 +67,7 @@ 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|| -|filters|array|Conditions for filtering specimens.|query|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index h3. update