use the same API host for all examples

[arvados.git] / doc / api / Jobs.textile

diff --git a/doc/api/Jobs.textile b/doc/api/Jobs.textile
index 08ac010f55657712237a23d0e69553657ece9b9d..8c374a4eebfef9b6883169afcc9a1a0fa61e6125 100644 (file)
--- a/doc/api/Jobs.textile
+++ b/doc/api/Jobs.textile
@@ -14,16 +14,30 @@ Applications submit compute jobs when:
 
 h2. Methods
 
-See "REST methods for working with Orvos resources":methods.html
+See "REST methods for working with Arvados resources":methods.html
 
-API endpoint base: @https://xyzzy.arvados.org/arvados/v1/jobs@
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/jobs@
 
-h2. Additional parameters for "Create" method
+h3. Additional parameters for "Create" method
 
 table(table table-bordered table-condensed).
 |*Parameter name*|*Type*|*Description*|
 |allow_duplicate|boolean|If true, a new job is submitted even if an identical job has already been submitted (and has not failed). If false or not supplied, a new job will _not_ be submitted and the existing job will be returned in the API response.|
 
+h3. Queue
+
+<pre>
+GET https://{{ site.arvados_api_host }}/arvados/v1/jobs/queue
+ 
+POST https://{{ site.arvados_api_host }}/arvados/v1/jobs/queue
+_method=GET
+where[owner]=xyzzy-tpzed-a4lcehql0dv2u25
+</pre>
+
+&rarr; Job resource list
+
+This method is equivalent to the "index method":methods.html#index, except that the results are restricted to queued jobs (i.e., jobs that have not yet been started or cancelled) and order defaults to queue priority.
+
 h2. Resource
 
 Each job has, in addition to the usual "attributes of Arvados resources":resources.html: