Atlassian: Get task

Atlassian tasks.getTask: arguments, response, policy and SDK examples.

Operation atlassian.gettask

Provider route: GET /{cloudId}/rest/api/3/task/{taskId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["tasks"]["getTask"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.tasks.getTask(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.tasks.get_task(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`path.taskId`	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get task — response body

Referenced models: Get task — response body

Schemas

Get task — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a task.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the task.
`description (anyOf 2)`	null	Alternative
`elapsedRuntime`	JSON	Optional
`elapsedRuntime (anyOf 1)`	JSON	Alternative
`elapsedRuntime (anyOf 1) (anyOf 1)`	integer	Alternative	The execution time of the task, in milliseconds. Format: int64
`elapsedRuntime (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`elapsedRuntime (anyOf 2)`	null	Alternative
`finished`	JSON	Optional
`finished (anyOf 1)`	JSON	Alternative
`finished (anyOf 1) (anyOf 1)`	integer	Alternative	A timestamp recording when the task was finished. Format: int64
`finished (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`finished (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the task.
`id (anyOf 2)`	null	Alternative
`lastUpdate`	JSON	Optional
`lastUpdate (anyOf 1)`	JSON	Alternative
`lastUpdate (anyOf 1) (anyOf 1)`	integer	Alternative	A timestamp recording when the task progress was last updated. Format: int64
`lastUpdate (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`lastUpdate (anyOf 2)`	null	Alternative
`message`	JSON	Optional
`message (anyOf 1)`	string	Alternative	Information about the progress of the task.
`message (anyOf 2)`	null	Alternative
`progress`	JSON	Optional
`progress (anyOf 1)`	JSON	Alternative
`progress (anyOf 1) (anyOf 1)`	integer	Alternative	The progress of the task, as a percentage complete. Format: int64
`progress (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`progress (anyOf 2)`	null	Alternative
`result`	JSON	Optional
`result (anyOf 1)`	JSON	Alternative	The result of the task execution.
`result (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the task. Format: uri
`self (anyOf 2)`	null	Alternative
`started`	JSON	Optional
`started (anyOf 1)`	JSON	Alternative
`started (anyOf 1) (anyOf 1)`	integer	Alternative	A timestamp recording when the task was started. Format: int64
`started (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`started (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	string	Alternative	The status of the task. Known values: ENQUEUED, RUNNING, COMPLETE, FAILED, CANCEL_REQUESTED, CANCELLED, DEAD
`status (anyOf 2)`	null	Alternative
`submitted`	JSON	Optional
`submitted (anyOf 1)`	JSON	Alternative
`submitted (anyOf 1) (anyOf 1)`	integer	Alternative	A timestamp recording when the task was submitted. Format: int64
`submitted (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`submitted (anyOf 2)`	null	Alternative
`submittedBy`	JSON	Optional
`submittedBy (anyOf 1)`	JSON	Alternative
`submittedBy (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the user who submitted the task. Format: int64
`submittedBy (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`submittedBy (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.gettask. Catalog operation: gettask. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source

Report an issue with this page