Asana: Jobs schemas
10 Asana schemas with complete fields and constraints.
← Jobs operations · All schemas
Get a job by id — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
opt_pretty | boolean | Optional | |
opt_fields | array | Optional | |
opt_fields[] | string | Each item | One of: dates_rollup_progress, dates_rollup_progress.total_tasks, dates_rollup_progress.updated_tasks, new_graph_export, new_graph_export.completed_at, new_graph_export.created_at, new_graph_export.download_url, new_portfolio, new_portfolio.name, new_portfolio.resource_subtype, new_project, new_project.name, new_project.resource_subtype, new_project_template, new_project_template.name, new_resource_export, new_resource_export.completed_at, new_resource_export.created_at, new_resource_export.download_url, new_task, new_task.created_by, new_task.name, new_task.resource_subtype, resource_subtype, status |
Get a job by id — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a job by id — response body — data data — sdk__Job Response |
Referenced models: Get a job by id — response body — data data — sdk__Job Response
Get a job by id — response body — data data dates rollup progress
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Progress of a subtask date rollup job. Only present on project rollup jobs; the object is empty until the job discovers tasks to reconcile. Read only: true |
updated_tasks | JSON | Optional | |
updated_tasks (anyOf 1) | integer | Alternative | The number of tasks whose dates have been reconciled so far. Minimum: 0 Read only: true |
updated_tasks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_tasks | JSON | Optional | |
total_tasks (anyOf 1) | integer | Alternative | The total number of tasks discovered for reconciliation so far. This value may increase while the job is running and is final when the job completes. Minimum: 0 Read only: true |
total_tasks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a job by id — response body — data data new graph export — Graph Export Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *graph_export* object represents a request to export the data starting from a parent object |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | Download this URL to retrieve the full export in JSON format. It will be compressed in a gzip (.gz) container. *Note: May be null if the export is still in progress or failed. If present, this URL may only be valid for 1 hour from the time of retrieval. You should avoid persisting this URL somewhere and rather refresh on demand to ensure you do not keep stale URLs.* Format: uri Read only: true |
download_url (anyOf 2) | null | Alternative | |
completed_at | string | Optional | The time at which this resource was completed. Format: date-time Read only: true |
Get a job by id — response body — data data new graph export — shared_new-graph-export_ac9d0b9b29a8
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *graph_export* object represents a request to export the data starting from a parent object |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | Download this URL to retrieve the full export in JSON format. It will be compressed in a gzip (.gz) container. *Note: May be null if the export is still in progress or failed. If present, this URL may only be valid for 1 hour from the time of retrieval. You should avoid persisting this URL somewhere and rather refresh on demand to ensure you do not keep stale URLs.* Format: uri Read only: true |
download_url (anyOf 2) | null | Alternative | |
completed_at | string | Optional | The time at which this resource was completed. Format: date-time Read only: true |
Get a job by id — response body — data data new project template
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *project template* is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, Rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | Name of the project template. |
Get a job by id — response body — data data new resource export — Resource Export Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *resource_export* object represents a request to bulk export objects for one or more resources. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
created_at | string | Optional | The time at which the resource export object was created. Format: date-time Read only: true |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | Download this URL to retrieve the full export in [JSON Lines](https://jsonlines.org/) format. It will be compressed in a gzip (.gz) container. *Note: May be null if the export is still in progress or failed.* Format: uri Read only: true |
download_url (anyOf 2) | null | Alternative | |
completed_at | string | Optional | The time at which this resource was completed. This will be null if the export is still in progress. Format: date-time Read only: true |
Get a job by id — response body — data data new resource export — shared_new-resource-export_3a6d78247490
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *resource_export* object represents a request to bulk export objects for one or more resources. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
created_at | string | Optional | The time at which the resource export object was created. Format: date-time Read only: true |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | Download this URL to retrieve the full export in [JSON Lines](https://jsonlines.org/) format. It will be compressed in a gzip (.gz) container. *Note: May be null if the export is still in progress or failed.* Format: uri Read only: true |
download_url (anyOf 2) | null | Alternative | |
completed_at | string | Optional | The time at which this resource was completed. This will be null if the export is still in progress. Format: date-time Read only: true |
Get a job by id — response body — data data — Job Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *job* is an object representing a process that handles asynchronous work. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Read only: true |
status | string | Optional | The current status of this job. Known values: not_started, in_progress, succeeded, failed Read only: true |
dates_rollup_progress | Model | Optional | Expand Get a job by id — response body — data data dates rollup progress |
new_portfolio | Model | Optional | Expand Get a portfolio membership — response body — data data portfolio — Portfolio Compact |
new_project | Model | Optional | Expand Search projects in a workspace — response body — data data item |
new_task | JSON | Optional | |
new_task (anyOf 1) | JSON | Alternative | |
new_task (anyOf 1) (allOf 1) | Model | All variants apply | Expand Search tasks in a workspace — response body — data data item |
new_task (anyOf 1) (allOf 2) | object | All variants apply | |
new_task (anyOf 2) | null | Alternative | |
new_project_template | Model | Optional | Expand Get a team's project templates — response body — data, next page data item |
new_graph_export | Model | Optional | Expand Get a job by id — response body — data data new graph export — Graph Export Compact |
new_resource_export | Model | Optional | Expand Get a job by id — response body — data data new resource export — Resource Export Compact |
Referenced models: Get a job by id — response body — data data new graph export — Graph Export Compact, Get a portfolio membership — response body — data data portfolio — Portfolio Compact, Search projects in a workspace — response body — data data item, Get a team's project templates — response body — data, next page data item, Get a job by id — response body — data data new resource export — Resource Export Compact, Search tasks in a workspace — response body — data data item, Get a job by id — response body — data data dates rollup progress
Get a job by id — response body — data data — sdk__Job Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *job* is an object representing a process that handles asynchronous work. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Read only: true |
status | string | Optional | The current status of this job. Known values: not_started, in_progress, succeeded, failed Read only: true |
dates_rollup_progress | Model | Optional | Expand Get a job by id — response body — data data dates rollup progress |
new_portfolio | Model | Optional | Expand Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493 |
new_project | Model | Optional | Expand Get a rate — response body — data data parent |
new_task | JSON | Optional | |
new_task (anyOf 1) | object | Alternative | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. The *task* is the basic object around which many operations in Asana are centered. |
new_task (anyOf 1).gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
new_task (anyOf 1).resource_type | string | Optional | The base type of this resource. Read only: true |
new_task (anyOf 1).name | string | Optional | The name of the task. |
new_task (anyOf 1).resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. The resource_subtype `milestone` represent a single moment in time. This means tasks with this subtype cannot have a start_date. Known values: default_task, milestone, approval, custom |
new_task (anyOf 1).created_by | object | Optional | [Opt In](/docs/inputoutput-options). A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. Read only: true |
new_task (anyOf 1).created_by.gid | string | Optional | Globally unique identifier of the resource. |
new_task (anyOf 1).created_by.resource_type | string | Optional | The type of resource. |
new_task (anyOf 2) | null | Alternative | |
new_project_template | Model | Optional | Expand Get a job by id — response body — data data new project template |
new_graph_export | Model | Optional | Expand Get a job by id — response body — data data new graph export — shared_new-graph-export_ac9d0b9b29a8 |
new_resource_export | Model | Optional | Expand Get a job by id — response body — data data new resource export — shared_new-resource-export_3a6d78247490 |
Referenced models: Get a job by id — response body — data data dates rollup progress, Get a job by id — response body — data data new graph export — shared_new-graph-export_ac9d0b9b29a8, Get a job by id — response body — data data new project template, Get a job by id — response body — data data new resource export — shared_new-resource-export_3a6d78247490, Get a rate — response body — data data parent, Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493