---
layout: default
navsection: api
navmenu: Schema
title: Job

...



Applications submit compute jobs when:
* Provenance is important, i.e., it is worth recording how the output was produced; or
* Computation time is significant; or
* The job management features are convenient (failure detection/recovery, regression testing, etc).

h2. Methods

See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html

API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/jobs@

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_uuid]=xyzzy-tpzed-a4lcehql0dv2u25
</pre>

&rarr; Job resource list

This method is equivalent to the "index method":{{site.baseurl}}/api/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":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Notes|
|submit_id|string|Unique ID provided by client when job was submitted|Optional. Can be used by client to ensure idempotence|
|priority|string|||
|runtime_constraints{}|list|Constraints that must be satisfied by the job/task scheduler in order to run the job.|See below.|
|script|string|Name of crunch script in @/crunch_scripts/@||
|script_parameters{}|list|Parameters passed to MapReduce script||
|script_version|string|git commit/tree used when running the job|This can be submitted as an unambiguous prefix of a commit sha1, "repository:tag", or "repository:branch". Before the job starts, Arvados will resolve it to a full 40-character git commit sha1.|
|cancelled_by_client_uuid|string|API client ID|Is null if job has not been cancelled|
|cancelled_by_user_uuid|string|Authenticated user ID|Is null if job has not been cancelled|
|cancelled_at|datetime|When job was cancelled|Is null if job has not been cancelled|
|started_at|datetime|When job started running|Is null if job has not [yet] started|
|finished_at|datetime|When job finished running|Is null if job has not [yet] finished|
|running|boolean|Whether the job is running||
|success|boolean|Whether the job indicated successful completion|Is null if job has not finished|
|is_locked_by_uuid|string|UUID of the user who has locked this job|Is null if job is not locked. The system user locks the job when starting the job, in order to prevent job attributes from being altered.|
|log|string|||
|tasks_summary|Hash|||
|output|string|||

h3. Runtime constraints

table(table table-bordered table-condensed).
|_. Key|_. Type|_. Description|_. Implemented|
|dependencies{}|list|[
 {
  "name": "freebayes",
  "package_type": "git",
  "origin": "https://github.com/ekg/freebayes.git",
  "version": "011561f4a96619125d4388b66b2e82b173f3de7a"
 },
 ...
]||
|min_nodes|integer||&#10003;|
|max_nodes|integer|||
|max_tasks_per_node|integer|Maximum simultaneous tasks on a single node|&#10003;|
|min_ram_per_task|integer|Minimum real memory (KiB) per task||
|min_ram_per_node|integer|Minimum real memory (KiB) per node||