X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/715869b9a22e22ac68a7dbefa96f27150017f75d..f4ca9ad94a6bb006d1f3c7ba207837f1736d1247:/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 f56542dc6b..6737c9bcae 100644 --- a/doc/api/methods/specimens.html.textile.liquid +++ b/doc/api/methods/specimens.html.textile.liquid @@ -6,7 +6,9 @@ title: "specimens" ... -h1. specimens +See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html + +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@ Required arguments are displayed in %{background:#ccffcc}green%. @@ -31,16 +33,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path|| -h2. destroy - -destroy specimens - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| - h2. get Gets a Specimen's metadata by UUID. @@ -51,17 +43,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path|| -h2. index - -index specimens - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List specimens. @@ -72,19 +53,7 @@ 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|| +|filters|array|Conditions for filtering specimens.|query|| h2. update