---
layout: default
navsection: api
navmenu: API Methods
title: "job_tasks"

...
{% comment %}
Copyright (C) The Arvados Authors. All rights reserved.

SPDX-License-Identifier: CC-BY-SA-3.0
{% endcomment %}

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

Object type: @ot0gb@

Example UUID: @zzzzz-ot0gb-0123456789abcde@

h2. Resource

Deprecated.

A job task is a individually scheduled unit of work executed as part of an overall job.

Each JobTask has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|sequence|integer|Execution sequence.
A step cannot be run until all steps with lower sequence numbers have completed.
Job steps with the same sequence number can be run in any order.||
|parameters|hash|||
|output|text|||
|progress|float|||
|success|boolean|Is null if the task has neither completed successfully nor failed permanently.||

The following attributes should not be updated by anyone other than the job manager:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Notes|
|qsequence|integer|Order of arrival|0-based|
|job_uuid|string|||
|created_by_job_task_uuid|string|||

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 JobTask.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|job_task|object||query||

h3. delete

Delete an existing JobTask.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||

h3. get

Gets a JobTask's metadata by UUID.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||

h3. list

List job_tasks.

See "common resource list method.":{{site.baseurl}}/api/methods.html#index

h3. update

Update attributes of an existing JobTask.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
|job_task|object||query||