Atlassian: Get all metadata for an expanded attachment

Atlassian issueAttachments.expandAttachmentForHumans: arguments, response, policy and SDK examples.

← Issue attachments operations · Get started

Operation atlassian.expandattachmentforhumans

Provider route: GET /{cloudId}/rest/api/3/attachment/{id}/expand/human. 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["issueAttachments"]["expandAttachmentForHumans"]>[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.issueAttachments.expandAttachmentForHumans(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.issue_attachments.expand_attachment_for_humans(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.id`	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 all metadata for an expanded attachment — response body

Referenced models: Get all metadata for an expanded attachment — response body

Schemas

Get all metadata for an expanded attachment — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Metadata for an archive (for example a zip) and its contents.
`entries`	JSON	Optional
`entries (anyOf 1)`	array	Alternative	The list of the items included in the archive. Read only: true
`entries (anyOf 1)[]`	Model	Each item	Expand Get all metadata for an expanded attachment — response body — entries The list of the items included in the archive item
`entries (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the attachment. Format: int64 Read only: true
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`mediaType`	JSON	Optional
`mediaType (anyOf 1)`	string	Alternative	The MIME type of the attachment. Read only: true
`mediaType (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the archive file. Read only: true
`name (anyOf 2)`	null	Alternative
`totalEntryCount`	JSON	Optional
`totalEntryCount (anyOf 1)`	JSON	Alternative
`totalEntryCount (anyOf 1) (anyOf 1)`	integer	Alternative	The number of items included in the archive. Format: int64 Read only: true
`totalEntryCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`totalEntryCount (anyOf 2)`	null	Alternative

Referenced models: Get all metadata for an expanded attachment — response body — entries The list of the items included in the archive item

Get all metadata for an expanded attachment — response body — entries The list of the items included in the archive item

Field	Type	Presence	Description and constraints
`$`	object	Root	Metadata for an item in an attachment archive.
`index`	JSON	Optional
`index (anyOf 1)`	JSON	Alternative
`index (anyOf 1) (anyOf 1)`	integer	Alternative	The position of the item within the archive. Format: int64 Read only: true
`index (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`index (anyOf 2)`	null	Alternative
`label`	JSON	Optional
`label (anyOf 1)`	string	Alternative	The label for the archive item. Read only: true
`label (anyOf 2)`	null	Alternative
`mediaType`	JSON	Optional
`mediaType (anyOf 1)`	string	Alternative	The MIME type of the archive item. Read only: true
`mediaType (anyOf 2)`	null	Alternative
`path`	JSON	Optional
`path (anyOf 1)`	string	Alternative	The path of the archive item. Read only: true
`path (anyOf 2)`	null	Alternative
`size`	JSON	Optional
`size (anyOf 1)`	string	Alternative	The size of the archive item. Read only: true
`size (anyOf 2)`	null	Alternative

Policy, approvals and errors

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