Atlassian: Issue attachments schemas

7 Atlassian schemas with complete fields and constraints.

← Issue attachments operations · All schemas

Add attachment — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about an attachment. Additional keys: allowed
`author`	JSON	Optional
`author (anyOf 1)`	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone Details of the user who added the attachment. Read only: true
`author (anyOf 2)`	null	Alternative
`content`	JSON	Optional
`content (anyOf 1)`	string	Alternative	The content of the attachment. Read only: true
`content (anyOf 2)`	null	Alternative
`created`	JSON	Optional
`created (anyOf 1)`	JSON	Alternative
`created (anyOf 1) (anyOf 1)`	string	Alternative	The datetime the attachment was created. Read only: true
`created (anyOf 1) (anyOf 2)`	integer	Alternative
`created (anyOf 2)`	null	Alternative
`filename`	JSON	Optional
`filename (anyOf 1)`	string	Alternative	The file name of the attachment. Read only: true
`filename (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the attachment. Read only: true
`id (anyOf 2)`	null	Alternative
`mimeType`	JSON	Optional
`mimeType (anyOf 1)`	string	Alternative	The MIME type of the attachment. Read only: true
`mimeType (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the attachment details response. Read only: true
`self (anyOf 2)`	null	Alternative
`size`	JSON	Optional
`size (anyOf 1)`	JSON	Alternative
`size (anyOf 1) (anyOf 1)`	integer	Alternative	The size of the attachment. Format: int64 Read only: true
`size (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`size (anyOf 2)`	null	Alternative
`thumbnail`	JSON	Optional
`thumbnail (anyOf 1)`	string	Alternative	The URL of a thumbnail representing the attachment. Read only: true
`thumbnail (anyOf 2)`	null	Alternative

Referenced models: Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone

Get Jira attachment settings — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the instance's attachment settings.
`enabled`	JSON	Optional
`enabled (anyOf 1)`	boolean	Alternative	Whether the ability to add attachments is enabled. Read only: true
`enabled (anyOf 2)`	null	Alternative
`uploadLimit`	JSON	Optional
`uploadLimit (anyOf 1)`	JSON	Alternative
`uploadLimit (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum size of attachments permitted, in bytes. Format: int64 Read only: true
`uploadLimit (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`uploadLimit (anyOf 2)`	null	Alternative

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

Get attachment metadata — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Metadata for an issue attachment.
`author`	JSON	Optional
`author (anyOf 1)`	Model	Alternative	Expand Get user — response body Details of the user who attached the file. Read only: true
`author (anyOf 2)`	null	Alternative
`content`	JSON	Optional
`content (anyOf 1)`	string	Alternative	The URL of the attachment. Read only: true
`content (anyOf 2)`	null	Alternative
`created`	JSON	Optional
`created (anyOf 1)`	JSON	Alternative
`created (anyOf 1) (anyOf 1)`	string	Alternative	The datetime the attachment was created. Read only: true
`created (anyOf 1) (anyOf 2)`	integer	Alternative
`created (anyOf 2)`	null	Alternative
`filename`	JSON	Optional
`filename (anyOf 1)`	string	Alternative	The name of the attachment file. Read only: true
`filename (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
`mimeType`	JSON	Optional
`mimeType (anyOf 1)`	string	Alternative	The MIME type of the attachment. Read only: true
`mimeType (anyOf 2)`	null	Alternative
`properties`	JSON	Optional
`properties (anyOf 1)`	object	Alternative	Additional properties of the attachment. Read only: true Additional keys: see wildcard field
`properties (anyOf 1).*`	JSON	Additional keys	Read only: true
`properties (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the attachment metadata details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`size`	JSON	Optional
`size (anyOf 1)`	JSON	Alternative
`size (anyOf 1) (anyOf 1)`	integer	Alternative	The size of the attachment. Format: int64 Read only: true
`size (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`size (anyOf 2)`	null	Alternative
`thumbnail`	JSON	Optional
`thumbnail (anyOf 1)`	string	Alternative	The URL of a thumbnail representing the attachment. Read only: true
`thumbnail (anyOf 2)`	null	Alternative

Referenced models: Get user — response body

Get contents metadata for an expanded attachment — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`entries`	JSON	Optional
`entries (anyOf 1)`	array	Alternative	The list of the items included in the archive.
`entries (anyOf 1)[]`	Model	Each item	Expand Get contents metadata for an expanded attachment — response body — entries The list of the items included in the archive item
`entries (anyOf 2)`	null	Alternative
`totalEntryCount`	JSON	Optional
`totalEntryCount (anyOf 1)`	JSON	Alternative
`totalEntryCount (anyOf 1) (anyOf 1)`	integer	Alternative	The number of items in the archive. Format: int32
`totalEntryCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`totalEntryCount (anyOf 2)`	null	Alternative

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

Get contents 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
`abbreviatedName`	JSON	Optional
`abbreviatedName (anyOf 1)`	string	Alternative
`abbreviatedName (anyOf 2)`	null	Alternative
`entryIndex`	JSON	Optional
`entryIndex (anyOf 1)`	JSON	Alternative
`entryIndex (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`entryIndex (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`entryIndex (anyOf 2)`	null	Alternative
`mediaType`	JSON	Optional
`mediaType (anyOf 1)`	string	Alternative
`mediaType (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`size`	JSON	Optional
`size (anyOf 1)`	JSON	Alternative
`size (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`size (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`size (anyOf 2)`	null	Alternative

Report an issue with this page