Atlassian: Export archived issue(s)

Atlassian issues.exportArchivedIssues: arguments, response, policy and SDK examples.

Operation atlassian.exportarchivedissues

Provider route: PUT /{cloudId}/rest/api/3/issues/archive/export. 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["issues"]["exportArchivedIssues"]>[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.issues.exportArchivedIssues(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.issues.export_archived_issues(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}$
`body`	Model	Required within parent	Expand Export archived issue(s) — request body — body

Referenced models: Export archived issue(s) — request body — body

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 Export archived issue(s) — response body

Referenced models: Export archived issue(s) — response body

Schemas

Export archived issue(s) — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a filter for exporting archived issues. Additional keys: allowed
`archivedBy`	array	Optional	List archived issues archived by a specified account ID.
`archivedBy[]`	string	Each item
`archivedDateRange`	Model	Optional	Expand Export archived issue(s) — request body — body archived Date Range
`issueTypes`	array	Optional	List archived issues with a specified issue type ID.
`issueTypes[]`	string	Each item
`projects`	array	Optional	List archived issues with a specified project key.
`projects[]`	string	Each item
`reporters`	array	Optional	List archived issues where the reporter is a specified account ID.
`reporters[]`	string	Each item

Referenced models: Export archived issue(s) — request body — body archived Date Range

Export archived issue(s) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The response for status request for a running/completed export task.
`fileUrl`	JSON	Optional
`fileUrl (anyOf 1)`	string	Alternative
`fileUrl (anyOf 2)`	null	Alternative
`payload`	JSON	Optional
`payload (anyOf 1)`	string	Alternative
`payload (anyOf 2)`	null	Alternative
`progress`	JSON	Optional
`progress (anyOf 1)`	JSON	Alternative
`progress (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`progress (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`progress (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	string	Alternative
`status (anyOf 2)`	null	Alternative
`submittedTime`	JSON	Optional
`submittedTime (anyOf 1)`	JSON	Alternative
`submittedTime (anyOf 1) (anyOf 1)`	string	Alternative
`submittedTime (anyOf 1) (anyOf 2)`	integer	Alternative
`submittedTime (anyOf 2)`	null	Alternative
`taskId`	JSON	Optional
`taskId (anyOf 1)`	string	Alternative
`taskId (anyOf 2)`	null	Alternative

Export archived issue(s) — request body — body archived Date Range

Field	Type	Presence	Description and constraints
`$`	object	Root	List issues archived within a specified date range. Additional keys: not allowed
`dateAfter`	string	Required within parent	List issues archived after a specified date, passed in the YYYY-MM-DD format.
`dateBefore`	string	Required within parent	List issues archived before a specified date provided in the YYYY-MM-DD format.

Policy, approvals and errors

SDK function policy ID: atlassian.exportarchivedissues. Catalog operation: exportarchivedissues. 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