fetch-jira

A simple and typed library, based on OpenAPI spec from developer.atlassian.com, for accessing product APIs.

Fetch Jira - Documentation

Contents

• AppPropertiesApi
• ApplicationRolesApi
• AuditRecordsApi
• AvatarsApi
• DashboardsApi
• DynamicModulesApi
• FilterSharingApi
• FiltersApi
• GroupAndUserPickerApi
• GroupsApi
• IssueAttachmentsApi
• IssueCommentPropertiesApi
• IssueCommentsApi
• IssueFieldOptionsApi
• IssueFieldsApi
• IssueLinkTypesApi
• IssueLinksApi
• IssueNavigatorSettingsApi
• IssueNotificationSchemesApi
• IssuePrioritiesApi
• IssuePropertiesApi
• IssueRemoteLinksApi
• IssueResolutionsApi
• IssueSearchApi
• IssueSecurityLevelApi
• IssueSecuritySchemesApi
• IssueTypeHierarchyApi
• IssueTypePropertiesApi
• IssueTypesApi
• IssueVotesApi
• IssueWatchersApi
• IssueWorklogPropertiesApi
• IssueWorklogsApi
• IssuesApi
• JQLApi
• JiraExpressionsApi
• JiraSettingsApi
• LabelsApi
• MyselfApi
• PermissionSchemesApi
• PermissionsApi
• ProjectAvatarsApi
• ProjectCategoriesApi
• ProjectComponentsApi
• ProjectKeyAndNameValidationApi
• ProjectPermissionSchemesApi
• ProjectPropertiesApi
• ProjectRoleActorsApi
• ProjectRolesApi
• ProjectTypesApi
• ProjectVersionsApi
• ProjectsApi
• ScreensApi
• ServerInfoApi
• TasksApi
• TimeTrackingApi
• UserPropertiesApi
• UserSearchApi
• UsersApi
• WebhooksApi
• WorkflowSchemeDraftsApi
• WorkflowSchemeProjectAssociationsApi
• WorkflowSchemesApi
• WorkflowStatusCategoriesApi
• WorkflowStatusesApi
• WorkflowTransitionPropertiesApi
• WorkflowTransitionRulesApi
• WorkflowsApi

Methods

---

The AppPropertiesApi object

deleteAddonProperty() - Delete app property

Deletes an app's property.

Usage:

import { AppPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AppPropertiesApi(config).deleteAddonProperty({ ...args });

getAddonProperties() - Get app properties

Gets all the properties of an app.

Usage:

import { AppPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AppPropertiesApi(config).getAddonProperties({ ...args });

getAddonProperty() - Get app property

Returns the key and value of an app's property.

Usage:

import { AppPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AppPropertiesApi(config).getAddonProperty({ ...args });

putAddonProperty() - Set app property

Sets the value of an app's property. Use this resource to store custom data for your app.

Usage:

import { AppPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AppPropertiesApi(config).putAddonProperty({
  addonKey: string
  propertyKey: string
  bodies_putAddonProperty: { ... }
});

---

The ApplicationRolesApi object

getAllApplicationRoles() - Get all application roles

Returns all application roles. In Jira, application roles are managed using the Application access configuration page.

Usage:

import { ApplicationRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ApplicationRolesApi(config).getAllApplicationRoles({ ...args });

getApplicationRole() - Get application role

Returns an application role.

Usage:

import { ApplicationRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ApplicationRolesApi(config).getApplicationRole({ ...args });

---

The AuditRecordsApi object

getAuditRecords() - Get audit records

Returns a list of audit records. The list can be filtered to include items:

Usage:

import { AuditRecordsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AuditRecordsApi(config).getAuditRecords({ ...args });

---

The AvatarsApi object

deleteAvatar() - Delete avatar

Deletes an avatar from a project or issue type.

Usage:

import { AvatarsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AvatarsApi(config).deleteAvatar({ ...args });

getAllSystemAvatars() - Get system avatars by type

Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.

Usage:

import { AvatarsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AvatarsApi(config).getAllSystemAvatars({ ...args });

getAvatars() - Get avatars

Returns the system and custom avatars for a project or issue type.

Usage:

import { AvatarsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AvatarsApi(config).getAvatars({ ...args });

storeAvatar() - Load avatar

Loads a custom avatar for a project or issue type.

Usage:

import { AvatarsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new AvatarsApi(config).storeAvatar({
  type: string
  entityId: string
  x: integer
  y: integer
  size: integer
  bodies_storeAvatar: { ... }
});

---

The DashboardsApi object

deleteDashboardItemProperty() - Delete dashboard item property

Deletes a dashboard item property.

Usage:

import { DashboardsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DashboardsApi(config).deleteDashboardItemProperty({ ...args });

getAllDashboards() - Get all dashboards

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Usage:

import { DashboardsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DashboardsApi(config).getAllDashboards({ ...args });

getDashboard() - Get dashboard

Returns a dashboard.

Usage:

import { DashboardsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DashboardsApi(config).getDashboard({ ...args });

getDashboardItemProperty() - Get dashboard item property

Returns the key and value of a dashboard item property.

Usage:

import { DashboardsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DashboardsApi(config).getDashboardItemProperty({ ...args });

getDashboardItemPropertyKeys() - Get dashboard item property keys

Returns the keys of all properties for a dashboard item.

Usage:

import { DashboardsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DashboardsApi(config).getDashboardItemPropertyKeys({ ...args });

getDashboardsPaginated() - Search for dashboards

Searches for dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

Usage:

import { DashboardsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DashboardsApi(config).getDashboardsPaginated({ ...args });

setDashboardItemProperty() - Set dashboard item property

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

Usage:

import { DashboardsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DashboardsApi(config).setDashboardItemProperty({
  dashboardId: string
  itemId: string
  propertyKey: string
  bodies_setDashboardItemProperty: { ... }
});

---

The DynamicModulesApi object

getModules() - Get modules

Returns all modules registered dynamically by the calling app.

Usage:

import { DynamicModulesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DynamicModulesApi(config).getModules({ ...args });

registerModules() - Register modules

Registers a list of modules.

Usage:

import { DynamicModulesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DynamicModulesApi(config).registerModules({
  ConnectModules: { ... }
});

removeModules() - Remove modules

Remove all or a list of modules registered by the calling app.

Usage:

import { DynamicModulesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new DynamicModulesApi(config).removeModules({ ...args });

---

The FilterSharingApi object

addSharePermission() - Add share permission

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Usage:

import { FilterSharingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FilterSharingApi(config).addSharePermission({
  id: integer
  SharePermissionInputBean: { ... }
});

deleteSharePermission() - Delete share permission

Deletes a share permission from a filter.

Usage:

import { FilterSharingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FilterSharingApi(config).deleteSharePermission({ ...args });

getDefaultShareScope() - Get default share scope

Returns the default sharing settings for new filters and dashboards for a user.

Usage:

import { FilterSharingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FilterSharingApi(config).getDefaultShareScope({ ...args });

getSharePermission() - Get share permission

Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

Usage:

import { FilterSharingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FilterSharingApi(config).getSharePermission({ ...args });

getSharePermissions() - Get share permissions

Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

Usage:

import { FilterSharingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FilterSharingApi(config).getSharePermissions({ ...args });

setDefaultShareScope() - Set default share scope

Sets the default sharing for new filters and dashboards for a user.

Usage:

import { FilterSharingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FilterSharingApi(config).setDefaultShareScope({
  DefaultShareScope: { ... }
});

---

The FiltersApi object

createFilter() - Create filter

Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).createFilter({
  expand: string
  Filter: { ... }
});

deleteFavouriteForFilter() - Remove filter as favorite

Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).deleteFavouriteForFilter({ ...args });

deleteFilter() - Delete filter

Delete a filter.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).deleteFilter({ ...args });

getColumns() - Get columns

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).getColumns({ ...args });

getFavouriteFilters() - Get favorite filters

Returns the visible favorite filters of the user.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).getFavouriteFilters({ ...args });

getFilter() - Get filter

Returns a filter.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).getFilter({ ...args });

getFilters() - Get filters

Returns all filters. Deprecated, use Search for filters that supports search and pagination.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).getFilters({ ...args });

getFiltersPaginated() - Search for filters

Searches for filters. This operation is similar to Get filters except that the results can be refined to include filters that have specific attributes. For example, filters with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).getFiltersPaginated({ ...args });

getMyFilters() - Get my filters

Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).getMyFilters({ ...args });

resetColumns() - Reset columns

Reset the user's column configuration for the filter to the default.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).resetColumns({ ...args });

setColumns() - Set columns

Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).setColumns({
  id: integer
  bodies_setColumns: { ... }
});

setFavouriteForFilter() - Add filter as favorite

Add a filter as a favorite for the user.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).setFavouriteForFilter({ ...args });

updateFilter() - Update filter

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Usage:

import { FiltersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new FiltersApi(config).updateFilter({
  id: integer
  expand: string
  Filter: { ... }
});

---

The GroupAndUserPickerApi object

findUsersAndGroups() - Find users and groups

Returns a list of users and groups matching a string. The string is used:

Usage:

import { GroupAndUserPickerApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new GroupAndUserPickerApi(config).findUsersAndGroups({ ...args });

---

The GroupsApi object

addUserToGroup() - Add user to group

Adds a user to a group.

Usage:

import { GroupsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new GroupsApi(config).addUserToGroup({
  groupname: string
  UpdateUserToGroupBean: { ... }
});

createGroup() - Create group

Creates a group.

Usage:

import { GroupsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new GroupsApi(config).createGroup({
  AddGroupBean: { ... }
});

findGroups() - Find groups

Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results.

Usage:

import { GroupsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new GroupsApi(config).findGroups({ ...args });

getGroup() - Get group

This operation is deprecated, use group/member.

Usage:

import { GroupsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new GroupsApi(config).getGroup({ ...args });

getUsersFromGroup() - Get users from group

Returns all users in a group.

Usage:

import { GroupsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new GroupsApi(config).getUsersFromGroup({ ...args });

removeGroup() - Remove group

Deletes a group.

Usage:

import { GroupsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new GroupsApi(config).removeGroup({ ...args });

removeUserFromGroup() - Remove user from group

Removes a user from a group.

Usage:

import { GroupsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new GroupsApi(config).removeUserFromGroup({ ...args });

---

The IssueAttachmentsApi object

addAttachment() - Add attachment

Adds one or more attachments to an issue. Attachments are posted as multipart/form-data (RFC 1867).

Usage:

import { IssueAttachmentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueAttachmentsApi(config).addAttachment({
  issueIdOrKey: string
  bodies_addAttachment: { ... }
});

expandAttachmentForHumans() - Get all metadata for an expanded attachment

Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.

Usage:

import { IssueAttachmentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueAttachmentsApi(config).expandAttachmentForHumans({ ...args });

expandAttachmentForMachines() - Get contents metadata for an expanded attachment

Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.

Usage:

import { IssueAttachmentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueAttachmentsApi(config).expandAttachmentForMachines({ ...args });

getAttachment() - Get attachment metadata

Returns the metadata for an attachment. Note that the attachment itself is not returned.

Usage:

import { IssueAttachmentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueAttachmentsApi(config).getAttachment({ ...args });

getAttachmentMeta() - Get Jira attachment settings

Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.

Usage:

import { IssueAttachmentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueAttachmentsApi(config).getAttachmentMeta({ ...args });

removeAttachment() - Delete attachment

Deletes an attachment from an issue.

Usage:

import { IssueAttachmentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueAttachmentsApi(config).removeAttachment({ ...args });

---

The IssueCommentPropertiesApi object

deleteCommentProperty() - Delete comment property

Deletes a comment property.

Usage:

import { IssueCommentPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentPropertiesApi(config).deleteCommentProperty({ ...args });

getCommentProperty() - Get comment property

Returns the value of a comment property.

Usage:

import { IssueCommentPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentPropertiesApi(config).getCommentProperty({ ...args });

getCommentPropertyKeys() - Get comment property keys

Returns the keys of all the properties of a comment.

Usage:

import { IssueCommentPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentPropertiesApi(config).getCommentPropertyKeys({ ...args });

setCommentProperty() - Set comment property

Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.

Usage:

import { IssueCommentPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentPropertiesApi(config).setCommentProperty({
  commentId: string
  propertyKey: string
  bodies_setCommentProperty: { ... }
});

---

The IssueCommentsApi object

addComment() - Add comment

Adds a comment to an issue.

Usage:

import { IssueCommentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentsApi(config).addComment({
  issueIdOrKey: string
  expand: string
  Comment: { ... }
});

deleteComment() - Delete comment

Deletes a comment.

Usage:

import { IssueCommentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentsApi(config).deleteComment({ ...args });

getComment() - Get comment

Returns a comment.

Usage:

import { IssueCommentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentsApi(config).getComment({ ...args });

getComments() - Get comments

Returns all comments for an issue.

Usage:

import { IssueCommentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentsApi(config).getComments({ ...args });

getCommentsByIds() - Get comments by IDs

Returns the comments for a list of comment IDs.

Usage:

import { IssueCommentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentsApi(config).getCommentsByIds({
  expand: string
  IssueCommentListRequestBean: { ... }
});

updateComment() - Update comment

Updates a comment.

Usage:

import { IssueCommentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueCommentsApi(config).updateComment({
  issueIdOrKey: string
  id: string
  expand: string
  Comment: { ... }
});

---

The IssueFieldOptionsApi object

createIssueFieldOption() - Create issue field option

Creates an option for a select list issue field.

Usage:

import { IssueFieldOptionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldOptionsApi(config).createIssueFieldOption({
  fieldKey: string
  IssueFieldOptionCreateBean: { ... }
});

deleteIssueFieldOption() - Delete issue field option

Deletes an option from a select list issue field.

Usage:

import { IssueFieldOptionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldOptionsApi(config).deleteIssueFieldOption({ ...args });

getAllIssueFieldOptions() - Get all issue field options

Returns all options defined for a select list issue field. A select list issue field is a type of issue field that allows a user to select n value from a list of options.

Usage:

import { IssueFieldOptionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldOptionsApi(config).getAllIssueFieldOptions({ ...args });

getIssueFieldOption() - Get issue field option

Returns an option from a select list issue field.

Usage:

import { IssueFieldOptionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldOptionsApi(config).getIssueFieldOption({ ...args });

getSelectableIssueFieldOptions() - Get selectable issue field options

Returns options defined for a select list issue field that can be viewed and selected by the user.

Usage:

import { IssueFieldOptionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldOptionsApi(config).getSelectableIssueFieldOptions({ ...args });

getVisibleIssueFieldOptions() - Get visible issue field options

Returns options defined for a select list issue field that can be viewed by the user.

Usage:

import { IssueFieldOptionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldOptionsApi(config).getVisibleIssueFieldOptions({ ...args });

replaceIssueFieldOption() - Replace issue field option

Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query.

Usage:

import { IssueFieldOptionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldOptionsApi(config).replaceIssueFieldOption({ ...args });

updateIssueFieldOption() - Update issue field option

Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.

Usage:

import { IssueFieldOptionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldOptionsApi(config).updateIssueFieldOption({
  fieldKey: string
  optionId: integer
  IssueFieldOption: { ... }
});

---

The IssueFieldsApi object

createCustomField() - Create custom field

Creates a custom field.

Usage:

import { IssueFieldsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldsApi(config).createCustomField({
  CustomFieldDefinitionJsonBean: { ... }
});

getCustomFieldOption() - Get custom field option

Returns a custom field option. For example, an option in a cascading select list.

Usage:

import { IssueFieldsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldsApi(config).getCustomFieldOption({ ...args });

getFields() - Get fields

Returns system and custom issue fields according to the following rules:

Usage:

import { IssueFieldsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldsApi(config).getFields({ ...args });

getFieldsPaginated() - Get fields paginated

Returns a paginated list of fields for Classic Jira projects. Only custom fields can be queried, isCustom must be set to true.

Usage:

import { IssueFieldsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueFieldsApi(config).getFieldsPaginated({ ...args });

---

The IssueLinkTypesApi object

createIssueLinkType() - Create issue link type

Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.

Usage:

import { IssueLinkTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueLinkTypesApi(config).createIssueLinkType({
  IssueLinkType: { ... }
});

deleteIssueLinkType() - Delete issue link type

Deletes an issue link type.

Usage:

import { IssueLinkTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueLinkTypesApi(config).deleteIssueLinkType({ ...args });

getIssueLinkType() - Get issue link type

Returns an issue link type.

Usage:

import { IssueLinkTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueLinkTypesApi(config).getIssueLinkType({ ...args });

getIssueLinkTypes() - Get issue link types

Returns a list of all issue link types.

Usage:

import { IssueLinkTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueLinkTypesApi(config).getIssueLinkTypes({ ...args });

updateIssueLinkType() - Update issue link type

Updates an issue link type.

Usage:

import { IssueLinkTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueLinkTypesApi(config).updateIssueLinkType({
  issueLinkTypeId: string
  IssueLinkType: { ... }
});

---

The IssueLinksApi object

deleteIssueLink() - Delete issue link

Deletes an issue link.

Usage:

import { IssueLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueLinksApi(config).deleteIssueLink({ ...args });

getIssueLink() - Get issue link

Returns an issue link.

Usage:

import { IssueLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueLinksApi(config).getIssueLink({ ...args });

linkIssues() - Create issue link

Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have Issue Linking enabled.

Usage:

import { IssueLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueLinksApi(config).linkIssues({
  LinkIssueRequestJsonBean: { ... }
});

---

The IssueNavigatorSettingsApi object

getIssueNavigatorDefaultColumns() - Get issue navigator default columns

Returns the default issue navigator columns.

Usage:

import { IssueNavigatorSettingsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueNavigatorSettingsApi(config).getIssueNavigatorDefaultColumns({ ...args });

setIssueNavigatorDefaultColumns() - Set issue navigator default columns

Sets the default issue navigator columns.

Usage:

import { IssueNavigatorSettingsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueNavigatorSettingsApi(config).setIssueNavigatorDefaultColumns({
  bodies_setIssueNavigatorDefaultColumns: { ... }
});

---

The IssueNotificationSchemesApi object

getNotificationScheme() - Get notification scheme

Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.

Usage:

import { IssueNotificationSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueNotificationSchemesApi(config).getNotificationScheme({ ...args });

getNotificationSchemes() - Get notification schemes paginated

Returns a paginated list of notification schemes in order by display name.

Usage:

import { IssueNotificationSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueNotificationSchemesApi(config).getNotificationSchemes({ ...args });

---

The IssuePrioritiesApi object

getPriorities() - Get priorities

Returns the list of all issue priorities.

Usage:

import { IssuePrioritiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePrioritiesApi(config).getPriorities({ ...args });

getPriority() - Get priority

Returns an issue priority.

Usage:

import { IssuePrioritiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePrioritiesApi(config).getPriority({ ...args });

---

The IssuePropertiesApi object

bulkDeleteIssueProperty() - Bulk delete issue property

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

Usage:

import { IssuePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePropertiesApi(config).bulkDeleteIssueProperty({
  propertyKey: string
  IssueFilterForBulkPropertyDelete: { ... }
});

bulkSetIssueProperty() - Bulk set issue property

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

Usage:

import { IssuePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePropertiesApi(config).bulkSetIssueProperty({
  propertyKey: string
  BulkIssuePropertyUpdateRequest: { ... }
});

bulkSetIssuesProperties() - Bulk set issues properties

Sets the values of entity properties on issues. It can set up to 10 entity properties on up to 10,000 issues.

Usage:

import { IssuePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePropertiesApi(config).bulkSetIssuesProperties({
  IssueEntityProperties: { ... }
});

deleteIssueProperty() - Delete issue property

Deletes an issue's property.

Usage:

import { IssuePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePropertiesApi(config).deleteIssueProperty({ ...args });

getIssueProperty() - Get issue property

Returns the key and value of an issue's property.

Usage:

import { IssuePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePropertiesApi(config).getIssueProperty({ ...args });

getIssuePropertyKeys() - Get issue property keys

Returns the URLs and keys of an issue's properties.

Usage:

import { IssuePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePropertiesApi(config).getIssuePropertyKeys({ ...args });

setIssueProperty() - Set issue property

Sets the value of an issue's property. Use this resource to store custom data against an issue.

Usage:

import { IssuePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuePropertiesApi(config).setIssueProperty({
  issueIdOrKey: string
  propertyKey: string
  bodies_setIssueProperty: { ... }
});

---

The IssueRemoteLinksApi object

createOrUpdateRemoteIssueLink() - Create or update remote issue link

Creates or updates a remote issue link for an issue.

Usage:

import { IssueRemoteLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueRemoteLinksApi(config).createOrUpdateRemoteIssueLink({
  issueIdOrKey: string
  RemoteIssueLinkRequest: { ... }
});

deleteRemoteIssueLinkByGlobalId() - Delete remote issue link by global ID

Deletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.

Usage:

import { IssueRemoteLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueRemoteLinksApi(config).deleteRemoteIssueLinkByGlobalId({ ...args });

deleteRemoteIssueLinkById() - Delete remote issue link by ID

Deletes a remote issue link from an issue.

Usage:

import { IssueRemoteLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueRemoteLinksApi(config).deleteRemoteIssueLinkById({ ...args });

getRemoteIssueLinkById() - Get remote issue link by ID

Returns a remote issue link for an issue.

Usage:

import { IssueRemoteLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueRemoteLinksApi(config).getRemoteIssueLinkById({ ...args });

getRemoteIssueLinks() - Get remote issue links

Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.

Usage:

import { IssueRemoteLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueRemoteLinksApi(config).getRemoteIssueLinks({ ...args });

updateRemoteIssueLink() - Update remote issue link by ID

Updates a remote issue link for an issue.

Usage:

import { IssueRemoteLinksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueRemoteLinksApi(config).updateRemoteIssueLink({
  issueIdOrKey: string
  linkId: string
  RemoteIssueLinkRequest: { ... }
});

---

The IssueResolutionsApi object

getResolution() - Get resolution

Returns an issue resolution value.

Usage:

import { IssueResolutionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueResolutionsApi(config).getResolution({ ...args });

getResolutions() - Get resolutions

Returns a list of all issue resolution values.

Usage:

import { IssueResolutionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueResolutionsApi(config).getResolutions({ ...args });

---

The IssueSearchApi object

getIssuePickerResource() - Get issue picker suggestions

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

Usage:

import { IssueSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueSearchApi(config).getIssuePickerResource({ ...args });

matchIssues() - Check issues against JQL

Checks whether one or more issues would be returned by one or more JQL queries.

Usage:

import { IssueSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueSearchApi(config).matchIssues({
  IssuesAndJQLQueries: { ... }
});

searchForIssuesUsingJql() - Search for issues using JQL (GET)

Searches for issues using JQL.

Usage:

import { IssueSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueSearchApi(config).searchForIssuesUsingJql({ ...args });

searchForIssuesUsingJql1() - Search for issues using JQL (POST)

Searches for issues using JQL.

Usage:

import { IssueSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueSearchApi(config).searchForIssuesUsingJql1({
  SearchRequestBean: { ... }
});

---

The IssueSecurityLevelApi object

getIssueSecurityLevel() - Get issue security level

Returns details of an issue security level.

Usage:

import { IssueSecurityLevelApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueSecurityLevelApi(config).getIssueSecurityLevel({ ...args });

---

The IssueSecuritySchemesApi object

getIssueSecurityScheme1() - Get issue security scheme

Returns an issue security scheme along with its security levels.

Usage:

import { IssueSecuritySchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueSecuritySchemesApi(config).getIssueSecurityScheme1({ ...args });

getIssueSecuritySchemes() - Get issue security schemes

Returns all issue security schemes.

Usage:

import { IssueSecuritySchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueSecuritySchemesApi(config).getIssueSecuritySchemes({ ...args });

---

The IssueTypeHierarchyApi object

getHierarchy() - Get the hierarchy

Get the project hierarchy.

Usage:

import { IssueTypeHierarchyApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypeHierarchyApi(config).getHierarchy({ ...args });

---

The IssueTypePropertiesApi object

deleteIssueTypeProperty() - Delete issue type property

Deletes the issue type property.

Usage:

import { IssueTypePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypePropertiesApi(config).deleteIssueTypeProperty({ ...args });

getIssueTypeProperty() - Get issue type property

Returns the key and value of the issue type property.

Usage:

import { IssueTypePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypePropertiesApi(config).getIssueTypeProperty({ ...args });

getIssueTypePropertyKeys() - Get issue type property keys

Returns all the issue type property keys of the issue type.

Usage:

import { IssueTypePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypePropertiesApi(config).getIssueTypePropertyKeys({ ...args });

setIssueTypeProperty() - Set issue type property

Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.

Usage:

import { IssueTypePropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypePropertiesApi(config).setIssueTypeProperty({
  issueTypeId: string
  propertyKey: string
  bodies_setIssueTypeProperty: { ... }
});

---

The IssueTypesApi object

createIssueType() - Create issue type

Creates an issue type and adds it to the default issue type scheme.

Usage:

import { IssueTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypesApi(config).createIssueType({
  IssueTypeCreateBean: { ... }
});

createIssueTypeAvatar() - Load issue type avatar

Loads an avatar for the issue type.

Usage:

import { IssueTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypesApi(config).createIssueTypeAvatar({
  id: string
  x: integer
  y: integer
  size: integer
  bodies_createIssueTypeAvatar: { ... }
});

deleteIssueType() - Delete issue type

Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the Get alternative issue types resource.

Usage:

import { IssueTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypesApi(config).deleteIssueType({ ...args });

getAlternativeIssueTypes() - Get alternative issue types

Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.

Usage:

import { IssueTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypesApi(config).getAlternativeIssueTypes({ ...args });

getIssueAllTypes() - Get all issue types for user

Returns all issue types.

Usage:

import { IssueTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypesApi(config).getIssueAllTypes({ ...args });

getIssueType() - Get issue type

Returns an issue type.

Usage:

import { IssueTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypesApi(config).getIssueType({ ...args });

updateIssueType() - Update issue type

Updates the issue type.

Usage:

import { IssueTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueTypesApi(config).updateIssueType({
  id: string
  IssueTypeUpdateBean: { ... }
});

---

The IssueVotesApi object

addVote() - Add vote

Adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira.

Usage:

import { IssueVotesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueVotesApi(config).addVote({ ...args });

getVotes() - Get votes

Returns details about the votes on an issue.

Usage:

import { IssueVotesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueVotesApi(config).getVotes({ ...args });

removeVote() - Delete vote

Deletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira.

Usage:

import { IssueVotesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueVotesApi(config).removeVote({ ...args });

---

The IssueWatchersApi object

addWatcher() - Add watcher

Adds a user as a watcher of an issue by passing the account ID of the user. For example, "5b10ac8d82e05b22cc7d4ef5". If no user is specified the calling user is added.

Usage:

import { IssueWatchersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWatchersApi(config).addWatcher({
  issueIdOrKey: string
  bodies_addWatcher: { ... }
});

getIssueWatchers() - Get issue watchers

Returns the watchers for an issue.

Usage:

import { IssueWatchersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWatchersApi(config).getIssueWatchers({ ...args });

removeWatcher() - Delete watcher

Deletes a user as a watcher of an issue.

Usage:

import { IssueWatchersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWatchersApi(config).removeWatcher({ ...args });

---

The IssueWorklogPropertiesApi object

deleteWorklogProperty() - Delete worklog property

Deletes a worklog property.

Usage:

import { IssueWorklogPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogPropertiesApi(config).deleteWorklogProperty({ ...args });

getWorklogProperty() - Get worklog property

Returns the value of a worklog property.

Usage:

import { IssueWorklogPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogPropertiesApi(config).getWorklogProperty({ ...args });

getWorklogPropertyKeys() - Get worklog property keys

Returns the keys of all properties for a worklog.

Usage:

import { IssueWorklogPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogPropertiesApi(config).getWorklogPropertyKeys({ ...args });

setWorklogProperty() - Set worklog property

Sets the value of a worklog property. Use this operation to store custom data against the worklog.

Usage:

import { IssueWorklogPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogPropertiesApi(config).setWorklogProperty({
  issueIdOrKey: string
  worklogId: string
  propertyKey: string
  bodies_setWorklogProperty: { ... }
});

---

The IssueWorklogsApi object

addWorklog() - Add worklog

Adds a worklog to an issue.

Usage:

import { IssueWorklogsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogsApi(config).addWorklog({
  issueIdOrKey: string
  notifyUsers: boolean
  adjustEstimate: string
  newEstimate: string
  reduceBy: string
  expand: string
  overrideEditableFlag: boolean
  Worklog: { ... }
});

deleteWorklog() - Delete worklog

Deletes a worklog from an issue.

Usage:

import { IssueWorklogsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogsApi(config).deleteWorklog({ ...args });

getIdsOfWorklogsDeletedSince() - Get IDs of deleted worklogs

Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.

Usage:

import { IssueWorklogsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogsApi(config).getIdsOfWorklogsDeletedSince({ ...args });

getIdsOfWorklogsModifiedSince() - Get IDs of updated worklogs

Returns a list of IDs and update timestamps for worklogs updated after a date and time.

Usage:

import { IssueWorklogsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogsApi(config).getIdsOfWorklogsModifiedSince({ ...args });

getIssueWorklog() - Get issue worklogs

Returns all worklogs for an issue.

Usage:

import { IssueWorklogsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogsApi(config).getIssueWorklog({ ...args });

getWorklog() - Get worklog

Returns a worklog.

Usage:

import { IssueWorklogsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogsApi(config).getWorklog({ ...args });

getWorklogsForIds() - Get worklogs

Returns worklog details for a list of worklog IDs.

Usage:

import { IssueWorklogsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogsApi(config).getWorklogsForIds({
  expand: string
  WorklogIdsRequestBean: { ... }
});

updateWorklog() - Update worklog

Updates a worklog.

Usage:

import { IssueWorklogsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssueWorklogsApi(config).updateWorklog({
  issueIdOrKey: string
  id: string
  notifyUsers: boolean
  adjustEstimate: string
  newEstimate: string
  expand: string
  overrideEditableFlag: boolean
  Worklog: { ... }
});

---

The IssuesApi object

assignIssue() - Assign issue

Assigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).assignIssue({
  issueIdOrKey: string
  User: { ... }
});

createIssue() - Create issue

Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).createIssue({
  updateHistory: boolean
  IssueUpdateDetails: { ... }
});

createIssues() - Bulk create issue

Creates issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).createIssues({
  IssuesUpdateBean: { ... }
});

deleteIssue() - Delete issue

Deletes an issue.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).deleteIssue({ ...args });

doTransition() - Transition issue

Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).doTransition({
  issueIdOrKey: string
  IssueUpdateDetails: { ... }
});

editIssue() - Edit issue

Edits an issue. A transition may be applied and issue properties updated as part of the edit.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).editIssue({
  issueIdOrKey: string
  notifyUsers: boolean
  overrideScreenSecurity: boolean
  overrideEditableFlag: boolean
  IssueUpdateDetails: { ... }
});

getChangeLogs() - Get change logs

Returns all changelogs for an issue sorted by date, starting from the oldest.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).getChangeLogs({ ...args });

getCreateIssueMeta() - Get create issue metadata

Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue and Create issues.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).getCreateIssueMeta({ ...args });

getEditIssueMeta() - Get edit issue metadata

Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in Edit issue.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).getEditIssueMeta({ ...args });

getIssue() - Get issue

Returns the details for an issue.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).getIssue({ ...args });

getTransitions() - Get transitions

Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).getTransitions({ ...args });

notify() - Send notification for issue

Creates an email notification for an issue and adds it to the mail queue.

Usage:

import { IssuesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new IssuesApi(config).notify({
  issueIdOrKey: string
  Notification: { ... }
});

---

The JQLApi object

getAutoComplete() - Get field reference data

Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.

Usage:

import { JQLApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JQLApi(config).getAutoComplete({ ...args });

getFieldAutoCompleteForQueryString() - Get field auto complete suggestions

Returns the JQL search auto complete suggestions for a field.

Usage:

import { JQLApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JQLApi(config).getFieldAutoCompleteForQueryString({ ...args });

migrateQueries() - Convert user identifiers to account IDs in JQL queries

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

Usage:

import { JQLApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JQLApi(config).migrateQueries({
  JQLPersonalDataMigrationRequest: { ... }
});

parseJqlQueries() - Parse JQL query

Parses and validates JQL queries.

Usage:

import { JQLApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JQLApi(config).parseJqlQueries({
  JqlQueriesToParse: { ... }
});

---

The JiraExpressionsApi object

evaluateJiraExpression() - Evaluate Jira expression

Evaluates a Jira expression and returns its value.

Usage:

import { JiraExpressionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JiraExpressionsApi(config).evaluateJiraExpression({
  expand: string
  JiraExpressionEvalRequestBean: { ... }
});

---

The JiraSettingsApi object

getAdvancedSettings() - Get advanced settings

Returns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon > Jira settings > System, General Configuration and then click Advanced Settings (in the upper right).

Usage:

import { JiraSettingsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JiraSettingsApi(config).getAdvancedSettings({ ...args });

getApplicationProperty() - Get application property

Returns all application properties or an application property.

Usage:

import { JiraSettingsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JiraSettingsApi(config).getApplicationProperty({ ...args });

getConfiguration() - Get global settings

Returns the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.

Usage:

import { JiraSettingsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JiraSettingsApi(config).getConfiguration({ ...args });

setApplicationProperty() - Set application property

Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.

Usage:

import { JiraSettingsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new JiraSettingsApi(config).setApplicationProperty({
  id: string
  SimpleApplicationPropertyBean: { ... }
});

---

The LabelsApi object

getAllLabels() - Get all labels

Returns a paginated list of available labels.

Usage:

import { LabelsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new LabelsApi(config).getAllLabels({ ...args });

---

The MyselfApi object

deleteLocale() - Delete locale

Deletes the locale of the user, which restores the default setting.

Usage:

import { MyselfApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new MyselfApi(config).deleteLocale({ ...args });

getCurrentUser() - Get current user

Returns details for the current user.

Usage:

import { MyselfApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new MyselfApi(config).getCurrentUser({ ...args });

getLocale() - Get locale

Returns the locale for the user.

Usage:

import { MyselfApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new MyselfApi(config).getLocale({ ...args });

getPreference() - Get preference

Returns the value of a preference of the current user.

Usage:

import { MyselfApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new MyselfApi(config).getPreference({ ...args });

removePreference() - Delete preference

Deletes a preference of the user, which restores the default value of system defined settings.

Usage:

import { MyselfApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new MyselfApi(config).removePreference({ ...args });

setLocale() - Set locale

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Usage:

import { MyselfApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new MyselfApi(config).setLocale({
  Locale: { ... }
});

setPreference() - Set preference

Creates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:

Usage:

import { MyselfApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new MyselfApi(config).setPreference({
  key: string
  bodies_setPreference: { ... }
});

---

The PermissionSchemesApi object

createPermissionGrant() - Create permission grant

Creates a permission grant in a permission scheme.

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).createPermissionGrant({
  schemeId: integer
  expand: string
  PermissionGrant: { ... }
});

createPermissionScheme() - Create permission scheme

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).createPermissionScheme({
  expand: string
  PermissionScheme: { ... }
});

deletePermissionScheme() - Delete permission scheme

Deletes a permission scheme.

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).deletePermissionScheme({ ...args });

deletePermissionSchemeEntity() - Delete permission scheme grant

Deletes a permission grant from a permission scheme. See About permission schemes and grants for more details.

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).deletePermissionSchemeEntity({ ...args });

getAllPermissionSchemes() - Get all permission schemes

Returns all permission schemes.

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).getAllPermissionSchemes({ ...args });

getPermissionScheme() - Get permission scheme

Returns a permission scheme.

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).getPermissionScheme({ ...args });

getPermissionSchemeGrant() - Get permission scheme grant

Returns a permission grant.

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).getPermissionSchemeGrant({ ...args });

getPermissionSchemeGrants() - Get permission scheme grants

Returns all permission grants for a permission scheme.

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).getPermissionSchemeGrants({ ...args });

updatePermissionScheme() - Update permission scheme

Updates a permission scheme. Below are some important things to note when using this resource:

Usage:

import { PermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionSchemesApi(config).updatePermissionScheme({
  schemeId: integer
  expand: string
  PermissionScheme: { ... }
});

---

The PermissionsApi object

getAllPermissions() - Get all permissions

Returns all permissions, including:

Usage:

import { PermissionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionsApi(config).getAllPermissions({ ...args });

getBulkPermissions() - Get bulk permissions

Returns:

Usage:

import { PermissionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionsApi(config).getBulkPermissions({
  BulkPermissionsRequestBean: { ... }
});

getMyPermissions() - Get my permissions

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

Usage:

import { PermissionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionsApi(config).getMyPermissions({ ...args });

getPermittedProjects() - Get permitted projects

Returns all the projects where the user is granted a list of project permissions.

Usage:

import { PermissionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new PermissionsApi(config).getPermittedProjects({
  PermissionsKeysBean: { ... }
});

---

The ProjectAvatarsApi object

createProjectAvatar() - Load project avatar

Loads an avatar for a project.

Usage:

import { ProjectAvatarsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectAvatarsApi(config).createProjectAvatar({
  projectIdOrKey: string
  x: integer
  y: integer
  size: integer
  bodies_createProjectAvatar: { ... }
});

deleteProjectAvatar() - Delete project avatar

Deletes a custom avatar from a project. Note that system avatars cannot be deleted.

Usage:

import { ProjectAvatarsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectAvatarsApi(config).deleteProjectAvatar({ ...args });

getAllProjectAvatars() - Get all project avatars

Returns all project avatars, grouped by system and custom avatars.

Usage:

import { ProjectAvatarsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectAvatarsApi(config).getAllProjectAvatars({ ...args });

updateProjectAvatar() - Set project avatar

Sets the avatar displayed for a project.

Usage:

import { ProjectAvatarsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectAvatarsApi(config).updateProjectAvatar({
  projectIdOrKey: string
  Avatar: { ... }
});

---

The ProjectCategoriesApi object

createProjectCategory() - Create project category

Creates a project category.

Usage:

import { ProjectCategoriesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectCategoriesApi(config).createProjectCategory({
  ProjectCategory: { ... }
});

getAllProjectCategories() - Get all project categories

Returns all project categories.

Usage:

import { ProjectCategoriesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectCategoriesApi(config).getAllProjectCategories({ ...args });

getProjectCategoryById() - Get project category by id

Returns a project category.

Usage:

import { ProjectCategoriesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectCategoriesApi(config).getProjectCategoryById({ ...args });

removeProjectCategory() - Delete project category

Deletes a project category.

Usage:

import { ProjectCategoriesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectCategoriesApi(config).removeProjectCategory({ ...args });

updateProjectCategory() - Update project category

Updates a project category.

Usage:

import { ProjectCategoriesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectCategoriesApi(config).updateProjectCategory({
  id: integer
  ProjectCategory: { ... }
});

---

The ProjectComponentsApi object

createComponent() - Create component

Creates a component. Use components to provide containers for issues within a project.

Usage:

import { ProjectComponentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectComponentsApi(config).createComponent({
  Component: { ... }
});

deleteComponent() - Delete component

Deletes a component.

Usage:

import { ProjectComponentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectComponentsApi(config).deleteComponent({ ...args });

getComponent() - Get component

Returns a component.

Usage:

import { ProjectComponentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectComponentsApi(config).getComponent({ ...args });

getComponentRelatedIssues() - Get component issues count

Returns the counts of issues assigned to the component.

Usage:

import { ProjectComponentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectComponentsApi(config).getComponentRelatedIssues({ ...args });

getProjectComponents() - Get project components

Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.

Usage:

import { ProjectComponentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectComponentsApi(config).getProjectComponents({ ...args });

getProjectComponentsPaginated() - Get project components paginated

Returns a paginated representation of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.

Usage:

import { ProjectComponentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectComponentsApi(config).getProjectComponentsPaginated({ ...args });

updateComponent() - Update component

Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the component lead is removed.

Usage:

import { ProjectComponentsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectComponentsApi(config).updateComponent({
  id: string
  Component: { ... }
});

---

The ProjectKeyAndNameValidationApi object

getValidProjectKey() - Get valid project key

Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

Usage:

import { ProjectKeyAndNameValidationApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectKeyAndNameValidationApi(config).getValidProjectKey({ ...args });

getValidProjectName() - Get valid project name

Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

Usage:

import { ProjectKeyAndNameValidationApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectKeyAndNameValidationApi(config).getValidProjectName({ ...args });

validateProjectKey() - Validate project key

Validates a project key by confirming the key is a valid string and not in use.

Usage:

import { ProjectKeyAndNameValidationApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectKeyAndNameValidationApi(config).validateProjectKey({ ...args });

---

The ProjectPermissionSchemesApi object

assignPermissionScheme() - Assign permission scheme

Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.

Usage:

import { ProjectPermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectPermissionSchemesApi(config).assignPermissionScheme({
  projectKeyOrId: string
  expand: string
  IdBean: { ... }
});

getAssignedPermissionScheme() - Get assigned permission scheme

Gets the permission scheme associated with the project.

Usage:

import { ProjectPermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectPermissionSchemesApi(config).getAssignedPermissionScheme({ ...args });

getIssueSecurityScheme() - Get project issue security scheme

Returns the issue security scheme associated with the project.

Usage:

import { ProjectPermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectPermissionSchemesApi(config).getIssueSecurityScheme({ ...args });

getSecurityLevelsForProject() - Get project issue security levels

Returns all issue security levels for the project that the user has access to.

Usage:

import { ProjectPermissionSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectPermissionSchemesApi(config).getSecurityLevelsForProject({ ...args });

---

The ProjectPropertiesApi object

deleteProjectProperty() - Delete project property

Deletes the property from a project.

Usage:

import { ProjectPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectPropertiesApi(config).deleteProjectProperty({ ...args });

getProjectProperty() - Get project property

Returns the value of a project property.

Usage:

import { ProjectPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectPropertiesApi(config).getProjectProperty({ ...args });

getProjectPropertyKeys() - Get project property keys

Returns all project property keys for the project.

Usage:

import { ProjectPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectPropertiesApi(config).getProjectPropertyKeys({ ...args });

setProjectProperty() - Set project property

Sets the value of the project property. You can use project properties to store custom data against the project.

Usage:

import { ProjectPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectPropertiesApi(config).setProjectProperty({
  projectIdOrKey: string
  propertyKey: string
  bodies_setProjectProperty: { ... }
});

---

The ProjectRoleActorsApi object

addActorUsers() - Add actors to project role

Adds actors to a project role for the project.

Usage:

import { ProjectRoleActorsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRoleActorsApi(config).addActorUsers({
  projectIdOrKey: string
  id: integer
  ActorsMap: { ... }
});

addProjectRoleActorsToRole() - Add default actors to project role

Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request.

Usage:

import { ProjectRoleActorsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRoleActorsApi(config).addProjectRoleActorsToRole({
  id: integer
  ActorInputBean: { ... }
});

deleteActor() - Delete actors from project role

Deletes actors from a project role for the project.

Usage:

import { ProjectRoleActorsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRoleActorsApi(config).deleteActor({ ...args });

deleteProjectRoleActorsFromRole() - Delete default actors from project role

Deletes the default actors from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.

Usage:

import { ProjectRoleActorsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRoleActorsApi(config).deleteProjectRoleActorsFromRole({ ...args });

getProjectRoleActorsForRole() - Get default actors for project role

Returns the default actors for the project role.

Usage:

import { ProjectRoleActorsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRoleActorsApi(config).getProjectRoleActorsForRole({ ...args });

setActors() - Set actors for project role

Sets the actors for a project role for a project, replacing all existing actors.

Usage:

import { ProjectRoleActorsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRoleActorsApi(config).setActors({
  projectIdOrKey: string
  id: integer
  ProjectRoleActorsUpdateBean: { ... }
});

---

The ProjectRolesApi object

createProjectRole() - Create project role

Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).createProjectRole({
  CreateUpdateRoleRequestBean: { ... }
});

deleteProjectRole() - Delete project role

Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).deleteProjectRole({ ...args });

fullyUpdateProjectRole() - Fully update project role

Updates the project role's name and description. You must include both a name and a description in the request.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).fullyUpdateProjectRole({
  id: integer
  CreateUpdateRoleRequestBean: { ... }
});

getAllProjectRoles() - Get all project roles

Gets a list of all project roles, complete with project role details and default actors.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).getAllProjectRoles({ ...args });

getProjectRole() - Get project role for project

Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).getProjectRole({ ...args });

getProjectRoleById() - Get project role by ID

Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).getProjectRoleById({ ...args });

getProjectRoleDetails() - Get project role details

Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).getProjectRoleDetails({ ...args });

getProjectRoles() - Get project roles for project

Returns a list of project roles for the project returning the name and self URL for each role.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).getProjectRoles({ ...args });

partialUpdateProjectRole() - Partial update project role

Updates either the project role's name or its description.

Usage:

import { ProjectRolesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectRolesApi(config).partialUpdateProjectRole({
  id: integer
  CreateUpdateRoleRequestBean: { ... }
});

---

The ProjectTypesApi object

getAccessibleProjectTypeByKey() - Get accessible project type by key

Returns a project type if it is accessible to the user.

Usage:

import { ProjectTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectTypesApi(config).getAccessibleProjectTypeByKey({ ...args });

getAllProjectTypes() - Get all project types

Returns all project types, whether or not the instance has a valid license for each type.

Usage:

import { ProjectTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectTypesApi(config).getAllProjectTypes({ ...args });

getProjectTypeByKey() - Get project type by key

Returns a project type.

Usage:

import { ProjectTypesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectTypesApi(config).getProjectTypeByKey({ ...args });

---

The ProjectVersionsApi object

createVersion() - Create version

Creates a project version.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).createVersion({
  Version: { ... }
});

deleteAndReplaceVersion() - Delete and replace version

Deletes a project version.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).deleteAndReplaceVersion({
  id: string
  DeleteAndReplaceVersionBean: { ... }
});

deleteVersion() - Delete version

Deletes a project version.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).deleteVersion({ ...args });

getProjectVersions() - Get project versions

Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).getProjectVersions({ ...args });

getProjectVersionsPaginated() - Get project versions paginated

Returns a paginated representation of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).getProjectVersionsPaginated({ ...args });

getVersion() - Get version

Returns a project version.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).getVersion({ ...args });

getVersionRelatedIssues() - Get version's related issues count

Returns the following counts for a version:

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).getVersionRelatedIssues({ ...args });

getVersionUnresolvedIssues() - Get version's unresolved issues count

Returns counts of the issues and unresolved issues for the project version.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).getVersionUnresolvedIssues({ ...args });

mergeVersions() - Merge versions

Merges two project versions. The merge is completed by deleting the version specified in id and replacing any occurrences of its ID in fixVersion with the version ID specified in moveIssuesTo.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).mergeVersions({ ...args });

moveVersion() - Move version

Modifies the version's sequence within the project, which affects the display order of the versions in Jira.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).moveVersion({
  id: string
  VersionMoveBean: { ... }
});

updateVersion() - Update version

Updates a project version.

Usage:

import { ProjectVersionsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectVersionsApi(config).updateVersion({
  id: string
  Version: { ... }
});

---

The ProjectsApi object

createProject() - Create project

Creates a project based on a project type template, as shown in the following table:

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).createProject({
  ProjectInputBean: { ... }
});

deleteProject() - Delete project

Deletes a project.

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).deleteProject({ ...args });

getAllProjects() - Get all projects

Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination.

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).getAllProjects({ ...args });

getAllStatuses() - Get all statuses for project

Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).getAllStatuses({ ...args });

getNotificationScheme1() - Get project notification scheme

Gets a notification scheme associated with the project. See the Get notification scheme resource for more information about notification schemes.

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).getNotificationScheme1({ ...args });

getProject() - Get project

Returns the project details for a project.

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).getProject({ ...args });

searchProjects() - Get projects paginated

Returns projects visible to the user.

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).searchProjects({ ...args });

updateProject() - Update project

Updates the project details of a project.

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).updateProject({
  projectIdOrKey: string
  expand: string
  ProjectInputBean: { ... }
});

updateProjectType() - Update project type

Deprecated, this feature is no longer supported and no alternatives are available, see Convert project to a different template or type. Updates a project type. The project type can be updated for classic projects only, project type cannot be updated for next-gen projects.

Usage:

import { ProjectsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ProjectsApi(config).updateProjectType({ ...args });

---

The ScreensApi object

addFieldToDefaultScreen() - Add field to default screen

Adds a field to the default tab of the default screen.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).addFieldToDefaultScreen({ ...args });

addScreenTab() - Create screen tab

Creates a tab for a screen.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).addScreenTab({
  screenId: integer
  ScreenableTab: { ... }
});

addScreenTabField() - Add screen tab field

Adds a field to a screen tab.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).addScreenTabField({
  screenId: integer
  tabId: integer
  AddFieldBean: { ... }
});

deleteScreenTab() - Delete screen tab

Deletes a screen tab.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).deleteScreenTab({ ...args });

getAllScreenTabFields() - Get all screen tab fields

Returns all fields for a screen tab.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).getAllScreenTabFields({ ...args });

getAllScreenTabs() - Get all screen tabs

Returns the list of tabs for a screen.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).getAllScreenTabs({ ...args });

getAllScreens() - Get all screens

Returns all screens.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).getAllScreens({ ...args });

getAvailableScreenFields() - Get available screen fields

Returns the fields that can be added to a tab on a screen.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).getAvailableScreenFields({ ...args });

moveScreenTab() - Move screen tab

Moves a screen tab.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).moveScreenTab({ ...args });

moveScreenTabField() - Move screen tab field

Moves a screen tab field.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).moveScreenTabField({
  screenId: integer
  tabId: integer
  id: string
  MoveFieldBean: { ... }
});

removeScreenTabField() - Remove screen tab field

Removes a field from a screen tab.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).removeScreenTabField({ ...args });

renameScreenTab() - Update screen tab

Updates the name of a screen tab.

Usage:

import { ScreensApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ScreensApi(config).renameScreenTab({
  screenId: integer
  tabId: integer
  ScreenableTab: { ... }
});

---

The ServerInfoApi object

getServerInfo() - Get Jira instance info

Returns information about the Jira instance.

Usage:

import { ServerInfoApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServerInfoApi(config).getServerInfo({ ...args });

---

The TasksApi object

cancelTask() - Cancel task

Cancels a task.

Usage:

import { TasksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new TasksApi(config).cancelTask({ ...args });

getTask() - Get task

Returns the status of a long-running asynchronous task.

Usage:

import { TasksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new TasksApi(config).getTask({ ...args });

---

The TimeTrackingApi object

disableTimeTracking() - Disable time tracking

Disables time tracking.

Usage:

import { TimeTrackingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new TimeTrackingApi(config).disableTimeTracking({ ...args });

getAvailableTimeTrackingImplementations() - Get all time tracking providers

Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.

Usage:

import { TimeTrackingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new TimeTrackingApi(config).getAvailableTimeTrackingImplementations({ ...args });

getSelectedTimeTrackingImplementation() - Get selected time tracking provider

Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.

Usage:

import { TimeTrackingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new TimeTrackingApi(config).getSelectedTimeTrackingImplementation({ ...args });

getSharedTimeTrackingConfiguration() - Get time tracking settings

Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.

Usage:

import { TimeTrackingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new TimeTrackingApi(config).getSharedTimeTrackingConfiguration({ ...args });

selectTimeTrackingImplementation() - Select time tracking provider

Selects a time tracking provider.

Usage:

import { TimeTrackingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new TimeTrackingApi(config).selectTimeTrackingImplementation({
  TimeTrackingProvider: { ... }
});

setSharedTimeTrackingConfiguration() - Set time tracking settings

Sets the time tracking settings.

Usage:

import { TimeTrackingApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new TimeTrackingApi(config).setSharedTimeTrackingConfiguration({
  TimeTrackingConfiguration: { ... }
});

---

The UserPropertiesApi object

deleteUserProperty() - Delete user property

Deletes a property from a user.

Usage:

import { UserPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserPropertiesApi(config).deleteUserProperty({ ...args });

getUserProperty() - Get user property

Returns the value of a user's property. If no property key is provided Get user property keys is called.

Usage:

import { UserPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserPropertiesApi(config).getUserProperty({ ...args });

getUserPropertyKeys() - Get user property keys

Returns the keys of all properties for a user.

Usage:

import { UserPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserPropertiesApi(config).getUserPropertyKeys({ ...args });

setUserProperty() - Set user property

Sets the value of a user's property. Use this resource to store custom data against a user.

Usage:

import { UserPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserPropertiesApi(config).setUserProperty({
  accountId: string
  userKey: string
  username: string
  propertyKey: string
  bodies_setUserProperty: { ... }
});

---

The UserSearchApi object

findAssignableUsers() - Find users assignable to issues

Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:

Usage:

import { UserSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserSearchApi(config).findAssignableUsers({ ...args });

findBulkAssignableUsers() - Find users assignable to projects

Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.

Usage:

import { UserSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserSearchApi(config).findBulkAssignableUsers({ ...args });

findUserKeysByQuery() - Find user keys by query

Finds users with a structured query and returns a list of user keys.

Usage:

import { UserSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserSearchApi(config).findUserKeysByQuery({ ...args });

findUsers() - Find users

Returns a list of users that match the provided search string and property.

Usage:

import { UserSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserSearchApi(config).findUsers({ ...args });

findUsersByQuery() - Find users by query

Finds users with a structured query and returns user details.

Usage:

import { UserSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserSearchApi(config).findUsersByQuery({ ...args });

findUsersForPicker() - Find users for picker

Returns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.

Usage:

import { UserSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserSearchApi(config).findUsersForPicker({ ...args });

findUsersWithAllPermissions() - Find users with permissions

Returns a list of users who fulfill these criteria:

Usage:

import { UserSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserSearchApi(config).findUsersWithAllPermissions({ ...args });

findUsersWithBrowsePermission() - Find users with browse permission

Returns a list of users who fulfill these criteria:

Usage:

import { UserSearchApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UserSearchApi(config).findUsersWithBrowsePermission({ ...args });

---

The UsersApi object

bulkGetUsers() - Bulk get users

Returns details of the users specified by one or more account IDs.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).bulkGetUsers({ ...args });

bulkGetUsersMigration() - Get account IDs for users

Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).bulkGetUsersMigration({ ...args });

createUser() - Create user

Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).createUser({
  UserWriteBean: { ... }
});

getAllUsers() - Get all users

Returns a list of all (active and inactive) users.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).getAllUsers({ ...args });

getUser() - Get user

Returns a user.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).getUser({ ...args });

getUserDefaultColumns() - Get user default columns

Returns the default issue table columns for the user. If an accountId is not passed in the request, the calling user's details are returned.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).getUserDefaultColumns({ ...args });

getUserEmail() - Get user email

Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).getUserEmail({ ...args });

getUserEmailBulk() - Get user email bulk

Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).getUserEmailBulk({ ...args });

getUserGroups() - Get user groups

Returns the groups to which a user belongs.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).getUserGroups({ ...args });

removeUser() - Delete user

Deletes a user.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).removeUser({ ...args });

resetUserColumns() - Reset user default columns

Resets the default issue table columns for the user to the system default. If an accountId is not passed, the calling user's default columns are reset.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).resetUserColumns({ ...args });

setUserColumns() - Set user default columns

Sets the default issue table columns for the user. If an accountId is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.

Usage:

import { UsersApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new UsersApi(config).setUserColumns({
  accountId: string
  bodies_setUserColumns: { ... }
});

---

The WebhooksApi object

deleteWebhookById() - Delete webhooks by ID

Removes webhooks by ID. Only webhooks registered by the calling Connect app are removed. If webhooks created by other apps are specified, they are ignored.

Usage:

import { WebhooksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WebhooksApi(config).deleteWebhookById({
  ContainerForWebhookIDs: { ... }
});

getDynamicWebhooksForApp() - Get dynamic webhooks for app

Returns the webhooks registered by the calling app.

Usage:

import { WebhooksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WebhooksApi(config).getDynamicWebhooksForApp({ ...args });

refreshWebhooks() - Extend webhook life

Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive.

Usage:

import { WebhooksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WebhooksApi(config).refreshWebhooks({
  ContainerForWebhookIDs: { ... }
});

registerDynamicWebhooks() - Register dynamic webhooks

Registers webhooks.

Usage:

import { WebhooksApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WebhooksApi(config).registerDynamicWebhooks({
  WebhookRegistrationDetails: { ... }
});

---

The WorkflowSchemeDraftsApi object

createWorkflowSchemeDraftFromParent() - Create draft workflow scheme

Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).createWorkflowSchemeDraftFromParent({ ...args });

deleteDraftDefaultWorkflow() - Delete draft default workflow

Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).deleteDraftDefaultWorkflow({ ...args });

deleteDraftWorkflowMapping() - Delete issue types for workflow in draft workflow scheme

Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).deleteDraftWorkflowMapping({ ...args });

deleteWorkflowSchemeDraft() - Delete draft workflow scheme

Deletes a draft workflow scheme.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).deleteWorkflowSchemeDraft({ ...args });

deleteWorkflowSchemeDraftIssueType() - Delete workflow for issue type in draft workflow scheme

Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).deleteWorkflowSchemeDraftIssueType({ ...args });

getDraftDefaultWorkflow() - Get draft default workflow

Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).getDraftDefaultWorkflow({ ...args });

getDraftWorkflow() - Get issue types for workflows in draft workflow scheme

Returns the workflow-issue type mappings for a workflow scheme's draft.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).getDraftWorkflow({ ...args });

getWorkflowSchemeDraft() - Get draft workflow scheme

Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information.
Note that:

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).getWorkflowSchemeDraft({ ...args });

getWorkflowSchemeDraftIssueType() - Get workflow for issue type in draft workflow scheme

Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).getWorkflowSchemeDraftIssueType({ ...args });

setWorkflowSchemeDraftIssueType() - Set workflow for issue type in draft workflow scheme

Sets the workflow for an issue type in a workflow scheme's draft.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).setWorkflowSchemeDraftIssueType({
  id: integer
  issueType: string
  IssueTypeWorkflowMapping: { ... }
});

updateDraftDefaultWorkflow() - Update draft default workflow

Sets the default workflow for a workflow scheme's draft.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).updateDraftDefaultWorkflow({
  id: integer
  DefaultWorkflow: { ... }
});

updateDraftWorkflowMapping() - Set issue types for workflow in workflow scheme

Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).updateDraftWorkflowMapping({
  id: integer
  workflowName: string
  IssueTypesWorkflowMapping: { ... }
});

updateWorkflowSchemeDraft() - Update draft workflow scheme

Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.

Usage:

import { WorkflowSchemeDraftsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeDraftsApi(config).updateWorkflowSchemeDraft({
  id: integer
  WorkflowScheme: { ... }
});

---

The WorkflowSchemeProjectAssociationsApi object

getWorkflowSchemeProjectAssociations() - Get workflow scheme project associations

Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any next-gen or non-existent projects in the request are ignored and no errors are returned.

Usage:

import { WorkflowSchemeProjectAssociationsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemeProjectAssociationsApi(config).getWorkflowSchemeProjectAssociations({ ...args });

---

The WorkflowSchemesApi object

createWorkflowScheme() - Create workflow scheme

Creates a workflow scheme.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).createWorkflowScheme({
  WorkflowScheme: { ... }
});

deleteDefaultWorkflow() - Delete default workflow

Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).deleteDefaultWorkflow({ ...args });

deleteWorkflowMapping() - Delete issue types for workflow in workflow scheme

Deletes the workflow-issue type mapping for a workflow in a workflow scheme.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).deleteWorkflowMapping({ ...args });

deleteWorkflowScheme() - Delete workflow scheme

Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).deleteWorkflowScheme({ ...args });

deleteWorkflowSchemeIssueType() - Delete workflow for issue type in workflow scheme

Deletes the issue type-workflow mapping for an issue type in a workflow scheme.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).deleteWorkflowSchemeIssueType({ ...args });

getDefaultWorkflow() - Get default workflow

Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).getDefaultWorkflow({ ...args });

getWorkflow() - Get issue types for workflows in workflow scheme

Returns the workflow-issue type mappings for a workflow scheme.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).getWorkflow({ ...args });

getWorkflowScheme() - Get workflow scheme

Returns a workflow scheme.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).getWorkflowScheme({ ...args });

getWorkflowSchemeIssueType() - Get workflow for issue type in workflow scheme

Returns the issue type-workflow mapping for an issue type in a workflow scheme.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).getWorkflowSchemeIssueType({ ...args });

setWorkflowSchemeIssueType() - Set workflow for issue type in workflow scheme

Sets the workflow for an issue type in a workflow scheme.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).setWorkflowSchemeIssueType({
  id: integer
  issueType: string
  IssueTypeWorkflowMapping: { ... }
});

updateDefaultWorkflow() - Update default workflow

Sets the default workflow for a workflow scheme.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).updateDefaultWorkflow({
  id: integer
  DefaultWorkflow: { ... }
});

updateWorkflowMapping() - Set issue types for workflow in workflow scheme

Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).updateWorkflowMapping({
  id: integer
  workflowName: string
  IssueTypesWorkflowMapping: { ... }
});

updateWorkflowScheme() - Update workflow scheme

Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.

Usage:

import { WorkflowSchemesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowSchemesApi(config).updateWorkflowScheme({
  id: integer
  WorkflowScheme: { ... }
});

---

The WorkflowStatusCategoriesApi object

getStatusCategories() - Get all status categories

Returns a list of all status categories.

Usage:

import { WorkflowStatusCategoriesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowStatusCategoriesApi(config).getStatusCategories({ ...args });

getStatusCategory() - Get status category

Returns a status category. Status categories provided a mechanism for categorizing statuses.

Usage:

import { WorkflowStatusCategoriesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowStatusCategoriesApi(config).getStatusCategory({ ...args });

---

The WorkflowStatusesApi object

getStatus() - Get status

Returns a status. The status must be associated with a workflow to be returned.

Usage:

import { WorkflowStatusesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowStatusesApi(config).getStatus({ ...args });

getStatuses() - Get all statuses

Returns a list of all statuses associated with workflows.

Usage:

import { WorkflowStatusesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowStatusesApi(config).getStatuses({ ...args });

---

The WorkflowTransitionPropertiesApi object

createWorkflowTransitionProperty() - Create workflow transition property

Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Usage:

import { WorkflowTransitionPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowTransitionPropertiesApi(config).createWorkflowTransitionProperty({
  transitionId: integer
  key: string
  workflowName: string
  workflowMode: string
  WorkflowTransitionProperty: { ... }
});

deleteWorkflowTransitionProperty() - Delete workflow transition property

Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Usage:

import { WorkflowTransitionPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowTransitionPropertiesApi(config).deleteWorkflowTransitionProperty({ ...args });

getWorkflowTransitionProperties() - Get workflow transition properties

Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Usage:

import { WorkflowTransitionPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowTransitionPropertiesApi(config).getWorkflowTransitionProperties({ ...args });

updateWorkflowTransitionProperty() - Update workflow transition property

Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Usage:

import { WorkflowTransitionPropertiesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowTransitionPropertiesApi(config).updateWorkflowTransitionProperty({
  transitionId: integer
  key: string
  workflowName: string
  workflowMode: string
  WorkflowTransitionProperty: { ... }
});

---

The WorkflowTransitionRulesApi object

getWorkflowTransitionRuleConfigurations() - Get workflow transition rule configurations

Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:

Usage:

import { WorkflowTransitionRulesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowTransitionRulesApi(config).getWorkflowTransitionRuleConfigurations({ ...args });

updateWorkflowTransitionRuleConfigurations() - Update workflow transition rule configurations

Updates configuration of workflow transition rules. The following rule types are supported:

Usage:

import { WorkflowTransitionRulesApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowTransitionRulesApi(config).updateWorkflowTransitionRuleConfigurations({
  WorkflowTransitionRulesUpdate: { ... }
});

---

The WorkflowsApi object

getAllWorkflows() - Get all workflows

Returns all workflows in Jira or a workflow. Deprecated, use Get workflows paginated.

Usage:

import { WorkflowsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowsApi(config).getAllWorkflows({ ...args });

getWorkflowsPaginated() - Get workflows paginated

Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

Usage:

import { WorkflowsApi, Configuration } from 'fetch-jira';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new WorkflowsApi(config).getWorkflowsPaginated({ ...args });

References

ProjectIdentifierBean

{
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "The ID of the project."
    },
    "key": {
      "readOnly": true,
      "description": "The key of the project.",
      "type": "string"
    }
  },
  "description": "The identifiers for a project.",
  "additionalProperties": false,
  "type": "object"
}

JiraExpressionsComplexityValueBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "value": {
      "description": "The complexity value of the current expression.",
      "format": "int32",
      "type": "integer"
    },
    "limit": {
      "type": "integer",
      "format": "int32",
      "description": "The maximum allowed complexity. The evaluation will fail if this value is exceeded."
    }
  },
  "required": [
    "limit",
    "value"
  ]
}

FieldWasClause

{
  "type": "object",
  "description": "A clause that asserts a previous value of a field. For example, `status WAS \"Resolved\" BY currentUser() BEFORE \"2019/02/02\"`. See [WAS](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-WASWAS) for more information about the WAS operator.",
  "required": [
    "field",
    "operand",
    "operator",
    "predicates"
  ],
  "properties": {
    "operator": {
      "enum": [
        "was",
        "was in",
        "was not in",
        "was not"
      ],
      "description": "The operator between the field and operand.",
      "type": "string"
    },
    "field": {
      "$ref": "#/components/schemas/JqlQueryField"
    },
    "predicates": {
      "items": {
        "$ref": "#/components/schemas/JqlQueryClauseTimePredicate"
      },
      "description": "The list of time predicates.",
      "type": "array"
    },
    "operand": {
      "$ref": "#/components/schemas/JqlQueryClauseOperand"
    }
  }
}

ProjectCategory

{
  "additionalProperties": false,
  "description": "A project category.",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "The description of the project category. Required on create, optional on update."
    },
    "name": {
      "description": "The name of the project category. Required on create, optional on update.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the project category.",
      "readOnly": true,
      "type": "string"
    },
    "self": {
      "type": "string",
      "description": "The URL of the project category.",
      "format": "uri",
      "readOnly": true
    }
  },
  "title": "ProjectCategory"
}

PageBeanWebhook

{
  "type": "object",
  "description": "A page of items.",
  "additionalProperties": false,
  "properties": {
    "startAt": {
      "format": "int64",
      "readOnly": true,
      "description": "The index of the first item returned.",
      "type": "integer"
    },
    "nextPage": {
      "readOnly": true,
      "format": "uri",
      "description": "If there is another page of results, the URL of the next page.",
      "type": "string"
    },
    "maxResults": {
      "description": "The maximum number of items that could be returned.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "values": {
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/Webhook"
      },
      "description": "The list of items.",
      "type": "array"
    },
    "isLast": {
      "description": "Indicates whether this is the last page.",
      "readOnly": true,
      "type": "boolean"
    },
    "total": {
      "type": "integer",
      "description": "The number of items returned.",
      "format": "int64",
      "readOnly": true
    },
    "self": {
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the page.",
      "type": "string"
    }
  }
}

Icon

{
  "properties": {
    "url16x16": {
      "description": "The URL of an icon that displays at 16x16 pixel in Jira.",
      "type": "string"
    },
    "link": {
      "description": "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.",
      "type": "string"
    },
    "title": {
      "description": "The title of the icon. This is used as follows:\n\n *  For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n *  For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\".",
      "type": "string"
    }
  },
  "type": "object",
  "additionalProperties": true,
  "description": "An icon. If no icon is defined:\n\n *  for a status icon, no status icon displays in Jira.\n *  for the remote object icon, the default link icon displays in Jira."
}

StatusCategory

{
  "properties": {
    "key": {
      "type": "string",
      "readOnly": true,
      "description": "The key of the status category."
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the status category."
    },
    "self": {
      "readOnly": true,
      "description": "The URL of the status category.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the status category.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "colorName": {
      "description": "The name of the color used to represent the status category.",
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object",
  "additionalProperties": true,
  "description": "A status category."
}

WorkflowStatus

{
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the status in the workflow."
    },
    "properties": {
      "$ref": "#/components/schemas/WorkflowStatusProperties"
    },
    "id": {
      "type": "string",
      "description": "The ID of the issue status."
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details of a workflow status."
}

PublishedWorkflowId

{
  "type": "object",
  "additionalProperties": false,
  "description": "Properties that identify a published workflow.",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the workflow."
    }
  }
}

ProjectIssueSecurityLevels

{
  "required": [
    "levels"
  ],
  "properties": {
    "levels": {
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/SecurityLevel"
      },
      "description": "Issue level security items list.",
      "type": "array"
    }
  },
  "type": "object",
  "description": "List of issue level security items in a project.",
  "additionalProperties": false
}

Component

{
  "properties": {
    "leadUserName": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
    },
    "isAssigneeTypeValid": {
      "type": "boolean",
      "description": "Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.",
      "readOnly": true
    },
    "assignee": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.",
      "readOnly": true
    },
    "realAssigneeType": {
      "readOnly": true,
      "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n *  `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n *  `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n *  `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n *  `PROJECT_DEFAULT` when none of the preceding cases are true.",
      "type": "string",
      "enum": [
        "PROJECT_DEFAULT",
        "COMPONENT_LEAD",
        "PROJECT_LEAD",
        "UNASSIGNED"
      ]
    },
    "self": {
      "type": "string",
      "description": "The URL of the component.",
      "format": "uri",
      "readOnly": true
    },
    "project": {
      "description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated.",
      "type": "string"
    },
    "realAssignee": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "readOnly": true,
      "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee."
    },
    "projectId": {
      "format": "int64",
      "readOnly": true,
      "description": "The ID of the project the component is assigned to.",
      "type": "integer"
    },
    "description": {
      "type": "string",
      "description": "The description for the component. Optional when creating or updating a component."
    },
    "name": {
      "type": "string",
      "description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters."
    },
    "assigneeType": {
      "enum": [
        "PROJECT_DEFAULT",
        "COMPONENT_LEAD",
        "PROJECT_LEAD",
        "UNASSIGNED"
      ],
      "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n *  `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n *  `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n *  `UNASSIGNED` an assignee is not set for issues created with this component.\n *  `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`.  \nOptional when creating or updating a component.",
      "type": "string"
    },
    "leadAccountId": {
      "description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Optional when creating or updating a component.",
      "type": "string"
    },
    "lead": {
      "readOnly": true,
      "description": "The user details for the component's lead user.",
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ]
    },
    "id": {
      "type": "string",
      "description": "The unique identifier for the component.",
      "readOnly": true
    }
  },
  "type": "object",
  "xml": {
    "name": "component"
  },
  "description": "Details about a project component.",
  "additionalProperties": false,
  "title": "Component"
}

ConnectWorkflowTransitionRule

{
  "required": [
    "id",
    "key"
  ],
  "properties": {
    "id": {
      "description": "The ID of the transition rule.",
      "type": "string"
    },
    "transition": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowTransition"
        }
      ]
    },
    "key": {
      "readOnly": true,
      "description": "The key of the rule, as defined in the Connect app descriptor.",
      "type": "string"
    },
    "configuration": {
      "$ref": "#/components/schemas/RuleConfiguration"
    }
  },
  "type": "object",
  "description": "A workflow transition rule.",
  "additionalProperties": false
}

JiraExpressionEvaluationMetaDataBean

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "issues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IssuesMetaBean"
        }
      ],
      "description": "Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, information about the page will be included here."
    },
    "complexity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JiraExpressionsComplexityBean"
        }
      ],
      "description": "Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression."
    }
  }
}

WebhookRegistrationDetails

{
  "type": "object",
  "additionalProperties": false,
  "description": "Details of webhooks to register.",
  "required": [
    "url",
    "webhooks"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The URL that specifies where to send the webhooks."
    },
    "webhooks": {
      "items": {
        "$ref": "#/components/schemas/WebhookDetails"
      },
      "description": "A list of webhooks.",
      "type": "array"
    }
  },
  "title": "WebhookRegistrationDetails"
}

ValueOperand

{
  "description": "An operand that is a user-provided value.",
  "type": "object",
  "properties": {
    "value": {
      "description": "The operand value.",
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

DefaultWorkflow

{
  "properties": {
    "workflow": {
      "description": "The name of the workflow to set as the default workflow.",
      "type": "string"
    },
    "updateDraftIfNeeded": {
      "type": "boolean",
      "description": "Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`."
    }
  },
  "required": [
    "workflow"
  ],
  "additionalProperties": false,
  "description": "Details about the default workflow.",
  "type": "object",
  "title": "DefaultWorkflow"
}

IssueBean

{
  "properties": {
    "editmeta": {
      "readOnly": true,
      "description": "The metadata for the fields on the issue that can be amended.",
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueUpdateMetadata"
        }
      ]
    },
    "self": {
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the issue details.",
      "type": "string"
    },
    "changelog": {
      "description": "Details of changelogs associated with the issue.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/PageOfChangelogs"
        }
      ]
    },
    "fields": {
      "type": "object",
      "additionalProperties": {}
    },
    "properties": {
      "type": "object",
      "additionalProperties": {
        "readOnly": true
      },
      "description": "Details of the issue properties identified in the request.",
      "readOnly": true
    },
    "schema": {
      "readOnly": true,
      "description": "The schema describing each field present on the issue.",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonTypeBean"
      },
      "type": "object"
    },
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "The ID of the issue."
    },
    "fieldsToInclude": {
      "$ref": "#/components/schemas/IncludedFields"
    },
    "names": {
      "additionalProperties": {
        "type": "string",
        "readOnly": true
      },
      "description": "The ID and name of each field present on the issue.",
      "readOnly": true,
      "type": "object"
    },
    "operations": {
      "readOnly": true,
      "description": "The operations that can be performed on the issue.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Operations"
        }
      ]
    },
    "renderedFields": {
      "type": "object",
      "readOnly": true,
      "description": "The rendered value of each field present on the issue.",
      "additionalProperties": {
        "readOnly": true
      }
    },
    "key": {
      "readOnly": true,
      "description": "The key of the issue.",
      "type": "string"
    },
    "transitions": {
      "readOnly": true,
      "description": "The transitions that can be performed on the issue.",
      "items": {
        "$ref": "#/components/schemas/IssueTransition"
      },
      "type": "array"
    },
    "versionedRepresentations": {
      "additionalProperties": {
        "additionalProperties": {
          "readOnly": true
        },
        "readOnly": true,
        "type": "object"
      },
      "description": "The versions of each field on the issue.",
      "readOnly": true,
      "type": "object"
    },
    "expand": {
      "type": "string",
      "xml": {
        "attribute": true
      },
      "readOnly": true,
      "description": "Expand options that include additional issue details in the response."
    }
  },
  "xml": {
    "name": "issue"
  },
  "type": "object",
  "additionalProperties": false
}

JsonTypeBean

{
  "properties": {
    "type": {
      "type": "string",
      "readOnly": true,
      "description": "The data type of the field."
    },
    "configuration": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "readOnly": true
      },
      "description": "If the field is a custom field, the configuration of the field."
    },
    "system": {
      "type": "string",
      "description": "If the field is a system field, the name of the field.",
      "readOnly": true
    },
    "items": {
      "description": "When the data type is an array, the name of the field items within the array.",
      "readOnly": true,
      "type": "string"
    },
    "customId": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "If the field is a custom field, the custom ID of the field."
    },
    "custom": {
      "description": "If the field is a custom field, the URI of the field.",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false,
  "description": "The schema of a field.",
  "type": "object"
}

JqlQueryUnitaryOperand

{
  "description": "An operand that can be part of a list operand.",
  "type": "object",
  "anyOf": [
    {
      "$ref": "#/components/schemas/ValueOperand"
    },
    {
      "$ref": "#/components/schemas/FunctionOperand"
    },
    {
      "$ref": "#/components/schemas/KeywordOperand"
    }
  ]
}

PageBeanIssueFieldOption

{
  "properties": {
    "isLast": {
      "readOnly": true,
      "description": "Indicates whether this is the last page.",
      "type": "boolean"
    },
    "self": {
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the page.",
      "type": "string"
    },
    "total": {
      "description": "The number of items returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IssueFieldOption"
      },
      "description": "The list of items.",
      "readOnly": true
    },
    "maxResults": {
      "format": "int32",
      "readOnly": true,
      "description": "The maximum number of items that could be returned.",
      "type": "integer"
    },
    "nextPage": {
      "description": "If there is another page of results, the URL of the next page.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A page of items."
}

PageBeanWorkflowTransitionRules

{
  "properties": {
    "self": {
      "description": "The URL of the page.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "isLast": {
      "description": "Indicates whether this is the last page.",
      "readOnly": true,
      "type": "boolean"
    },
    "total": {
      "type": "integer",
      "description": "The number of items returned.",
      "readOnly": true,
      "format": "int64"
    },
    "values": {
      "items": {
        "$ref": "#/components/schemas/WorkflowTransitionRules"
      },
      "description": "The list of items.",
      "readOnly": true,
      "type": "array"
    },
    "maxResults": {
      "type": "integer",
      "description": "The maximum number of items that could be returned.",
      "readOnly": true,
      "format": "int32"
    },
    "nextPage": {
      "description": "If there is another page of results, the URL of the next page.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    }
  },
  "description": "A page of items.",
  "additionalProperties": false,
  "type": "object"
}

HierarchyLevelOutput

{
  "properties": {
    "issueTypes": {
      "items": {
        "$ref": "#/components/schemas/MinimalIssueTypeOutput"
      },
      "type": "array"
    },
    "level": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string"
    },
    "entityId": {
      "format": "uuid",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "type": "object"
}

UserWriteBean

{
  "properties": {
    "self": {
      "description": "The URL of the user.",
      "readOnly": true,
      "type": "string"
    },
    "key": {
      "type": "string",
      "description": "The key for the user. When provided with `name`, overrides the value in `name` to set both `name` and `key`. This property is deprecated because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
    },
    "applicationKeys": {
      "items": {
        "type": "string"
      },
      "description": "Deprecated, do not use.",
      "type": "array"
    },
    "displayName": {
      "type": "string",
      "description": "The display name for the user. Required."
    },
    "name": {
      "type": "string",
      "description": "The username for the user. This property is deprecated because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
    },
    "emailAddress": {
      "description": "The email address for the user. Required.",
      "type": "string"
    },
    "password": {
      "description": "A password for the user. If a password is not set, a random password is generated.",
      "type": "string"
    },
    "notification": {
      "description": "Sends the user an email confirmation that they have been added to Jira. Default is `false`.",
      "type": "string"
    }
  },
  "required": [
    "displayName",
    "emailAddress"
  ],
  "additionalProperties": true,
  "type": "object",
  "title": "UserWriteBean"
}

ChangedValueBean

{
  "type": "object",
  "description": "Details of names changed in the record event.",
  "additionalProperties": false,
  "properties": {
    "changedFrom": {
      "readOnly": true,
      "description": "The value of the field before the change.",
      "type": "string"
    },
    "fieldName": {
      "readOnly": true,
      "description": "The name of the field changed.",
      "type": "string"
    },
    "changedTo": {
      "readOnly": true,
      "description": "The value of the field after the change.",
      "type": "string"
    }
  }
}

IssuesAndJQLQueries

{
  "required": [
    "issueIds",
    "jqls"
  ],
  "properties": {
    "jqls": {
      "items": {
        "type": "string",
        "description": "A list of JQL queries."
      },
      "description": "A list of JQL queries.",
      "type": "array"
    },
    "issueIds": {
      "description": "A list of issue IDs.",
      "items": {
        "type": "integer",
        "description": "A list of issue IDs.",
        "format": "int64"
      },
      "uniqueItems": true,
      "type": "array"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "List of issues and JQL queries.",
  "title": "IssuesAndJQLQueries"
}

IncludedFields

{
  "properties": {
    "included": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    },
    "excluded": {
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "actuallyIncluded": {
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  "additionalProperties": false
}

WorkflowTransitionRulesUpdateErrorDetails

{
  "required": [
    "ruleUpdateErrors"
  ],
  "properties": {
    "updateErrors": {
      "items": {
        "description": "An error specifying why the workflow update failed.",
        "type": "string"
      },
      "description": "The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries.",
      "uniqueItems": true,
      "type": "array"
    },
    "ruleUpdateErrors": {
      "additionalProperties": {
        "type": "array",
        "items": {
          "description": "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.",
          "type": "string"
        },
        "description": "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.",
        "uniqueItems": true
      },
      "description": "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.",
      "type": "object"
    },
    "workflowId": {
      "$ref": "#/components/schemas/WorkflowId"
    }
  },
  "type": "object",
  "description": "Details of any errors encountered while updating workflow transition rules for a workflow.",
  "additionalProperties": false
}

PageBeanUser

{
  "type": "object",
  "additionalProperties": false,
  "description": "A page of items.",
  "properties": {
    "nextPage": {
      "type": "string",
      "description": "If there is another page of results, the URL of the next page.",
      "readOnly": true,
      "format": "uri"
    },
    "maxResults": {
      "readOnly": true,
      "format": "int32",
      "description": "The maximum number of items that could be returned.",
      "type": "integer"
    },
    "startAt": {
      "readOnly": true,
      "format": "int64",
      "description": "The index of the first item returned.",
      "type": "integer"
    },
    "isLast": {
      "type": "boolean",
      "description": "Indicates whether this is the last page.",
      "readOnly": true
    },
    "total": {
      "description": "The number of items returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "self": {
      "type": "string",
      "description": "The URL of the page.",
      "readOnly": true,
      "format": "uri"
    },
    "values": {
      "type": "array",
      "readOnly": true,
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/User"
      }
    }
  }
}

IssuesJqlMetaDataBean

{
  "description": "The description of the page of issues loaded by the provided JQL query.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "startAt": {
      "type": "integer",
      "description": "The index of the first issue.",
      "format": "int64"
    },
    "maxResults": {
      "type": "integer",
      "description": "The maximum number of issues that could be loaded in this evaluation.",
      "format": "int32"
    },
    "validationWarnings": {
      "type": "array",
      "description": "Any warnings related to the JQL query. Present only if the validation mode was set to `warn`.",
      "items": {
        "type": "string"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int64",
      "description": "The total number of issues the JQL returned."
    },
    "count": {
      "type": "integer",
      "description": "The number of issues that were loaded in this evaluation.",
      "format": "int32"
    }
  },
  "required": [
    "count",
    "maxResults",
    "startAt",
    "totalCount"
  ]
}

FieldChangedClause

{
  "required": [
    "field",
    "operator",
    "predicates"
  ],
  "properties": {
    "predicates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JqlQueryClauseTimePredicate"
      },
      "description": "The list of time predicates."
    },
    "operator": {
      "type": "string",
      "description": "The operator applied to the field.",
      "enum": [
        "changed"
      ]
    },
    "field": {
      "$ref": "#/components/schemas/JqlQueryField"
    }
  },
  "type": "object",
  "description": "A clause that asserts whether a field was changed. For example, `status CHANGED AFTER startOfMonth(-1M)`.See [CHANGED](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for more information about the CHANGED operator."
}

SimpleListWrapperApplicationRole

{
  "type": "object",
  "xml": {
    "name": "list"
  },
  "additionalProperties": false,
  "properties": {
    "pagingCallback": {
      "$ref": "#/components/schemas/ListWrapperCallbackApplicationRole"
    },
    "size": {
      "type": "integer",
      "xml": {
        "attribute": true
      },
      "format": "int32"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApplicationRole"
      }
    },
    "callback": {
      "$ref": "#/components/schemas/ListWrapperCallbackApplicationRole"
    },
    "max-results": {
      "type": "integer",
      "xml": {
        "name": "max-results",
        "attribute": true
      },
      "format": "int32"
    }
  }
}

ListOperand

{
  "properties": {
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JqlQueryUnitaryOperand"
      },
      "description": "The list of operand values.",
      "minLength": 1
    }
  },
  "description": "An operand that is a list of values.",
  "type": "object"
}

PageOfComments

{
  "properties": {
    "total": {
      "readOnly": true,
      "format": "int64",
      "description": "The number of items returned.",
      "type": "integer"
    },
    "startAt": {
      "type": "integer",
      "description": "The index of the first item returned.",
      "readOnly": true,
      "format": "int64"
    },
    "comments": {
      "type": "array",
      "description": "The list of comments.",
      "items": {
        "$ref": "#/components/schemas/Comment"
      },
      "readOnly": true
    },
    "maxResults": {
      "type": "integer",
      "description": "The maximum number of items that could be returned.",
      "readOnly": true,
      "format": "int32"
    }
  },
  "type": "object",
  "additionalProperties": true,
  "description": "A page of comments."
}

Attachment

{
  "type": "object",
  "description": "Details about an attachment.",
  "additionalProperties": true,
  "properties": {
    "mimeType": {
      "type": "string",
      "description": "The MIME type of the attachment.",
      "readOnly": true
    },
    "id": {
      "readOnly": true,
      "description": "The ID of the attachment.",
      "type": "string"
    },
    "size": {
      "type": "integer",
      "description": "The size of the attachment.",
      "format": "int64",
      "readOnly": true
    },
    "self": {
      "readOnly": true,
      "description": "The URL of the attachment details response.",
      "type": "string"
    },
    "thumbnail": {
      "type": "string",
      "readOnly": true,
      "description": "The URL of a thumbnail representing the attachment."
    },
    "filename": {
      "readOnly": true,
      "description": "The file name of the attachment.",
      "type": "string"
    },
    "author": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ],
      "readOnly": true,
      "description": "Details of the user who added the attachment."
    },
    "created": {
      "description": "The datetime the attachment was created.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "content": {
      "readOnly": true,
      "description": "The content of the attachment.",
      "type": "string"
    }
  }
}

PageBeanFoundFilter

{
  "properties": {
    "startAt": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "The index of the first item returned."
    },
    "nextPage": {
      "readOnly": true,
      "format": "uri",
      "description": "If there is another page of results, the URL of the next page.",
      "type": "string"
    },
    "maxResults": {
      "description": "The maximum number of items that could be returned.",
      "readOnly": true,
      "format": "int32",
      "type": "integer"
    },
    "values": {
      "readOnly": true,
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/FoundFilter"
      },
      "type": "array"
    },
    "isLast": {
      "type": "boolean",
      "description": "Indicates whether this is the last page.",
      "readOnly": true
    },
    "self": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the page."
    },
    "total": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The number of items returned."
    }
  },
  "description": "A page of items.",
  "additionalProperties": false,
  "type": "object"
}

CustomFieldOption

{
  "additionalProperties": false,
  "description": "Details of a custom option for a field.",
  "xml": {
    "name": "customFieldOption"
  },
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The URL of these custom field option details."
    },
    "value": {
      "type": "string",
      "readOnly": true,
      "description": "The value of the custom field option."
    }
  }
}

AvatarUrlsBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "32x32": {
      "description": "The URL of the item's 32x32 pixel avatar.",
      "format": "uri",
      "type": "string"
    },
    "24x24": {
      "format": "uri",
      "description": "The URL of the item's 24x24 pixel avatar.",
      "type": "string"
    },
    "16x16": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the item's 16x16 pixel avatar."
    },
    "48x48": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the item's 48x48 pixel avatar."
    }
  }
}

FilterSubscription

{
  "type": "object",
  "additionalProperties": false,
  "description": "Details of a user or group subscribing to a filter.",
  "properties": {
    "user": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "description": "The user subscribing to filter.",
      "readOnly": true
    },
    "id": {
      "type": "integer",
      "description": "The ID of the filter subscription.",
      "format": "int64",
      "readOnly": true
    },
    "group": {
      "description": "The group subscribing to filter.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupName"
        }
      ]
    }
  }
}

PageOfDashboards

{
  "type": "object",
  "description": "A page containing dashboard details.",
  "additionalProperties": false,
  "properties": {
    "dashboards": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/Dashboard"
      },
      "description": "List of dashboards."
    },
    "startAt": {
      "description": "The index of the first item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "next": {
      "readOnly": true,
      "description": "The URL of the next page of results, if any.",
      "type": "string"
    },
    "maxResults": {
      "description": "The maximum number of results that could be on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "prev": {
      "readOnly": true,
      "description": "The URL of the previous page of results, if any.",
      "type": "string"
    },
    "total": {
      "type": "integer",
      "description": "The number of results on the page.",
      "format": "int32",
      "readOnly": true
    }
  }
}

FoundUsers

{
  "properties": {
    "users": {
      "items": {
        "$ref": "#/components/schemas/UserPickerUser"
      },
      "type": "array"
    },
    "header": {
      "type": "string",
      "description": "Header text indicating the number of users in the response and the total number of users found in the search."
    },
    "total": {
      "format": "int32",
      "description": "The total number of users found in the search.",
      "type": "integer"
    }
  },
  "type": "object",
  "description": "The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.",
  "additionalProperties": false
}

PageBeanProject

{
  "properties": {
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Project"
      },
      "description": "The list of items.",
      "readOnly": true
    },
    "self": {
      "type": "string",
      "description": "The URL of the page.",
      "format": "uri",
      "readOnly": true
    },
    "isLast": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether this is the last page."
    },
    "total": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The number of items returned."
    },
    "startAt": {
      "type": "integer",
      "description": "The index of the first item returned.",
      "readOnly": true,
      "format": "int64"
    },
    "maxResults": {
      "readOnly": true,
      "format": "int32",
      "description": "The maximum number of items that could be returned.",
      "type": "integer"
    },
    "nextPage": {
      "type": "string",
      "description": "If there is another page of results, the URL of the next page.",
      "format": "uri",
      "readOnly": true
    }
  },
  "type": "object",
  "description": "A page of items.",
  "additionalProperties": false
}

NotificationScheme

{
  "additionalProperties": false,
  "description": "Details about a notification scheme.",
  "type": "object",
  "properties": {
    "self": {
      "type": "string"
    },
    "id": {
      "description": "The ID of the notification scheme.",
      "format": "int64",
      "type": "integer"
    },
    "scope": {
      "description": "The scope of the notification scheme.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ]
    },
    "name": {
      "description": "The name of the notification scheme.",
      "type": "string"
    },
    "notificationSchemeEvents": {
      "items": {
        "$ref": "#/components/schemas/NotificationSchemeEvent"
      },
      "description": "The notification events and associated recipients.",
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of the notification scheme."
    },
    "expand": {
      "type": "string",
      "description": "Expand options that include additional notification scheme details in the response."
    }
  }
}

PageBeanComponentWithIssueCount

{
  "type": "object",
  "description": "A page of items.",
  "additionalProperties": false,
  "properties": {
    "isLast": {
      "description": "Indicates whether this is the last page.",
      "readOnly": true,
      "type": "boolean"
    },
    "self": {
      "description": "The URL of the page.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    },
    "total": {
      "readOnly": true,
      "format": "int64",
      "description": "The number of items returned.",
      "type": "integer"
    },
    "values": {
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/ComponentWithIssueCount"
      },
      "readOnly": true,
      "type": "array"
    },
    "nextPage": {
      "type": "string",
      "readOnly": true,
      "format": "uri",
      "description": "If there is another page of results, the URL of the next page."
    },
    "maxResults": {
      "type": "integer",
      "description": "The maximum number of items that could be returned.",
      "readOnly": true,
      "format": "int32"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    }
  }
}

WebhooksExpirationDate

{
  "additionalProperties": false,
  "description": "The date the newly refreshed webhooks expire.",
  "type": "object",
  "properties": {
    "expirationDate": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    }
  },
  "required": [
    "expirationDate"
  ]
}

ProjectPermissions

{
  "type": "object",
  "description": "Permissions which a user has on a project.",
  "additionalProperties": false,
  "properties": {
    "canEdit": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether the logged user can edit the project."
    }
  }
}

Status

{
  "description": "The status of the item.",
  "additionalProperties": true,
  "type": "object",
  "properties": {
    "icon": {
      "description": "Details of the icon representing the status. If not provided, no status icon displays in Jira.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Icon"
        }
      ]
    },
    "resolved": {
      "description": "Indicates whether the item is resolved. If set to \"true\", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.",
      "type": "boolean"
    }
  }
}

avatarUrls

{
  "$ref": "#/components/schemas/AvatarUrlsBean",
  "description": "The avatars of the user."
}

TaskProgressBeanRemoveOptionFromIssuesResult

{
  "required": [
    "elapsedRuntime",
    "id",
    "lastUpdate",
    "progress",
    "self",
    "status",
    "submitted",
    "submittedBy"
  ],
  "properties": {
    "progress": {
      "description": "The progress of the task, as a percentage complete.",
      "format": "int64",
      "type": "integer"
    },
    "description": {
      "description": "The description of the task.",
      "type": "string"
    },
    "lastUpdate": {
      "format": "int64",
      "description": "A timestamp recording when the task progress was last updated.",
      "type": "integer"
    },
    "id": {
      "type": "string",
      "description": "The ID of the task."
    },
    "finished": {
      "type": "integer",
      "format": "int64",
      "description": "A timestamp recording when the task was finished."
    },
    "submitted": {
      "format": "int64",
      "description": "A timestamp recording when the task was submitted.",
      "type": "integer"
    },
    "result": {
      "description": "The result of the task execution.",
      "allOf": [
        {
          "$ref": "#/components/schemas/RemoveOptionFromIssuesResult"
        }
      ]
    },
    "message": {
      "description": "Information about the progress of the task.",
      "type": "string"
    },
    "submittedBy": {
      "type": "integer",
      "description": "The ID of the user who submitted the task.",
      "format": "int64"
    },
    "self": {
      "description": "The URL of the task.",
      "format": "uri",
      "type": "string"
    },
    "elapsedRuntime": {
      "description": "The execution time of the task, in milliseconds.",
      "format": "int64",
      "type": "integer"
    },
    "status": {
      "description": "The status of the task.",
      "type": "string",
      "enum": [
        "ENQUEUED",
        "RUNNING",
        "COMPLETE",
        "FAILED",
        "CANCEL_REQUESTED",
        "CANCELLED",
        "DEAD"
      ]
    },
    "started": {
      "format": "int64",
      "description": "A timestamp recording when the task was started.",
      "type": "integer"
    }
  },
  "type": "object",
  "description": "Details about a task.",
  "additionalProperties": false
}

PermissionScheme

{
  "type": "object",
  "additionalProperties": true,
  "description": "Details of a permission scheme.",
  "required": [
    "name"
  ],
  "properties": {
    "expand": {
      "readOnly": true,
      "description": "The expand options available for the permission scheme.",
      "type": "string"
    },
    "description": {
      "description": "A description for the permission scheme.",
      "type": "string"
    },
    "name": {
      "description": "The name of the permission scheme. Must be unique. Required when creating or updating a permission scheme.",
      "type": "string"
    },
    "scope": {
      "description": "The scope of the permission scheme.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ]
    },
    "permissions": {
      "description": "The permission scheme to create or update. See [About permission schemes and grants](#about-permission-schemes-and-grants) for more information.",
      "items": {
        "$ref": "#/components/schemas/PermissionGrant"
      },
      "type": "array"
    },
    "id": {
      "description": "The ID of the permission scheme.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "self": {
      "description": "The URL of the permission scheme.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  },
  "title": "PermissionScheme"
}

ApplicationRole

{
  "properties": {
    "platform": {
      "type": "boolean",
      "description": "Indicates if the application role belongs to Jira platform (`jira-core`)."
    },
    "selectedByDefault": {
      "description": "Determines whether this application role should be selected by default on user creation.",
      "type": "boolean"
    },
    "defaultGroups": {
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "description": "The groups that are granted default access for this application role.",
      "type": "array"
    },
    "numberOfSeats": {
      "type": "integer",
      "description": "The maximum count of users on your license.",
      "format": "int32"
    },
    "userCount": {
      "type": "integer",
      "format": "int32",
      "description": "The number of users counting against your license."
    },
    "groups": {
      "type": "array",
      "description": "The groups associated with the application role.",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "hasUnlimitedSeats": {
      "type": "boolean"
    },
    "userCountDescription": {
      "type": "string",
      "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license."
    },
    "name": {
      "type": "string",
      "description": "The display name of the application role."
    },
    "key": {
      "description": "The key of the application role.",
      "type": "string"
    },
    "defined": {
      "description": "Deprecated.",
      "type": "boolean"
    },
    "remainingSeats": {
      "type": "integer",
      "format": "int32",
      "description": "The count of users remaining on your license."
    }
  },
  "description": "Details of an application role.",
  "additionalProperties": false,
  "type": "object"
}

ProjectAvatars

{
  "type": "object",
  "description": "List of project avatars.",
  "additionalProperties": false,
  "properties": {
    "custom": {
      "type": "array",
      "description": "List of avatars added to Jira. These avatars may be deleted.",
      "items": {
        "$ref": "#/components/schemas/Avatar"
      },
      "readOnly": true
    },
    "system": {
      "type": "array",
      "description": "List of avatars included with Jira. These avatars cannot be deleted.",
      "items": {
        "$ref": "#/components/schemas/Avatar"
      },
      "readOnly": true
    }
  }
}

WorkflowId

{
  "required": [
    "draft",
    "name"
  ],
  "properties": {
    "draft": {
      "description": "Whether the workflow is in the draft state.",
      "type": "boolean"
    },
    "name": {
      "type": "string",
      "description": "The name of the workflow."
    }
  },
  "type": "object",
  "description": "Properties that identify a workflow.",
  "additionalProperties": false
}

WorkflowTransitionProperty

{
  "properties": {
    "key": {
      "readOnly": true,
      "description": "The key of the transition property. Also known as the name of the transition property.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the transition property.",
      "readOnly": true,
      "type": "string"
    },
    "value": {
      "type": "string",
      "description": "The value of the transition property."
    }
  },
  "required": [
    "value"
  ],
  "description": "Details about the server Jira is running on.",
  "additionalProperties": true,
  "type": "object",
  "title": "WorkflowTransitionProperty"
}

JqlQueryClause

{
  "description": "A JQL query clause.",
  "additionalProperties": false,
  "anyOf": [
    {
      "$ref": "#/components/schemas/CompoundClause"
    },
    {
      "$ref": "#/components/schemas/FieldValueClause"
    },
    {
      "$ref": "#/components/schemas/FieldWasClause"
    },
    {
      "$ref": "#/components/schemas/FieldChangedClause"
    }
  ],
  "type": "object"
}

Watchers

{
  "properties": {
    "watchers": {
      "type": "array",
      "description": "Details of the users watching this issue.",
      "items": {
        "$ref": "#/components/schemas/UserDetails"
      },
      "readOnly": true
    },
    "isWatching": {
      "readOnly": true,
      "description": "Indicates whether the calling user is watching this issue.",
      "type": "boolean"
    },
    "watchCount": {
      "description": "The number of users watching this issue.",
      "readOnly": true,
      "format": "int32",
      "type": "integer"
    },
    "self": {
      "type": "string",
      "description": "The URL of these issue watcher details.",
      "readOnly": true
    }
  },
  "type": "object",
  "xml": {
    "name": "watchers"
  },
  "description": "The details of watchers on an issue.",
  "additionalProperties": false
}

JqlQueryOrderByClauseElement

{
  "required": [
    "direction"
  ],
  "properties": {
    "direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "description": "The direction in which to order the results.",
      "type": "string"
    },
    "field": {
      "$ref": "#/components/schemas/JqlQueryField"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "An element of the order-by JQL clause."
}

JqlQueryFieldEntityProperty

{
  "description": "Details of an entity property.",
  "type": "object",
  "properties": {
    "key": {
      "description": "The key of the property.",
      "type": "string",
      "example": "stats"
    },
    "entity": {
      "description": "The object on which the property is set.",
      "type": "string",
      "example": "issue"
    },
    "type": {
      "description": "The type of the property value extraction. Not available if the extraction for the property is not registered on the instance with the [Entity property](https://developer.atlassian.com/cloud/jira/platform/modules/entity-property/) module.",
      "type": "string",
      "enum": [
        "number",
        "string",
        "text",
        "date",
        "user"
      ],
      "example": "number"
    },
    "path": {
      "description": "The path in the property value to query.",
      "type": "string",
      "example": "comments.count"
    }
  },
  "required": [
    "entity",
    "key",
    "path"
  ]
}

IssueFieldOptionScopeBean

{
  "properties": {
    "projects": {
      "type": "array",
      "description": "DEPRECATED",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "uniqueItems": true
    },
    "global": {
      "description": "Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects.",
      "allOf": [
        {
          "$ref": "#/components/schemas/GlobalScopeBean"
        }
      ]
    },
    "projects2": {
      "uniqueItems": true,
      "items": {
        "$ref": "#/components/schemas/ProjectScopeBean"
      },
      "description": "Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.",
      "type": "array"
    }
  },
  "additionalProperties": false,
  "type": "object"
}

SecuritySchemes

{
  "additionalProperties": false,
  "description": "List of security schemes.",
  "type": "object",
  "properties": {
    "issueSecuritySchemes": {
      "type": "array",
      "readOnly": true,
      "description": "List of security schemes.",
      "items": {
        "$ref": "#/components/schemas/SecurityScheme"
      }
    }
  }
}

PageBeanUserDetails

{
  "properties": {
    "values": {
      "type": "array",
      "readOnly": true,
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/UserDetails"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "The number of items returned."
    },
    "isLast": {
      "readOnly": true,
      "description": "Indicates whether this is the last page.",
      "type": "boolean"
    },
    "self": {
      "type": "string",
      "description": "The URL of the page.",
      "readOnly": true,
      "format": "uri"
    },
    "startAt": {
      "type": "integer",
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true
    },
    "maxResults": {
      "readOnly": true,
      "format": "int32",
      "description": "The maximum number of items that could be returned.",
      "type": "integer"
    },
    "nextPage": {
      "type": "string",
      "description": "If there is another page of results, the URL of the next page.",
      "readOnly": true,
      "format": "uri"
    }
  },
  "description": "A page of items.",
  "additionalProperties": false,
  "type": "object"
}

IssueTypeUpdateBean

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "The unique name for the issue type. The maximum length is 60 characters.",
      "type": "string"
    },
    "description": {
      "description": "The description of the issue type.",
      "type": "string"
    },
    "avatarId": {
      "type": "integer",
      "format": "int64",
      "description": "The ID of an issue type avatar."
    }
  },
  "title": "IssueTypeUpdateBean"
}

ErrorMessage

{
  "properties": {
    "message": {
      "description": "The error message.",
      "type": "string"
    }
  },
  "example": {
    "message": "The request is not from a Connect app."
  },
  "required": [
    "message"
  ],
  "additionalProperties": false,
  "type": "object"
}

SimpleApplicationPropertyBean

{
  "properties": {
    "id": {
      "description": "The ID of the application property.",
      "type": "string"
    },
    "value": {
      "description": "The new value.",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "xml": {
    "name": "applicationProperty"
  },
  "type": "object",
  "title": "SimpleApplicationPropertyBean"
}

WorkflowTransitionRulesUpdateErrors

{
  "type": "object",
  "description": "Details of any errors encountered while updating workflow transition rules.",
  "additionalProperties": false,
  "required": [
    "updateResults"
  ],
  "properties": {
    "updateResults": {
      "description": "A list of workflows.",
      "items": {
        "$ref": "#/components/schemas/WorkflowTransitionRulesUpdateErrorDetails"
      },
      "type": "array"
    }
  }
}

PropertyKey

{
  "properties": {
    "key": {
      "readOnly": true,
      "description": "The key of the property.",
      "type": "string"
    },
    "self": {
      "type": "string",
      "description": "The URL of the property.",
      "readOnly": true
    }
  },
  "description": "Property key details.",
  "additionalProperties": false,
  "type": "object"
}

IssueLink

{
  "properties": {
    "outwardIssue": {
      "description": "The issue the link originates from.",
      "allOf": [
        {
          "$ref": "#/components/schemas/LinkedIssue"
        }
      ]
    },
    "id": {
      "type": "string",
      "description": "The ID of the issue link.",
      "readOnly": true
    },
    "self": {
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the issue link.",
      "type": "string"
    },
    "inwardIssue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LinkedIssue"
        }
      ],
      "description": "The issue the link joins to."
    },
    "type": {
      "description": "The type of link between the issues.",
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueLinkType"
        }
      ]
    }
  },
  "type": "object",
  "xml": {
    "name": "issueLinks"
  },
  "description": "Details of a link between issues.",
  "additionalProperties": false
}

Configuration

{
  "additionalProperties": false,
  "description": "Details about the configuration of Jira.",
  "type": "object",
  "properties": {
    "votingEnabled": {
      "type": "boolean",
      "description": "Whether the ability for users to vote on issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.",
      "readOnly": true
    },
    "attachmentsEnabled": {
      "readOnly": true,
      "description": "Whether the ability to add attachments to issues is enabled.",
      "type": "boolean"
    },
    "subTasksEnabled": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether the ability to create subtasks for issues is enabled."
    },
    "timeTrackingConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeTrackingConfiguration"
        }
      ],
      "description": "The configuration of time tracking.",
      "readOnly": true
    },
    "watchingEnabled": {
      "type": "boolean",
      "description": "Whether the ability for users to watch issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.",
      "readOnly": true
    },
    "issueLinkingEnabled": {
      "type": "boolean",
      "description": "Whether the ability to link issues is enabled.",
      "readOnly": true
    },
    "unassignedIssuesAllowed": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether the ability to create unassigned issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details."
    },
    "timeTrackingEnabled": {
      "readOnly": true,
      "description": "Whether the ability to track time is enabled. This property is deprecated.",
      "type": "boolean"
    }
  }
}

GlobalScopeBean

{
  "properties": {
    "attributes": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "enum": [
          "notSelectable",
          "defaultValue"
        ],
        "type": "string"
      },
      "description": "Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default."
    }
  },
  "additionalProperties": false,
  "type": "object"
}

IssueCommentListRequestBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "ids": {
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "The list of comment IDs. A maximum of 1000 IDs can be specified. Required.",
      "uniqueItems": true,
      "type": "array"
    }
  },
  "title": "IssueCommentListRequestBean"
}

UserPermission

{
  "description": "Details of a permission and its availability to a user.",
  "additionalProperties": true,
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions."
    },
    "havePermission": {
      "type": "boolean",
      "description": "Indicates whether the permission is available to the user in the queried context."
    },
    "key": {
      "type": "string",
      "description": "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions."
    },
    "description": {
      "description": "The description of the permission.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The name of the permission."
    },
    "deprecatedKey": {
      "type": "boolean",
      "description": "Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.`"
    },
    "type": {
      "enum": [
        "GLOBAL",
        "PROJECT"
      ],
      "type": "string",
      "description": "The type of the permission."
    }
  }
}

Field

{
  "type": "object",
  "additionalProperties": false,
  "description": "Details of a field.",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "lastUsed": {
      "type": "string",
      "description": "The date when the value of the field last changed.",
      "format": "date-time"
    },
    "screens": {
      "items": {
        "$ref": "#/components/schemas/ScreenID"
      },
      "description": "List of screens where the field is used.",
      "type": "array"
    },
    "name": {
      "type": "string",
      "description": "The name of the field."
    },
    "key": {
      "description": "The key of the field.",
      "type": "string"
    },
    "description": {
      "description": "The description of the field.",
      "type": "string"
    },
    "id": {
      "description": "The id of the field.",
      "type": "string"
    },
    "schema": {
      "$ref": "#/components/schemas/JsonTypeBean"
    },
    "contexts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ContextID"
      },
      "description": "List of contexts where the field is used."
    }
  }
}

Filter

{
  "additionalProperties": false,
  "description": "Details about a filter.",
  "type": "object",
  "xml": {
    "name": "filter"
  },
  "properties": {
    "description": {
      "type": "string",
      "description": "A description of the filter."
    },
    "name": {
      "type": "string",
      "description": "The name of the filter. Must be unique."
    },
    "sharePermissions": {
      "items": {
        "$ref": "#/components/schemas/SharePermission"
      },
      "description": "The groups and projects that the filter is shared with.",
      "type": "array"
    },
    "favouritedCount": {
      "description": "The count of how many users have selected this filter as a favorite, including the filter owner.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "jql": {
      "type": "string",
      "description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*."
    },
    "id": {
      "type": "string",
      "description": "The unique identifier for the filter.",
      "readOnly": true
    },
    "owner": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "readOnly": true,
      "description": "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings."
    },
    "searchUrl": {
      "description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    },
    "viewUrl": {
      "description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "favourite": {
      "type": "boolean",
      "description": "Indicates whether the filter is selected as a favorite."
    },
    "subscriptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterSubscriptionsList"
        }
      ],
      "readOnly": true,
      "description": "A paginated list of the users that are subscribed to the filter."
    },
    "sharedUsers": {
      "description": "A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserList"
        }
      ]
    },
    "self": {
      "type": "string",
      "description": "The URL of the filter.",
      "format": "uri",
      "readOnly": true
    }
  },
  "required": [
    "name"
  ],
  "title": "Filter"
}

ConvertedJQLQueries

{
  "properties": {
    "queriesWithUnknownUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JQLQueryWithUnknownUsers"
      },
      "description": "List of queries containing user information that could not be mapped to an existing user"
    },
    "queryStrings": {
      "description": "The list of converted query strings with account IDs in place of user identifiers.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "description": "The converted JQL queries.",
  "additionalProperties": false,
  "type": "object"
}

ParsedJqlQueries

{
  "additionalProperties": false,
  "description": "A list of parsed JQL queries.",
  "type": "object",
  "properties": {
    "queries": {
      "minLength": 1,
      "items": {
        "$ref": "#/components/schemas/ParsedJqlQuery"
      },
      "description": "A list of parsed JQL queries.",
      "type": "array"
    }
  },
  "required": [
    "queries"
  ]
}

IssueMatchesForJQL

{
  "type": "object",
  "additionalProperties": false,
  "description": "A list of the issues matched to a JQL query or details of errors encountered during matching.",
  "required": [
    "errors",
    "matchedIssues"
  ],
  "properties": {
    "matchedIssues": {
      "description": "A list of issue IDs.",
      "items": {
        "description": "A list of issue IDs.",
        "format": "int64",
        "type": "integer"
      },
      "uniqueItems": true,
      "type": "array"
    },
    "errors": {
      "items": {
        "description": "A list of errors.",
        "type": "string"
      },
      "uniqueItems": true,
      "description": "A list of errors.",
      "type": "array"
    }
  }
}

CustomFieldDefinitionJsonBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "searcherKey": {
      "enum": [
        "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:daterange",
        "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange",
        "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber",
        "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:numberrange",
        "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"
      ],
      "description": "The searcher defines the way the field is searched in Jira. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher*.  \nThe search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):\n\n *  `cascadingselect`: `cascadingselectsearcher`\n *  `datepicker`: `daterange`\n *  `datetime`: `datetimerange`\n *  `float`: `exactnumber` or `numberrange`\n *  `grouppicker`: `grouppickersearcher`\n *  `importid`: `exactnumber` or `numberrange`\n *  `labels`: `labelsearcher`\n *  `multicheckboxes`: `multiselectsearcher`\n *  `multigrouppicker`: `multiselectsearcher`\n *  `multiselect`: `multiselectsearcher`\n *  `multiuserpicker`: `userpickergroupsearcher`\n *  `multiversion`: `versionsearcher`\n *  `project`: `projectsearcher`\n *  `radiobuttons`: `multiselectsearcher`\n *  `readonlyfield`: `textsearcher`\n *  `select`: `multiselectsearcher`\n *  `textarea`: `textsearcher`\n *  `textfield`: `textsearcher`\n *  `url`: `exacttextsearcher`\n *  `userpicker`: `userpickergroupsearcher`\n *  `version`: `versionsearcher`",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The name of the custom field, which is displayed in Jira. This is not the unique identifier."
    },
    "description": {
      "description": "The description of the custom field, which is displayed in Jira.",
      "type": "string"
    },
    "type": {
      "description": "The type of the custom field. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppicker*.\n\n *  `cascadingselect`: Allows multiple values to be selected using two select lists\n *  `datepicker`: Stores a date using a picker control\n *  `datetime`: Stores a date with a time component\n *  `float`: Stores and validates a numeric (floating point) input\n *  `grouppicker`: Stores a user group using a picker control\n *  `importid`: A read-only field that stores the previous ID of the issue from the system that it was imported from\n *  `labels`: Stores labels\n *  `multicheckboxes`: Stores multiple values using checkboxes\n *  `multigrouppicker`: Stores multiple user groups using a picker control\n *  `multiselect`: Stores multiple values using a select list\n *  `multiuserpicker`: Stores multiple users using a picker control\n *  `multiversion`: Stores multiple versions from the versions available in a project using a picker control\n *  `project`: Stores a project from a list of projects that the user is permitted to view\n *  `radiobuttons`: Stores a value using radio buttons\n *  `readonlyfield`: Stores a read-only text value, which can only be populated via the API\n *  `select`: Stores a value from a configurable list of options\n *  `textarea`: Stores a long text string using a multiline text area\n *  `textfield`: Stores a text string using a single-line text box\n *  `url`: Stores a URL\n *  `userpicker`: Stores a user using a picker control\n *  `version`: Stores a version using a picker control",
      "type": "string",
      "enum": [
        "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect",
        "com.atlassian.jira.plugin.system.customfieldtypes:datepicker",
        "com.atlassian.jira.plugin.system.customfieldtypes:datetime",
        "com.atlassian.jira.plugin.system.customfieldtypes:float",
        "com.atlassian.jira.plugin.system.customfieldtypes:grouppicker",
        "com.atlassian.jira.plugin.system.customfieldtypes:importid",
        "com.atlassian.jira.plugin.system.customfieldtypes:labels",
        "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes",
        "com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker",
        "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
        "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker",
        "com.atlassian.jira.plugin.system.customfieldtypes:multiversion",
        "com.atlassian.jira.plugin.system.customfieldtypes:project",
        "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons",
        "com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield",
        "com.atlassian.jira.plugin.system.customfieldtypes:select",
        "com.atlassian.jira.plugin.system.customfieldtypes:textarea",
        "com.atlassian.jira.plugin.system.customfieldtypes:textfield",
        "com.atlassian.jira.plugin.system.customfieldtypes:url",
        "com.atlassian.jira.plugin.system.customfieldtypes:userpicker",
        "com.atlassian.jira.plugin.system.customfieldtypes:version"
      ]
    }
  },
  "required": [
    "name",
    "searcherKey",
    "type"
  ],
  "title": "CustomFieldDefinitionJsonBean"
}

HistoryMetadata

{
  "properties": {
    "extraData": {
      "description": "Additional arbitrary information about the history record.",
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "actor": {
      "description": "Details of the user whose action created the history record.",
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ]
    },
    "generator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ],
      "description": "Details of the system that generated the history record."
    },
    "activityDescriptionKey": {
      "description": "The key of the activity described in the history record.",
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "The type of the history record."
    },
    "cause": {
      "description": "Details of the cause that triggered the creation the history record.",
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ]
    },
    "description": {
      "type": "string",
      "description": "The description of the history record."
    },
    "descriptionKey": {
      "description": "The description key of the history record.",
      "type": "string"
    },
    "activityDescription": {
      "type": "string",
      "description": "The activity described in the history record."
    },
    "emailDescriptionKey": {
      "description": "The description key of the email address associated the history record.",
      "type": "string"
    },
    "emailDescription": {
      "type": "string",
      "description": "The description of the email address associated the history record."
    }
  },
  "type": "object",
  "additionalProperties": true,
  "description": "Details of issue history metadata."
}

IssueFieldOptionConfiguration

{
  "type": "object",
  "description": "Details of the projects the option is available in.",
  "additionalProperties": false,
  "properties": {
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueFieldOptionScopeBean"
        }
      ],
      "description": "Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects."
    },
    "attributes": {
      "description": "DEPRECATED",
      "items": {
        "enum": [
          "notSelectable",
          "defaultValue"
        ],
        "type": "string"
      },
      "uniqueItems": true,
      "type": "array"
    }
  }
}

ChangedWorklogs

{
  "properties": {
    "lastPage": {
      "type": "boolean"
    },
    "nextPage": {
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the next list of changed worklogs.",
      "type": "string"
    },
    "since": {
      "description": "The datetime of the first worklog item in the list.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "values": {
      "description": "Changed worklog list.",
      "items": {
        "$ref": "#/components/schemas/ChangedWorklog"
      },
      "readOnly": true,
      "type": "array"
    },
    "until": {
      "format": "int64",
      "readOnly": true,
      "description": "The datetime of the last worklog item in the list.",
      "type": "integer"
    },
    "self": {
      "description": "The URL of this changed worklogs list.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "description": "List of changed worklogs.",
  "type": "object"
}

Visibility

{
  "properties": {
    "type": {
      "description": "Indicates whether visibility of this item is restricted to a group or role.",
      "type": "string",
      "enum": [
        "group",
        "role"
      ]
    },
    "value": {
      "type": "string",
      "description": "The name of the group or role to which visibility of this item is restricted."
    }
  },
  "additionalProperties": true,
  "description": "The group or role to which this item is visible.",
  "type": "object"
}

VersionIssueCounts

{
  "properties": {
    "issuesAffectedCount": {
      "description": "Count of issues where the `affectedVersion` is set to the version.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "customFieldUsage": {
      "description": "List of custom fields using the version.",
      "items": {
        "$ref": "#/components/schemas/VersionUsageInCustomField"
      },
      "readOnly": true,
      "type": "array"
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "format": "uri",
      "description": "The URL of these count details."
    },
    "issuesFixedCount": {
      "type": "integer",
      "description": "Count of issues where the `fixVersion` is set to the version.",
      "format": "int64",
      "readOnly": true
    },
    "issueCountWithCustomFieldsShowingVersion": {
      "description": "Count of issues where a version custom field is set to the version.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object",
  "xml": {
    "name": "version"
  },
  "additionalProperties": false,
  "description": "Various counts of issues within a version."
}

Resolution

{
  "properties": {
    "description": {
      "description": "The description of the issue resolution.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The name of the issue resolution."
    },
    "self": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the issue resolution."
    },
    "id": {
      "description": "The ID of the issue resolution.",
      "type": "string"
    }
  },
  "xml": {
    "name": "resolution"
  },
  "type": "object",
  "description": "Details of an issue resolution.",
  "additionalProperties": false
}

SecurityLevel

{
  "additionalProperties": false,
  "description": "Details of an issue level security item.",
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "The description of the issue level security item."
    },
    "name": {
      "readOnly": true,
      "description": "The name of the issue level security item.",
      "type": "string"
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "description": "The URL of the issue level security item."
    },
    "id": {
      "description": "The ID of the issue level security item.",
      "readOnly": true,
      "type": "string"
    }
  }
}

ConnectModule

{
  "example": {
    "type": "single_select",
    "name": {
      "value": "Team"
    },
    "key": "team-field",
    "description": {
      "value": "field with team"
    },
    "extractions": [
      {
        "type": "text",
        "path": "category",
        "name": "categoryName"
      }
    ]
  },
  "type": "object",
  "description": "A [Connect module](https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/) in the same format as in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/)."
}

Hierarchy

{
  "properties": {
    "level": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/HierarchyLevel"
      }
    }
  },
  "additionalProperties": false,
  "description": "Project Issue Type Hierarchy",
  "xml": {
    "name": "hierarchy"
  },
  "type": "object"
}

PageBeanDashboard

{
  "description": "A page of items.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "startAt": {
      "format": "int64",
      "readOnly": true,
      "description": "The index of the first item returned.",
      "type": "integer"
    },
    "maxResults": {
      "readOnly": true,
      "format": "int32",
      "description": "The maximum number of items that could be returned.",
      "type": "integer"
    },
    "nextPage": {
      "format": "uri",
      "readOnly": true,
      "description": "If there is another page of results, the URL of the next page.",
      "type": "string"
    },
    "values": {
      "type": "array",
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/Dashboard"
      },
      "readOnly": true
    },
    "total": {
      "description": "The number of items returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "isLast": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether this is the last page."
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the page."
    }
  }
}

FieldDeprecated

{
  "description": "Details about a field. This object has been deprecated. See [Get Fields Paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-field-search-get) to obtain details about fields.",
  "additionalProperties": false,
  "xml": {
    "name": "field"
  },
  "type": "object",
  "properties": {
    "clauseNames": {
      "items": {
        "type": "string"
      },
      "description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).",
      "uniqueItems": true,
      "type": "array"
    },
    "key": {
      "type": "string",
      "description": "The key of the field."
    },
    "name": {
      "type": "string",
      "description": "The name of the field."
    },
    "scope": {
      "description": "The scope of the field.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ]
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JsonTypeBean"
        }
      ],
      "description": "The data schema for the field."
    },
    "orderable": {
      "type": "boolean",
      "description": "Indicates whether the content of the field can be used to order lists."
    },
    "id": {
      "description": "The ID of the field.",
      "type": "string"
    },
    "searchable": {
      "description": "Indicates whether the content of the field can be searched.",
      "type": "boolean"
    },
    "navigable": {
      "description": "Indicates whether the field can be used as a column on the issue navigator.",
      "type": "boolean"
    },
    "custom": {
      "type": "boolean",
      "description": "Indicates whether the field is a custom field."
    }
  }
}

RestrictedPermission

{
  "properties": {
    "id": {
      "description": "The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.",
      "type": "string"
    },
    "key": {
      "type": "string",
      "description": "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions."
    }
  },
  "description": "Details of the permission.",
  "additionalProperties": true,
  "type": "object"
}

Priority

{
  "properties": {
    "description": {
      "description": "The description of the issue priority.",
      "type": "string"
    },
    "name": {
      "description": "The name of the issue priority.",
      "type": "string"
    },
    "iconUrl": {
      "description": "The URL of the icon for the issue priority.",
      "type": "string"
    },
    "self": {
      "description": "The URL of the issue priority.",
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "The ID of the issue priority."
    },
    "statusColor": {
      "description": "The color used to indicate the issue priority.",
      "type": "string"
    }
  },
  "description": "An issue priority.",
  "additionalProperties": true,
  "type": "object"
}

ColumnItem

{
  "properties": {
    "value": {
      "type": "string",
      "description": "The issue navigator column value."
    },
    "label": {
      "type": "string",
      "description": "The issue navigator column label."
    }
  },
  "description": "Details of an issue navigator column item.",
  "additionalProperties": false,
  "type": "object"
}

ComponentIssuesCount

{
  "xml": {
    "name": "component"
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Count of issues assigned to a component.",
  "properties": {
    "self": {
      "type": "string",
      "description": "The URL for this count of issues for a component.",
      "readOnly": true,
      "format": "uri"
    },
    "issueCount": {
      "type": "integer",
      "description": "The count of issues assigned to a component.",
      "readOnly": true,
      "format": "int64"
    }
  }
}

TaskProgressBeanObject

{
  "description": "Details about a task.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "progress": {
      "description": "The progress of the task, as a percentage complete.",
      "format": "int64",
      "type": "integer"
    },
    "description": {
      "description": "The description of the task.",
      "type": "string"
    },
    "lastUpdate": {
      "type": "integer",
      "description": "A timestamp recording when the task progress was last updated.",
      "format": "int64"
    },
    "id": {
      "type": "string",
      "description": "The ID of the task."
    },
    "submitted": {
      "type": "integer",
      "format": "int64",
      "description": "A timestamp recording when the task was submitted."
    },
    "finished": {
      "format": "int64",
      "description": "A timestamp recording when the task was finished.",
      "type": "integer"
    },
    "result": {
      "description": "The result of the task execution."
    },
    "message": {
      "description": "Information about the progress of the task.",
      "type": "string"
    },
    "submittedBy": {
      "type": "integer",
      "format": "int64",
      "description": "The ID of the user who submitted the task."
    },
    "elapsedRuntime": {
      "type": "integer",
      "format": "int64",
      "description": "The execution time of the task, in milliseconds."
    },
    "self": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the task."
    },
    "status": {
      "description": "The status of the task.",
      "type": "string",
      "enum": [
        "ENQUEUED",
        "RUNNING",
        "COMPLETE",
        "FAILED",
        "CANCEL_REQUESTED",
        "CANCELLED",
        "DEAD"
      ]
    },
    "started": {
      "type": "integer",
      "format": "int64",
      "description": "A timestamp recording when the task was started."
    }
  },
  "required": [
    "elapsedRuntime",
    "id",
    "lastUpdate",
    "progress",
    "self",
    "status",
    "submitted",
    "submittedBy"
  ]
}

IssueTypeWorkflowMapping

{
  "properties": {
    "workflow": {
      "type": "string",
      "description": "The name of the workflow."
    },
    "updateDraftIfNeeded": {
      "type": "boolean",
      "description": "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. Only applicable when updating the workflow-issue types mapping."
    },
    "issueType": {
      "type": "string",
      "description": "The ID of the issue type. Not required if updating the issue type-workflow mapping."
    }
  },
  "additionalProperties": false,
  "description": "Details about the mapping between an issue type and a workflow.",
  "type": "object",
  "title": "IssueTypeWorkflowMapping"
}

AssociatedItemBean

{
  "type": "object",
  "additionalProperties": false,
  "description": "Details of an item associated with the changed record.",
  "properties": {
    "parentName": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the associated parent record."
    },
    "name": {
      "description": "The name of the associated record.",
      "readOnly": true,
      "type": "string"
    },
    "parentId": {
      "type": "string",
      "description": "The ID of the associated parent record.",
      "readOnly": true
    },
    "typeName": {
      "type": "string",
      "readOnly": true,
      "description": "The type of the associated record."
    },
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "The ID of the associated record."
    }
  }
}

JqlQueriesToParse

{
  "description": "A list of JQL queries to parse.",
  "additionalProperties": false,
  "type": "object",
  "writeOnly": true,
  "properties": {
    "queries": {
      "items": {
        "minLength": 1,
        "type": "string"
      },
      "description": "A list of queries to parse.",
      "type": "array",
      "minLength": 1
    }
  },
  "required": [
    "queries"
  ],
  "title": "JqlQueriesToParse"
}

Locale

{
  "properties": {
    "locale": {
      "type": "string",
      "description": "The locale code. The Java the locale format is used: a two character language code (ISO 639), an underscore, and two letter country code (ISO 3166). For example, en\\_US represents a locale of English (United States). Required on create."
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details of a locale.",
  "title": "Locale"
}

MoveFieldBean

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "position": {
      "enum": [
        "Earlier",
        "Later",
        "First",
        "Last"
      ],
      "description": "The named position to which the screen tab field should be moved. Required if `after` isn't provided.",
      "type": "string"
    },
    "after": {
      "description": "The ID of the screen tab field after which to place the moved screen tab field. Required if `position` isn't provided.",
      "format": "uri",
      "type": "string"
    }
  },
  "title": "MoveFieldBean"
}

IssueTypeWithStatus

{
  "type": "object",
  "description": "Status details for an issue type.",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "self",
    "statuses",
    "subtask"
  ],
  "properties": {
    "statuses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StatusDetails"
      },
      "description": "List of status details for the issue type.",
      "readOnly": true
    },
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "The ID of the issue type."
    },
    "self": {
      "type": "string",
      "description": "The URL of the issue type's status details.",
      "readOnly": true
    },
    "subtask": {
      "description": "Indicates whether this issue type represents subtasks.",
      "readOnly": true,
      "type": "boolean"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the issue type."
    }
  }
}

JQLQueryWithUnknownUsers

{
  "properties": {
    "convertedQuery": {
      "description": "The converted query, with accountIDs instead of user identifiers, or 'unknown' for users that could not be found",
      "type": "string"
    },
    "originalQuery": {
      "type": "string",
      "description": "The original query, for reference"
    }
  },
  "description": "JQL queries that contained users that could not be found",
  "additionalProperties": false,
  "type": "object"
}

AttachmentMetadata

{
  "type": "object",
  "xml": {
    "name": "attachment"
  },
  "additionalProperties": false,
  "description": "Metadata for an issue attachment.",
  "properties": {
    "size": {
      "description": "The size of the attachment.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "properties": {
      "description": "Additional properties of the attachment.",
      "additionalProperties": {
        "readOnly": true
      },
      "readOnly": true,
      "type": "object"
    },
    "id": {
      "description": "The ID of the attachment.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "mimeType": {
      "type": "string",
      "readOnly": true,
      "description": "The MIME type of the attachment."
    },
    "content": {
      "type": "string",
      "description": "The URL of the attachment.",
      "readOnly": true
    },
    "filename": {
      "description": "The name of the attachment file.",
      "readOnly": true,
      "type": "string"
    },
    "author": {
      "description": "Details of the user who attached the file.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ]
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The datetime the attachment was created."
    },
    "thumbnail": {
      "description": "The URL of a thumbnail representing the attachment.",
      "readOnly": true,
      "type": "string"
    },
    "self": {
      "description": "The URL of the attachment metadata details.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  }
}

ErrorCollection

{
  "properties": {
    "errorMessages": {
      "items": {
        "type": "string"
      },
      "description": "The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\"",
      "type": "array"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\""
    },
    "status": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object",
  "description": "Error messages from an operation.",
  "additionalProperties": false
}

Permissions

{
  "type": "object",
  "description": "Details about permissions.",
  "additionalProperties": false,
  "properties": {
    "permissions": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "$ref": "#/components/schemas/UserPermission"
      },
      "description": "List of permissions."
    }
  }
}

RoleActor

{
  "additionalProperties": false,
  "description": "Details about a user assigned to a project role.",
  "type": "object",
  "xml": {
    "name": "projectRoleActor"
  },
  "properties": {
    "user": {
      "type": "string"
    },
    "actorUser": {
      "$ref": "#/components/schemas/ProjectRoleUserBean"
    },
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "actorGroup": {
      "$ref": "#/components/schemas/ProjectRoleGroupBean"
    },
    "type": {
      "type": "string"
    },
    "avatarUrl": {
      "format": "uri",
      "type": "string"
    },
    "displayName": {
      "type": "string",
      "readOnly": true,
      "description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value."
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
    }
  }
}

TimeTrackingProvider

{
  "required": [
    "key"
  ],
  "properties": {
    "key": {
      "description": "The key for the time tracking provider. For example, *JIRA*.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The name of the time tracking provider. For example, *JIRA provided time tracking*."
    },
    "url": {
      "type": "string",
      "description": "The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app.",
      "readOnly": true
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details about the time tracking provider.",
  "title": "TimeTrackingProvider"
}

FoundGroups

{
  "properties": {
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FoundGroup"
      }
    },
    "total": {
      "format": "int32",
      "description": "The total number of groups found in the search.",
      "type": "integer"
    },
    "header": {
      "description": "Header text indicating the number of groups in the response and the total number of groups found in the search.",
      "type": "string"
    }
  },
  "description": "The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.",
  "additionalProperties": false,
  "xml": {
    "name": "groupsuggestions"
  },
  "type": "object"
}

Transitions

{
  "properties": {
    "expand": {
      "xml": {
        "attribute": true
      },
      "type": "string",
      "description": "Expand options that include additional transitions details in the response.",
      "readOnly": true
    },
    "transitions": {
      "items": {
        "$ref": "#/components/schemas/IssueTransition"
      },
      "description": "List of issue transitions.",
      "readOnly": true,
      "type": "array"
    }
  },
  "additionalProperties": false,
  "description": "List of issue transitions.",
  "type": "object"
}

NotificationRecipients

{
  "properties": {
    "assignee": {
      "description": "Indicates whether the notification should be sent to the issue's assignees.",
      "type": "boolean"
    },
    "groups": {
      "description": "List of groups to receive the notification.",
      "items": {
        "$ref": "#/components/schemas/GroupName"
      },
      "type": "array"
    },
    "watchers": {
      "type": "boolean",
      "description": "Indicates whether the notification should be sent to the issue's watchers."
    },
    "voters": {
      "description": "Indicates whether the notification should be sent to the issue's voters.",
      "type": "boolean"
    },
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserDetails"
      },
      "description": "List of users to receive the notification."
    },
    "reporter": {
      "description": "Indicates whether the notification should be sent to the issue's reporter.",
      "type": "boolean"
    }
  },
  "type": "object",
  "additionalProperties": true,
  "description": "Details of the users and groups to receive the notification."
}

IssuesUpdateBean

{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "issueUpdates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IssueUpdateDetails"
      }
    }
  },
  "title": "IssuesUpdateBean"
}

IssueFilterForBulkPropertySet

{
  "type": "object",
  "description": "Bulk operation filter details.",
  "additionalProperties": false,
  "properties": {
    "hasProperty": {
      "description": "Indicates whether the bulk operation occurs only when the property is present on or absent from an issue.",
      "type": "boolean"
    },
    "currentValue": {
      "description": "The value of properties to perform the bulk operation on."
    },
    "entityIds": {
      "type": "array",
      "description": "List of issues to perform the bulk operation on.",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "uniqueItems": true
    }
  }
}

PermissionGrants

{
  "properties": {
    "expand": {
      "type": "string",
      "readOnly": true,
      "description": "Expand options that include additional permission grant details in the response."
    },
    "permissions": {
      "items": {
        "$ref": "#/components/schemas/PermissionGrant"
      },
      "description": "Permission grants list.",
      "readOnly": true,
      "type": "array"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "List of permission grants."
}

ProjectRoleUserBean

{
  "properties": {
    "accountId": {
      "type": "string",
      "description": "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
      "readOnly": true
    }
  },
  "type": "object",
  "additionalProperties": false
}

Scope

{
  "description": "The scope of an entity. Indicated for entities associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
  "additionalProperties": true,
  "type": "object",
  "properties": {
    "project": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectForScope"
        }
      ],
      "readOnly": true,
      "description": "The project the entity has scope in."
    },
    "type": {
      "description": "The type of scope.",
      "readOnly": true,
      "type": "string",
      "enum": [
        "PROJECT",
        "TEMPLATE"
      ]
    }
  }
}

SuggestedIssue

{
  "additionalProperties": false,
  "description": "An issue suggested for use in the issue picker auto-completion.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The id of the issue."
    },
    "img": {
      "description": "The URL of the issue type's avatar.",
      "readOnly": true,
      "type": "string"
    },
    "summary": {
      "type": "string",
      "readOnly": true,
      "description": "The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags."
    },
    "summaryText": {
      "type": "string",
      "readOnly": true,
      "description": "The phrase containing the query string, as plain text."
    },
    "key": {
      "type": "string",
      "description": "The key of the issue.",
      "readOnly": true
    },
    "keyHtml": {
      "readOnly": true,
      "description": "The key of the issue in HTML format.",
      "type": "string"
    }
  }
}

GroupLabel

{
  "properties": {
    "type": {
      "enum": [
        "ADMIN",
        "SINGLE",
        "MULTIPLE"
      ],
      "description": "The type of the group label.",
      "type": "string"
    },
    "title": {
      "type": "string",
      "description": "The title of the group label."
    },
    "text": {
      "description": "The group label name.",
      "type": "string"
    }
  },
  "type": "object",
  "xml": {
    "name": "grouplabel"
  },
  "additionalProperties": false,
  "description": "A group label."
}

UpdateUserToGroupBean

{
  "additionalProperties": true,
  "type": "object",
  "properties": {
    "name": {
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "type": "string"
    },
    "accountId": {
      "type": "string",
      "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
    }
  },
  "title": "UpdateUserToGroupBean"
}

ScreenID

{
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the screen."
    }
  },
  "required": [
    "id"
  ],
  "description": "ID of a screen.",
  "additionalProperties": false,
  "type": "object"
}

IssueFieldOption

{
  "required": [
    "id",
    "value"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique identifier for the option. This is only unique within the select field's set of options.",
      "format": "int64"
    },
    "config": {
      "$ref": "#/components/schemas/IssueFieldOptionConfiguration"
    },
    "properties": {
      "description": "The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see [Issue Field Option Property Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module.",
      "additionalProperties": {},
      "type": "object"
    },
    "value": {
      "description": "The option's name, which is displayed in Jira.",
      "type": "string"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details of the options for a select list issue field.",
  "title": "IssueFieldOption"
}

JiraExpressionResult

{
  "type": "object",
  "additionalProperties": false,
  "description": "The result of evaluating a Jira expression.",
  "required": [
    "value"
  ],
  "properties": {
    "value": {
      "description": "The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some expressions do not produce any meaningful results—for example, an expression that returns a lambda function—if that's the case a simple string representation is returned. These string representations should not be relied upon and may change without notice.)"
    },
    "meta": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JiraExpressionEvaluationMetaDataBean"
        }
      ],
      "description": "Contains various characteristics of the performed expression evaluation."
    }
  }
}

IssueTypeCreateBean

{
  "properties": {
    "name": {
      "description": "The unique name for the issue type. The maximum length is 60 characters. Required.",
      "type": "string"
    },
    "description": {
      "type": "string",
      "description": "The description of the issue type."
    },
    "type": {
      "enum": [
        "subtask",
        "standard"
      ],
      "description": "Whether the issue type is `subtype` or `standard`. Defaults to `standard`.",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "type": "object",
  "title": "IssueTypeCreateBean"
}

NotificationSchemeEvent

{
  "description": "Details about a notification scheme event.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "notifications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EventNotification"
      }
    },
    "event": {
      "$ref": "#/components/schemas/NotificationEvent"
    }
  }
}

PageBeanVersion

{
  "type": "object",
  "additionalProperties": false,
  "description": "A page of items.",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "The number of items returned."
    },
    "isLast": {
      "description": "Indicates whether this is the last page.",
      "readOnly": true,
      "type": "boolean"
    },
    "self": {
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the page.",
      "type": "string"
    },
    "values": {
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/Version"
      },
      "readOnly": true,
      "type": "array"
    },
    "maxResults": {
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "description": "The maximum number of items that could be returned."
    },
    "nextPage": {
      "description": "If there is another page of results, the URL of the next page.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "startAt": {
      "readOnly": true,
      "format": "int64",
      "description": "The index of the first item returned.",
      "type": "integer"
    }
  }
}

LinkGroup

{
  "properties": {
    "groups": {
      "items": {
        "$ref": "#/components/schemas/LinkGroup"
      },
      "type": "array"
    },
    "weight": {
      "format": "int32",
      "type": "integer"
    },
    "links": {
      "items": {
        "$ref": "#/components/schemas/SimpleLink"
      },
      "type": "array"
    },
    "header": {
      "$ref": "#/components/schemas/SimpleLink"
    },
    "id": {
      "type": "string"
    },
    "styleClass": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "description": "Details a link group, which defines issue operations.",
  "type": "object"
}

JexpIssues

{
  "properties": {
    "jql": {
      "description": "The JQL query that specifies the set of issues available in the Jira expression.",
      "allOf": [
        {
          "$ref": "#/components/schemas/JexpJqlIssues"
        }
      ]
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable."
}

PermissionHolder

{
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of permission holder."
    },
    "expand": {
      "type": "string",
      "readOnly": true,
      "description": "Expand options that include additional permission holder details in the response."
    },
    "parameter": {
      "description": "The identifier of permission holder.",
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "description": "Details of a user, group, field, or project role that holds a permission. See [Holder object](#holder-object) in *Get all permission schemes* for more information.",
  "additionalProperties": false,
  "type": "object"
}

ContextID

{
  "type": "object",
  "additionalProperties": false,
  "description": "ID of a context.",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the context."
    }
  }
}

IconBean

{
  "properties": {
    "link": {
      "description": "The URL of the tooltip, used only for a status icon.",
      "type": "string"
    },
    "url16x16": {
      "description": "The URL of a 16x16 pixel icon.",
      "type": "string"
    },
    "title": {
      "type": "string",
      "description": "The title of the icon, for use as a tooltip on the icon."
    }
  },
  "type": "object",
  "xml": {
    "name": "icon"
  },
  "additionalProperties": false,
  "description": "An icon."
}

FilterSubscriptionsList

{
  "additionalProperties": false,
  "description": "A paginated list of subscriptions to a filter.",
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "xml": {
        "attribute": true
      },
      "format": "int32",
      "readOnly": true,
      "description": "The number of items on the page."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FilterSubscription"
      },
      "description": "The list of items.",
      "readOnly": true
    },
    "end-index": {
      "description": "The index of the last item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "xml": {
        "name": "end-index",
        "attribute": true
      },
      "type": "integer"
    },
    "max-results": {
      "xml": {
        "attribute": true,
        "name": "max-results"
      },
      "type": "integer",
      "description": "The maximum number of results that could be on the page.",
      "readOnly": true,
      "format": "int32"
    },
    "start-index": {
      "format": "int32",
      "readOnly": true,
      "description": "The index of the first item returned on the page.",
      "type": "integer",
      "xml": {
        "name": "start-index",
        "attribute": true
      }
    }
  }
}

Version

{
  "description": "Details about a project version.",
  "additionalProperties": false,
  "type": "object",
  "xml": {
    "name": "version"
  },
  "properties": {
    "userStartDate": {
      "readOnly": true,
      "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.",
      "type": "string"
    },
    "self": {
      "description": "The URL of the version.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    },
    "operations": {
      "description": "If the expand option `operations` is used, returns the list of operations available for this version.",
      "items": {
        "$ref": "#/components/schemas/SimpleLink"
      },
      "readOnly": true,
      "type": "array"
    },
    "startDate": {
      "format": "date",
      "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters."
    },
    "expand": {
      "xml": {
        "attribute": true
      },
      "type": "string",
      "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts multiple values separated by a comma:\n\n *  `operations` Returns the list of operations available for this version.\n *  `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update."
    },
    "projectId": {
      "type": "integer",
      "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.",
      "format": "int64"
    },
    "userReleaseDate": {
      "type": "string",
      "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.",
      "readOnly": true
    },
    "project": {
      "type": "string",
      "description": "Deprecated. Use `projectId`."
    },
    "issuesStatusForFixVersion": {
      "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/VersionIssuesStatus"
        }
      ]
    },
    "moveUnfixedIssuesTo": {
      "format": "uri",
      "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.",
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "The ID of the version.",
      "readOnly": true
    },
    "released": {
      "type": "boolean",
      "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version."
    },
    "overdue": {
      "type": "boolean",
      "description": "Indicates that the version is overdue.",
      "readOnly": true
    },
    "releaseDate": {
      "type": "string",
      "format": "date",
      "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version."
    },
    "description": {
      "description": "The description of the version. Optional when creating or updating a version.",
      "type": "string"
    },
    "archived": {
      "description": "Indicates that the version is archived. Optional when creating or updating a version.",
      "type": "boolean"
    }
  },
  "title": "Version"
}

NestedResponse

{
  "properties": {
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "errorCollection": {
      "$ref": "#/components/schemas/ErrorCollection"
    }
  },
  "type": "object",
  "additionalProperties": false
}

PageBeanComment

{
  "properties": {
    "total": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "The number of items returned."
    },
    "isLast": {
      "description": "Indicates whether this is the last page.",
      "readOnly": true,
      "type": "boolean"
    },
    "self": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the page."
    },
    "values": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/Comment"
      },
      "description": "The list of items."
    },
    "nextPage": {
      "format": "uri",
      "readOnly": true,
      "description": "If there is another page of results, the URL of the next page.",
      "type": "string"
    },
    "maxResults": {
      "type": "integer",
      "description": "The maximum number of items that could be returned.",
      "readOnly": true,
      "format": "int32"
    },
    "startAt": {
      "type": "integer",
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A page of items."
}

IdOrKeyBean

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "key": {
      "description": "The key of the referenced item.",
      "type": "string"
    },
    "id": {
      "format": "int64",
      "description": "The ID of the referenced item.",
      "type": "integer"
    }
  }
}

IssueUpdateMetadata

{
  "type": "object",
  "description": "A list of editable field details.",
  "properties": {
    "fields": {
      "additionalProperties": {
        "$ref": "#/components/schemas/FieldMetadata"
      },
      "description": "A list of editable field details.",
      "readOnly": true,
      "type": "object"
    }
  }
}

ProjectRole

{
  "properties": {
    "actors": {
      "type": "array",
      "description": "The list of users who act in this role.",
      "items": {
        "$ref": "#/components/schemas/RoleActor"
      },
      "readOnly": true
    },
    "self": {
      "readOnly": true,
      "format": "uri",
      "description": "The URL the project role details.",
      "type": "string"
    },
    "default": {
      "type": "boolean"
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "The description of the project role."
    },
    "admin": {
      "type": "boolean"
    },
    "name": {
      "description": "The name of the project role.",
      "type": "string"
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
      "readOnly": true
    },
    "id": {
      "description": "The ID of the project role.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "description": "Details about the roles in a project.",
  "type": "object"
}

PageBeanScreen

{
  "properties": {
    "maxResults": {
      "format": "int32",
      "readOnly": true,
      "description": "The maximum number of items that could be returned.",
      "type": "integer"
    },
    "nextPage": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "If there is another page of results, the URL of the next page."
    },
    "startAt": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The index of the first item returned."
    },
    "isLast": {
      "type": "boolean",
      "description": "Indicates whether this is the last page.",
      "readOnly": true
    },
    "self": {
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the page.",
      "type": "string"
    },
    "total": {
      "type": "integer",
      "description": "The number of items returned.",
      "format": "int64",
      "readOnly": true
    },
    "values": {
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/Screen"
      },
      "readOnly": true,
      "type": "array"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A page of items."
}

IssuePickerSuggestions

{
  "additionalProperties": false,
  "description": "A list of issues suggested for use in auto-completion.",
  "type": "object",
  "properties": {
    "sections": {
      "items": {
        "$ref": "#/components/schemas/IssuePickerSuggestionsIssueType"
      },
      "description": "A list of issues for an issue type suggested for use in auto-completion.",
      "readOnly": true,
      "type": "array"
    }
  }
}

NotificationRecipientsRestrictions

{
  "properties": {
    "permissions": {
      "items": {
        "$ref": "#/components/schemas/RestrictedPermission"
      },
      "description": "List of permissions required to receive the notification.",
      "type": "array"
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupName"
      },
      "description": "List of group memberships required to receive the notification."
    }
  },
  "additionalProperties": false,
  "description": "Details of the group membership or permissions needed to receive the notification.",
  "type": "object"
}

BulkPermissionGrants

{
  "type": "object",
  "description": "Details of global and project permissions granted to the user.",
  "additionalProperties": false,
  "required": [
    "globalPermissions",
    "projectPermissions"
  ],
  "properties": {
    "projectPermissions": {
      "items": {
        "$ref": "#/components/schemas/BulkProjectPermissionGrants"
      },
      "uniqueItems": true,
      "description": "List of project permissions and the projects and issues those permissions provide access to.",
      "type": "array"
    },
    "globalPermissions": {
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "description": "List of permissions granted to the user.",
      "type": "array"
    }
  }
}

WorkflowTransitionRules

{
  "properties": {
    "postFunctions": {
      "description": "The list of post functions within the workflow.",
      "items": {
        "$ref": "#/components/schemas/ConnectWorkflowTransitionRule"
      },
      "type": "array"
    },
    "workflowId": {
      "$ref": "#/components/schemas/WorkflowId"
    },
    "conditions": {
      "description": "The list of conditions within the workflow.",
      "items": {
        "$ref": "#/components/schemas/ConnectWorkflowTransitionRule"
      },
      "type": "array"
    },
    "validators": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectWorkflowTransitionRule"
      },
      "description": "The list of validators within the workflow."
    }
  },
  "additionalProperties": false,
  "description": "A workflow with transition rules.",
  "type": "object"
}

FoundFilter

{
  "description": "Details of a filter identified as part of a search.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "viewUrl": {
      "description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    },
    "favourite": {
      "readOnly": true,
      "description": "Indicates whether the filter is selected as a favorite by any users, not including the filter owner.",
      "type": "boolean"
    },
    "subscriptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FilterSubscription"
      },
      "description": "The users that are subscribed to the filter.",
      "readOnly": true
    },
    "self": {
      "type": "string",
      "description": "The URL of the filter.",
      "format": "uri",
      "readOnly": true
    },
    "searchUrl": {
      "format": "uri",
      "readOnly": true,
      "description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.",
      "type": "string"
    },
    "owner": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "description": "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.",
      "readOnly": true
    },
    "favouritedCount": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The count of how many users have selected this filter as a favorite, including the filter owner."
    },
    "jql": {
      "description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "The unique identifier for the filter."
    },
    "description": {
      "description": "A description of the filter.",
      "type": "string"
    },
    "sharePermissions": {
      "type": "array",
      "description": "The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.",
      "items": {
        "$ref": "#/components/schemas/SharePermission"
      }
    },
    "name": {
      "type": "string",
      "description": "The name of the filter. Must be unique."
    }
  },
  "required": [
    "name"
  ]
}

UserList

{
  "description": "A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/User"
      },
      "description": "The list of items.",
      "readOnly": true,
      "type": "array"
    },
    "size": {
      "type": "integer",
      "xml": {
        "attribute": true
      },
      "format": "int32",
      "readOnly": true,
      "description": "The number of items on the page."
    },
    "end-index": {
      "description": "The index of the last item returned on the page.",
      "readOnly": true,
      "format": "int32",
      "xml": {
        "name": "end-index",
        "attribute": true
      },
      "type": "integer"
    },
    "start-index": {
      "type": "integer",
      "xml": {
        "name": "start-index",
        "attribute": true
      },
      "format": "int32",
      "readOnly": true,
      "description": "The index of the first item returned on the page."
    },
    "max-results": {
      "type": "integer",
      "xml": {
        "name": "max-results",
        "attribute": true
      },
      "readOnly": true,
      "format": "int32",
      "description": "The maximum number of results that could be on the page."
    }
  }
}

IssueUpdateDetails

{
  "type": "object",
  "additionalProperties": true,
  "description": "Details of an issue update request.",
  "properties": {
    "properties": {
      "type": "array",
      "description": "Details of issue properties to be add or update.",
      "items": {
        "$ref": "#/components/schemas/EntityProperty"
      }
    },
    "historyMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadata"
        }
      ],
      "description": "Additional issue history details."
    },
    "transition": {
      "description": "Details of a transition. Required when performing a transition, optional when creating or editing an issue.",
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueTransition"
        }
      ]
    },
    "fields": {
      "type": "object",
      "description": "List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`.",
      "additionalProperties": {}
    },
    "update": {
      "additionalProperties": {
        "items": {
          "$ref": "#/components/schemas/FieldUpdateOperation"
        },
        "type": "array"
      },
      "description": "List of operations to perform on issue screen fields. Note that fields included in here cannot be included in `fields`.",
      "type": "object"
    }
  },
  "title": "IssueUpdateDetails"
}

UserBeanAvatarUrls

{
  "properties": {
    "24x24": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the user's 24x24 pixel avatar."
    },
    "16x16": {
      "type": "string",
      "description": "The URL of the user's 16x16 pixel avatar.",
      "format": "uri"
    },
    "32x32": {
      "type": "string",
      "description": "The URL of the user's 32x32 pixel avatar.",
      "format": "uri"
    },
    "48x48": {
      "description": "The URL of the user's 48x48 pixel avatar.",
      "format": "uri",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "type": "object"
}

RemoveOptionFromIssuesResult

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "errors": {
      "description": "A collection of errors related to unchanged issues. The collection size is limited, which means not all errors may be returned.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SimpleErrorCollection"
        }
      ]
    },
    "modifiedIssues": {
      "description": "The IDs of the modified issues.",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "type": "array"
    },
    "unmodifiedIssues": {
      "type": "array",
      "description": "The IDs of the unchanged issues, those issues where errors prevent modification.",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    }
  }
}

JqlQueryField

{
  "additionalProperties": false,
  "description": "A field used in a JQL query. See [Advanced searching - fields reference](https://confluence.atlassian.com/x/dAiiLQ) for more information about fields in JQL queries.",
  "type": "object",
  "properties": {
    "property": {
      "items": {
        "$ref": "#/components/schemas/JqlQueryFieldEntityProperty"
      },
      "description": "When the field refers to a value in an entity property, details of the entity property value.",
      "type": "array"
    },
    "name": {
      "description": "The name of the field.",
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

UserMigrationBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "accountId": {
      "type": "string"
    }
  }
}

PageBeanString

{
  "description": "A page of items.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "nextPage": {
      "description": "If there is another page of results, the URL of the next page.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    },
    "maxResults": {
      "description": "The maximum number of items that could be returned.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "self": {
      "type": "string",
      "description": "The URL of the page.",
      "readOnly": true,
      "format": "uri"
    },
    "isLast": {
      "type": "boolean",
      "description": "Indicates whether this is the last page.",
      "readOnly": true
    },
    "total": {
      "type": "integer",
      "description": "The number of items returned.",
      "readOnly": true,
      "format": "int64"
    },
    "values": {
      "description": "The list of items.",
      "items": {
        "readOnly": true,
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    }
  }
}

Group

{
  "properties": {
    "users": {
      "description": "A paginated list of the users that are members of the group. A maximum of 50 users is returned in the list, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 50 users, use`?expand=users[51:100]`.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedListUserDetailsApplicationUser"
        }
      ]
    },
    "self": {
      "readOnly": true,
      "format": "uri",
      "description": "The URL for these group details.",
      "type": "string"
    },
    "expand": {
      "readOnly": true,
      "description": "Expand options that include additional group details in the response.",
      "type": "string",
      "xml": {
        "attribute": true
      }
    },
    "name": {
      "description": "The name of group.",
      "type": "string"
    }
  },
  "type": "object",
  "additionalProperties": false
}

VersionIssuesStatus

{
  "type": "object",
  "additionalProperties": true,
  "description": "Counts of the number of issues in various statuses.",
  "properties": {
    "done": {
      "type": "integer",
      "description": "Count of issues with status *done*.",
      "readOnly": true,
      "format": "int64"
    },
    "toDo": {
      "readOnly": true,
      "format": "int64",
      "description": "Count of issues with status *to do*.",
      "type": "integer"
    },
    "unmapped": {
      "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "inProgress": {
      "type": "integer",
      "description": "Count of issues with status *in progress*.",
      "format": "int64",
      "readOnly": true
    }
  }
}

TimeTrackingConfiguration

{
  "properties": {
    "timeFormat": {
      "description": "The format that will appear on an issue's *Time Spent* field.",
      "type": "string",
      "enum": [
        "pretty",
        "days",
        "hours"
      ]
    },
    "workingHoursPerDay": {
      "format": "double",
      "description": "The number of hours in a working day.",
      "type": "number"
    },
    "defaultUnit": {
      "enum": [
        "minute",
        "hour",
        "day",
        "week"
      ],
      "type": "string",
      "description": "The default unit of time applied to logged time."
    },
    "workingDaysPerWeek": {
      "type": "number",
      "format": "double",
      "description": "The number of days in a working week."
    }
  },
  "required": [
    "defaultUnit",
    "timeFormat",
    "workingDaysPerWeek",
    "workingHoursPerDay"
  ],
  "additionalProperties": false,
  "description": "Details of the time tracking configuration.",
  "type": "object",
  "title": "TimeTrackingConfiguration"
}

User

{
  "description": "A user.",
  "additionalProperties": false,
  "xml": {
    "name": "user"
  },
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean",
      "description": "Indicates whether the user is active.",
      "readOnly": true
    },
    "groups": {
      "description": "The groups that the user belongs to.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/SimpleListWrapperGroupName"
        }
      ]
    },
    "timeZone": {
      "readOnly": true,
      "description": "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
      "type": "string"
    },
    "self": {
      "description": "The URL of the user.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    },
    "avatarUrls": {
      "description": "The avatars of the user.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/AvatarUrlsBean"
        }
      ]
    },
    "expand": {
      "description": "Expand options that include additional user details in the response.",
      "readOnly": true,
      "xml": {
        "attribute": true
      },
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
    },
    "accountType": {
      "description": "The user account type. Can take the following values:\n\n *  `atlassian` regular Atlassian user account\n *  `app` system account used for Connect applications and OAuth to represent external systems\n *  `customer` Jira Service Desk account representing an external service desk",
      "readOnly": true,
      "type": "string",
      "enum": [
        "atlassian",
        "app",
        "customer",
        "unknown"
      ]
    },
    "locale": {
      "type": "string",
      "description": "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
      "readOnly": true
    },
    "displayName": {
      "description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
      "readOnly": true,
      "type": "string"
    },
    "key": {
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "type": "string"
    },
    "applicationRoles": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimpleListWrapperApplicationRole"
        }
      ],
      "description": "The application roles the user is assigned to.",
      "readOnly": true
    },
    "emailAddress": {
      "readOnly": true,
      "description": "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
      "type": "string"
    },
    "accountId": {
      "description": "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests.",
      "type": "string"
    }
  },
  "title": "User"
}

WorkflowTransitionRulesUpdate

{
  "properties": {
    "workflows": {
      "type": "array",
      "description": "The list of workflows with transition rules to update.",
      "items": {
        "$ref": "#/components/schemas/WorkflowTransitionRules"
      }
    }
  },
  "additionalProperties": false,
  "description": "Details about a workflow configuration update request.",
  "type": "object",
  "title": "WorkflowTransitionRulesUpdate"
}

AuditRecords

{
  "additionalProperties": false,
  "description": "Container for a list of audit records.",
  "type": "object",
  "properties": {
    "limit": {
      "readOnly": true,
      "format": "int32",
      "description": "The requested or default limit on the number of audit items to be returned.",
      "type": "integer"
    },
    "records": {
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/AuditRecordBean"
      },
      "description": "The list of audit items.",
      "type": "array"
    },
    "total": {
      "description": "The total number of audit items returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "offset": {
      "description": "The number of audit items skipped before the first item in this list.",
      "readOnly": true,
      "format": "int32",
      "type": "integer"
    }
  }
}

SearchRequestBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of fields to return for each issue, use it to retrieve a subset of fields. Allowed values\n\n *  `*all` Returns all fields.\n *  `*navigable` Returns navigable fields.\n *  Any issue field, prefixed with a minus to exclude.\n\nThe default is `*navigable`.\n\nExamples:\n\n *  `summary,comment` Returns the summary and comments fields only.\n *  `-description` Returns all navigable (default) fields except description.\n *  `*all,-comment` Returns all fields except comments.\n\nMultiple `fields` parameters can be included in a request.\n\nNote: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields."
    },
    "maxResults": {
      "type": "integer",
      "format": "int32",
      "description": "The maximum number of items to return per page. The default is `50` and the maximum is `100`."
    },
    "validateQuery": {
      "type": "string",
      "description": "Determines how to validate the JQL query and treat the validation results. Supported values:\n\n *  `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n *  `warn` Returns all errors as warnings.\n *  `none` No validation is performed.\n *  `true` *Deprecated* A legacy synonym for `strict`.\n *  `false` *Deprecated* A legacy synonym for `warn`.\n\nThe default is `strict`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.",
      "enum": [
        "strict",
        "warn",
        "none",
        "true",
        "false"
      ]
    },
    "expand": {
      "items": {
        "type": "string"
      },
      "description": "Use [expand](em>#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are:\n\n *  `renderedFields` Returns field values rendered in HTML format.\n *  `names` Returns the display name of each field.\n *  `schema` Returns the schema describing a field type.\n *  `transitions` Returns all possible transitions for the issue.\n *  `operations` Returns all possible operations for the issue.\n *  `editmeta` Returns information about how each field can be edited.\n *  `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n *  `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.",
      "type": "array"
    },
    "startAt": {
      "type": "integer",
      "description": "The index of the first item to return in the page of results (page offset). The base index is `0`.",
      "format": "int32"
    },
    "fieldsByKeys": {
      "description": "Reference fields by their key (rather than ID). The default is `false`.",
      "type": "boolean"
    },
    "jql": {
      "description": "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.",
      "type": "string"
    },
    "properties": {
      "type": "array",
      "description": "A comma-separated list of up to 5 issue properties to include in the results.",
      "items": {
        "type": "string"
      }
    }
  },
  "title": "SearchRequestBean"
}

IssueTypeIssueCreateMetadata

{
  "type": "object",
  "description": "Details of the issue creation metadata for an issue type.",
  "additionalProperties": false,
  "properties": {
    "self": {
      "readOnly": true,
      "description": "The URL of these issue type details.",
      "type": "string"
    },
    "entityId": {
      "description": "project unique ID for next-gen entities",
      "format": "uuid",
      "readOnly": true,
      "type": "string"
    },
    "fields": {
      "readOnly": true,
      "additionalProperties": {
        "$ref": "#/components/schemas/FieldMetadata"
      },
      "description": "List of the fields available when creating an issue for the issue type.",
      "type": "object"
    },
    "avatarId": {
      "description": "The ID of the issue type's avatar.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "The ID of the issue type."
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "readOnly": true,
      "description": "Details of the next-gen projects the issue type is available in."
    },
    "iconUrl": {
      "readOnly": true,
      "description": "The URL of the issue type's avatar.",
      "type": "string"
    },
    "expand": {
      "readOnly": true,
      "description": "Expand options that include additional issue type metadata details in the response.",
      "type": "string",
      "xml": {
        "attribute": true
      }
    },
    "subtask": {
      "description": "Indicates whether this issue type is used to create subtasks.",
      "readOnly": true,
      "type": "boolean"
    },
    "name": {
      "description": "The name of the issue type.",
      "readOnly": true,
      "type": "string"
    },
    "description": {
      "description": "The description of the issue type.",
      "readOnly": true,
      "type": "string"
    }
  }
}

IssueEntityProperties

{
  "description": "Lists of issues and entity properties. See [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/) for more information.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "properties": {
      "maxProperties": 10,
      "minProperties": 1,
      "description": "A list of entity property keys and values.",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonNode"
      },
      "type": "object"
    },
    "entitiesIds": {
      "items": {
        "format": "int64",
        "type": "integer"
      },
      "description": "A list of entity IDs.",
      "uniqueItems": true,
      "type": "array",
      "maxItems": 10000,
      "minItems": 1
    }
  },
  "title": "IssueEntityProperties"
}

ListWrapperCallbackApplicationRole

{
  "type": "object",
  "additionalProperties": false
}

ProjectRoleGroupBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "displayName": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}

RichText

{
  "type": "object",
  "properties": {
    "emptyAdf": {
      "type": "boolean"
    },
    "valueSet": {
      "type": "boolean"
    }
  }
}

SecurityScheme

{
  "description": "Details about a security scheme.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "defaultSecurityLevelId": {
      "description": "The ID of the default security level.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "levels": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SecurityLevel"
      }
    },
    "description": {
      "readOnly": true,
      "description": "The description of the issue security scheme.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the issue security scheme."
    },
    "id": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The ID of the issue security scheme."
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "description": "The URL of the issue security scheme."
    }
  }
}

ServerInformation

{
  "additionalProperties": false,
  "description": "Details about the Jira instance.",
  "type": "object",
  "properties": {
    "buildDate": {
      "description": "The timestamp when the Jira version was built.",
      "format": "date-time",
      "type": "string"
    },
    "baseUrl": {
      "type": "string",
      "description": "The base URL of the Jira instance."
    },
    "serverTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time in Jira when this request was responded to."
    },
    "version": {
      "description": "The version of Jira.",
      "type": "string"
    },
    "serverTitle": {
      "type": "string",
      "description": "The name of the Jira instance."
    },
    "healthChecks": {
      "items": {
        "$ref": "#/components/schemas/HealthCheckResult"
      },
      "description": "Jira instance health check results. Deprecated and no longer returned.",
      "type": "array"
    },
    "versionNumbers": {
      "type": "array",
      "description": "The major, minor, and revision version numbers of the Jira version.",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "deploymentType": {
      "description": "The type of server deployment. This is always returned as *Cloud*.",
      "type": "string"
    },
    "scmInfo": {
      "description": "The unique identifier of the Jira version.",
      "type": "string"
    },
    "buildNumber": {
      "type": "integer",
      "format": "int32",
      "description": "The build number of the Jira version."
    }
  }
}

ContainerOfWorkflowSchemeAssociations

{
  "type": "object",
  "additionalProperties": false,
  "description": "A container for a list of workflow schemes together with the projects they are associated with.",
  "required": [
    "values"
  ],
  "properties": {
    "values": {
      "type": "array",
      "description": "A list of workflow schemes together with projects they are associated with.",
      "items": {
        "$ref": "#/components/schemas/WorkflowSchemeAssociations"
      }
    }
  }
}

Workflow

{
  "additionalProperties": false,
  "description": "Details about a workflow.",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/PublishedWorkflowId"
    },
    "statuses": {
      "items": {
        "$ref": "#/components/schemas/WorkflowStatus"
      },
      "description": "The statuses of the workflow.",
      "type": "array"
    },
    "description": {
      "description": "The description of the workflow.",
      "type": "string"
    },
    "transitions": {
      "description": "The transitions of the workflow.",
      "items": {
        "$ref": "#/components/schemas/Transition"
      },
      "type": "array"
    }
  },
  "required": [
    "description"
  ]
}

RemoteIssueLinkIdentifies

{
  "properties": {
    "id": {
      "xml": {
        "attribute": true
      },
      "type": "integer",
      "description": "The ID of the remote issue link, such as the ID of the item on the remote system.",
      "readOnly": true,
      "format": "int64"
    },
    "self": {
      "xml": {
        "attribute": true
      },
      "type": "string",
      "description": "The URL of the remote issue link.",
      "readOnly": true
    }
  },
  "additionalProperties": false,
  "description": "Details of the identifiers for a created or updated remote issue link.",
  "type": "object"
}

JexpJqlIssues

{
  "additionalProperties": false,
  "description": "The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Not all issues returned by the JQL query will be loaded, but only a portion of them, as described by the `startAt` and `maxResults` properties. Iterate over pages by inspecting the meta data included in the response.",
  "type": "object",
  "properties": {
    "maxResults": {
      "type": "integer",
      "format": "int32",
      "description": "The maximum number of issues that will be included on the list. This value is currently capped at 1000 but the cap may change without notice."
    },
    "startAt": {
      "type": "integer",
      "format": "int64",
      "description": "The index of the first issue returned from the JQL query."
    },
    "query": {
      "description": "The JQL query.",
      "type": "string"
    },
    "validation": {
      "description": "Determines how to validate the JQL query and treat the validation results.",
      "type": "string",
      "default": "strict",
      "enum": [
        "strict",
        "warn",
        "none"
      ]
    }
  }
}

JiraExpressionEvalRequestBean

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "expression"
  ],
  "properties": {
    "context": {
      "description": "The context in which the Jira expression is evaluated.",
      "allOf": [
        {
          "$ref": "#/components/schemas/JiraExpressionEvalContextBean"
        }
      ]
    },
    "expression": {
      "example": "{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }",
      "type": "string",
      "description": "The Jira expression to evaluate."
    }
  },
  "title": "JiraExpressionEvalRequestBean"
}

PageBeanUserKey

{
  "type": "object",
  "additionalProperties": false,
  "description": "A page of items.",
  "properties": {
    "startAt": {
      "type": "integer",
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true
    },
    "nextPage": {
      "type": "string",
      "description": "If there is another page of results, the URL of the next page.",
      "format": "uri",
      "readOnly": true
    },
    "maxResults": {
      "type": "integer",
      "readOnly": true,
      "format": "int32",
      "description": "The maximum number of items that could be returned."
    },
    "values": {
      "type": "array",
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/UserKey"
      },
      "readOnly": true
    },
    "total": {
      "type": "integer",
      "description": "The number of items returned.",
      "readOnly": true,
      "format": "int64"
    },
    "isLast": {
      "readOnly": true,
      "description": "Indicates whether this is the last page.",
      "type": "boolean"
    },
    "self": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the page."
    }
  }
}

PageOfWorklogs

{
  "properties": {
    "startAt": {
      "readOnly": true,
      "format": "int32",
      "description": "The index of the first item returned on the page.",
      "type": "integer"
    },
    "maxResults": {
      "description": "The maximum number of results that could be on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "worklogs": {
      "readOnly": true,
      "description": "List of worklogs.",
      "items": {
        "$ref": "#/components/schemas/Worklog"
      },
      "type": "array"
    },
    "total": {
      "format": "int32",
      "readOnly": true,
      "description": "The number of results on the page.",
      "type": "integer"
    }
  },
  "description": "Paginated list of worklog details",
  "additionalProperties": true,
  "type": "object"
}

PageBeanField

{
  "properties": {
    "nextPage": {
      "type": "string",
      "readOnly": true,
      "format": "uri",
      "description": "If there is another page of results, the URL of the next page."
    },
    "maxResults": {
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "description": "The maximum number of items that could be returned."
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "isLast": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether this is the last page."
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the page."
    },
    "total": {
      "description": "The number of items returned.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "values": {
      "type": "array",
      "readOnly": true,
      "description": "The list of items.",
      "items": {
        "$ref": "#/components/schemas/Field"
      }
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A page of items."
}

SimpleErrorCollection

{
  "properties": {
    "errorMessages": {
      "items": {
        "type": "string"
      },
      "description": "The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\"",
      "type": "array"
    },
    "errors": {
      "type": "object",
      "description": "The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\"",
      "additionalProperties": {
        "type": "string"
      }
    },
    "httpStatusCode": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "type": "object"
}

ScreenableField

{
  "type": "object",
  "description": "A screen tab field.",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "The name of the screen tab field. Required on create and update. The maximum length is 255 characters.",
      "type": "string"
    },
    "id": {
      "readOnly": true,
      "description": "The ID of the screen tab field.",
      "type": "string"
    }
  }
}

StatusDetails

{
  "properties": {
    "iconUrl": {
      "type": "string",
      "readOnly": true,
      "description": "The URL of the icon used to represent the status."
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "The description of the status."
    },
    "statusCategory": {
      "readOnly": true,
      "description": "The category assigned to the status.",
      "allOf": [
        {
          "$ref": "#/components/schemas/StatusCategory"
        }
      ]
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the status."
    },
    "self": {
      "type": "string",
      "description": "The URL of the status.",
      "readOnly": true
    },
    "id": {
      "description": "The ID of the status.",
      "readOnly": true,
      "type": "string"
    }
  },
  "additionalProperties": true,
  "description": "A status.",
  "type": "object"
}

EntityProperty

{
  "properties": {
    "value": {
      "description": "The value of the property. Required on create and update."
    },
    "key": {
      "description": "The key of the property. Required on create and update.",
      "type": "string"
    }
  },
  "type": "object",
  "description": "An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).",
  "additionalProperties": false
}

CreateUpdateRoleRequestBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.",
      "type": "string"
    },
    "description": {
      "description": "A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.",
      "type": "string"
    }
  },
  "title": "CreateUpdateRoleRequestBean"
}

PagedListUserDetailsApplicationUser

{
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserDetails"
      },
      "description": "The list of items.",
      "readOnly": true
    },
    "size": {
      "description": "The number of items on the page.",
      "readOnly": true,
      "format": "int32",
      "xml": {
        "attribute": true
      },
      "type": "integer"
    },
    "end-index": {
      "description": "The index of the last item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "xml": {
        "name": "end-index",
        "attribute": true
      },
      "type": "integer"
    },
    "start-index": {
      "type": "integer",
      "xml": {
        "name": "start-index",
        "attribute": true
      },
      "format": "int32",
      "readOnly": true,
      "description": "The index of the first item returned on the page."
    },
    "max-results": {
      "xml": {
        "name": "max-results",
        "attribute": true
      },
      "type": "integer",
      "description": "The maximum number of results that could be on the page.",
      "readOnly": true,
      "format": "int32"
    }
  },
  "description": "A paged list. To access additional details append `[start-index:end-index]` to the expand request. For example, `?expand=sharedUsers[10:40]` returns a list starting at item 10 and finishing at item 40.",
  "additionalProperties": false,
  "type": "object"
}

PageBeanNotificationScheme

{
  "properties": {
    "startAt": {
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "nextPage": {
      "readOnly": true,
      "format": "uri",
      "description": "If there is another page of results, the URL of the next page.",
      "type": "string"
    },
    "maxResults": {
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "description": "The maximum number of items that could be returned."
    },
    "values": {
      "items": {
        "$ref": "#/components/schemas/NotificationScheme"
      },
      "description": "The list of items.",
      "readOnly": true,
      "type": "array"
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the page."
    },
    "isLast": {
      "readOnly": true,
      "description": "Indicates whether this is the last page.",
      "type": "boolean"
    },
    "total": {
      "type": "integer",
      "description": "The number of items returned.",
      "readOnly": true,
      "format": "int64"
    }
  },
  "additionalProperties": false,
  "description": "A page of items.",
  "type": "object"
}

WorkflowSchemeAssociations

{
  "additionalProperties": false,
  "description": "A workflow scheme along with a list of projects that use it.",
  "type": "object",
  "properties": {
    "projectIds": {
      "items": {
        "type": "string"
      },
      "description": "The list of projects that use the workflow scheme.",
      "type": "array"
    },
    "workflowScheme": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowScheme"
        }
      ],
      "description": "The workflow scheme."
    }
  },
  "required": [
    "projectIds"
  ]
}

Notification

{
  "additionalProperties": true,
  "description": "Details about a notification.",
  "type": "object",
  "properties": {
    "textBody": {
      "type": "string",
      "description": "The plain text body of the email notification for the issue."
    },
    "subject": {
      "type": "string",
      "description": "The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary."
    },
    "restrict": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationRecipientsRestrictions"
        }
      ],
      "description": "Restricts the notifications to users with the specified permissions."
    },
    "htmlBody": {
      "description": "The HTML body of the email notification for the issue.",
      "type": "string"
    },
    "to": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationRecipients"
        }
      ],
      "description": "The recipients of the email notification for the issue."
    }
  },
  "title": "Notification"
}

FunctionOperand

{
  "description": "An operand that is a function. See [Advanced searching - functions reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functions.",
  "type": "object",
  "properties": {
    "function": {
      "type": "string",
      "description": "The name of the function."
    },
    "arguments": {
      "items": {
        "type": "string"
      },
      "description": "The list of function arguments.",
      "type": "array"
    }
  },
  "required": [
    "function"
  ]
}

JsonNode

{
  "type": "object",
  "maxProperties": 10,
  "minProperties": 1,
  "additionalProperties": false,
  "properties": {
    "pojo": {
      "type": "boolean"
    },
    "booleanValue": {
      "type": "boolean"
    },
    "object": {
      "type": "boolean"
    },
    "fields": {
      "type": "object"
    },
    "valueAsInt": {
      "type": "integer",
      "format": "int32"
    },
    "textual": {
      "type": "boolean"
    },
    "containerNode": {
      "type": "boolean"
    },
    "array": {
      "type": "boolean"
    },
    "intValue": {
      "type": "integer",
      "format": "int32"
    },
    "long": {
      "type": "boolean"
    },
    "int": {
      "type": "boolean"
    },
    "floatingPointNumber": {
      "type": "boolean"
    },
    "null": {
      "type": "boolean"
    },
    "integralNumber": {
      "type": "boolean"
    },
    "elements": {
      "type": "object"
    },
    "boolean": {
      "type": "boolean"
    },
    "numberType": {
      "type": "string",
      "enum": [
        "INT",
        "LONG",
        "BIG_INTEGER",
        "FLOAT",
        "DOUBLE",
        "BIG_DECIMAL"
      ]
    },
    "number": {
      "type": "boolean"
    },
    "binary": {
      "type": "boolean"
    },
    "double": {
      "type": "boolean"
    },
    "bigIntegerValue": {
      "type": "integer"
    },
    "valueAsLong": {
      "format": "int64",
      "type": "integer"
    },
    "bigDecimal": {
      "type": "boolean"
    },
    "valueAsText": {
      "type": "string"
    },
    "numberValue": {
      "type": "number"
    },
    "missingNode": {
      "type": "boolean"
    },
    "textValue": {
      "type": "string"
    },
    "valueAsDouble": {
      "format": "double",
      "type": "number"
    },
    "decimalValue": {
      "type": "number"
    },
    "binaryValue": {
      "items": {
        "format": "byte",
        "type": "string"
      },
      "type": "array"
    },
    "valueAsBoolean": {
      "type": "boolean"
    },
    "longValue": {
      "type": "integer",
      "format": "int64"
    },
    "bigInteger": {
      "type": "boolean"
    },
    "valueNode": {
      "type": "boolean"
    },
    "doubleValue": {
      "type": "number",
      "format": "double"
    },
    "fieldNames": {
      "type": "object"
    }
  }
}

SimpleListWrapperGroupName

{
  "additionalProperties": false,
  "xml": {
    "name": "list"
  },
  "type": "object",
  "properties": {
    "pagingCallback": {
      "$ref": "#/components/schemas/ListWrapperCallbackGroupName"
    },
    "size": {
      "type": "integer",
      "xml": {
        "attribute": true
      },
      "format": "int32"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupName"
      }
    },
    "callback": {
      "$ref": "#/components/schemas/ListWrapperCallbackGroupName"
    },
    "max-results": {
      "xml": {
        "attribute": true,
        "name": "max-results"
      },
      "type": "integer",
      "format": "int32"
    }
  }
}

IssueLinkType

{
  "description": "This object is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get).\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the issue link type and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only."
    },
    "self": {
      "type": "string",
      "description": "The URL of the issue link type. Read only.",
      "format": "uri",
      "readOnly": true
    },
    "inward": {
      "type": "string",
      "description": "The description of the issue link type inward link and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."
    },
    "name": {
      "description": "The name of the issue link type and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
      "type": "string"
    },
    "outward": {
      "description": "The description of the issue link type outward link and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
      "type": "string"
    }
  },
  "title": "IssueLinkType"
}

ProjectType

{
  "type": "object",
  "description": "Details about a project type.",
  "additionalProperties": false,
  "properties": {
    "key": {
      "type": "string",
      "description": "The key of the project type.",
      "readOnly": true
    },
    "icon": {
      "type": "string",
      "description": "The icon of the project type.",
      "readOnly": true
    },
    "formattedKey": {
      "type": "string",
      "description": "The formatted key of the project type.",
      "readOnly": true
    },
    "color": {
      "readOnly": true,
      "description": "The color of the project type.",
      "type": "string"
    },
    "descriptionI18nKey": {
      "type": "string",
      "readOnly": true,
      "description": "The key of the project type's description."
    }
  }
}

RemoteIssueLinkRequest

{
  "properties": {
    "application": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Application"
        }
      ],
      "description": "Details of the remote application the linked item is in. For example, trello."
    },
    "object": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RemoteObject"
        }
      ],
      "description": "Details of the item linked to."
    },
    "relationship": {
      "description": "Description of the relationship between the issue and the linked item. If not set, the relationship description \"links to\" is used in Jira.",
      "type": "string"
    },
    "globalId": {
      "type": "string",
      "description": "An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: `appId=456&pageId=123`.\n\nSetting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.\n\nThe maximum length is 255 characters."
    }
  },
  "additionalProperties": true,
  "description": "Details of a remote issue link.",
  "type": "object",
  "title": "RemoteIssueLinkRequest"
}

LinkIssueRequestJsonBean

{
  "properties": {
    "comment": {
      "$ref": "#/components/schemas/Comment"
    },
    "type": {
      "$ref": "#/components/schemas/IssueLinkType"
    },
    "inwardIssue": {
      "$ref": "#/components/schemas/LinkedIssue"
    },
    "outwardIssue": {
      "$ref": "#/components/schemas/LinkedIssue"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "title": "LinkIssueRequestJsonBean"
}

Fields

{
  "description": "Key fields from the linked issue.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "summary": {
      "type": "string",
      "description": "The summary description of the linked issue.",
      "readOnly": true
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StatusDetails"
        }
      ],
      "description": "The status of the linked issue.",
      "readOnly": true
    },
    "issueType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueTypeBean"
        }
      ],
      "readOnly": true,
      "description": "The type of the linked issue."
    },
    "issuetype": {
      "$ref": "#/components/schemas/IssueTypeBean",
      "description": "The type of the linked issue."
    },
    "priority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Priority"
        }
      ],
      "description": "The priority of the linked issue.",
      "readOnly": true
    },
    "assignee": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ],
      "readOnly": true,
      "description": "The assignee of the linked issue."
    }
  }
}

FieldUpdateOperation

{
  "properties": {
    "add": {
      "example": {
        "labels": "Training",
        "issuelinks": {
          "id": 10001
        }
      },
      "description": "A map containing the name of a field and the value to add to it."
    },
    "edit": {
      "example": {
        "timetracking": {
          "key": "JIRA"
        }
      },
      "description": "A map containing the name of a field and the value to edit in it."
    },
    "remove": {
      "description": "A map containing the name of a field and the value to removed from it.",
      "example": {
        "components": {
          "id": 10017
        },
        "labels": "Training"
      }
    },
    "set": {
      "description": "A map containing the name of a field and the value to set in it.",
      "example": {
        "issuetype": {
          "id": 10010
        },
        "summary": "A new summary"
      }
    }
  },
  "additionalProperties": false,
  "description": "Details of an operation to perform on a field.",
  "type": "object"
}

ChangeDetails

{
  "type": "object",
  "additionalProperties": false,
  "description": "A change item.",
  "properties": {
    "fieldId": {
      "readOnly": true,
      "description": "The ID of the field changed.",
      "type": "string"
    },
    "toString": {
      "readOnly": true,
      "description": "The details of the new value as a string.",
      "type": "string"
    },
    "field": {
      "readOnly": true,
      "description": "The name of the field changed.",
      "type": "string"
    },
    "to": {
      "readOnly": true,
      "description": "The details of the new value.",
      "type": "string"
    },
    "fieldtype": {
      "type": "string",
      "description": "The type of the field changed.",
      "readOnly": true
    },
    "from": {
      "readOnly": true,
      "description": "The details of the original value.",
      "type": "string"
    },
    "fromString": {
      "readOnly": true,
      "description": "The details of the original value as a string.",
      "type": "string"
    }
  }
}

JQLReferenceData

{
  "properties": {
    "jqlReservedWords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of JQL query reserved words."
    },
    "visibleFieldNames": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FieldReferenceData"
      },
      "description": "List of fields usable in JQL queries."
    },
    "visibleFunctionNames": {
      "type": "array",
      "description": "List of functions usable in JQL queries.",
      "items": {
        "$ref": "#/components/schemas/FunctionReferenceData"
      }
    }
  },
  "type": "object",
  "description": "Lists of JQL reference data.",
  "additionalProperties": false
}

SharePermissionInputBean

{
  "properties": {
    "projectRoleId": {
      "type": "string",
      "description": "The ID of the project role to share the filter with. Set `type` to `projectRole` and the `projectId` for the project that the role is in."
    },
    "groupname": {
      "description": "The name of the group to share the filter with. Set `type` to `group`.",
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "The type of the share permission.Specify the type as follows:\n\n *  `group` Share with a group. Specify `groupname` as well.\n *  `project` Share with a project. Specify `projectId` as well.\n *  `projectRole` Share with a project role in a project. Specify `projectId` and `projectRoleId` as well.\n *  `global` Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.\n *  `authenticated` Share with all logged-in users. This shows as `loggedin` in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.",
      "enum": [
        "project",
        "group",
        "projectRole",
        "global",
        "authenticated"
      ]
    },
    "projectId": {
      "description": "The ID of the project to share the filter with. Set `type` to `project`.",
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false,
  "type": "object",
  "title": "SharePermissionInputBean"
}

JiraExpressionEvalContextBean

{
  "properties": {
    "customerRequest": {
      "description": "The ID of the customer request that is available under the `customerRequest` variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type.",
      "format": "int64",
      "type": "integer"
    },
    "serviceDesk": {
      "type": "integer",
      "description": "The ID of the service desk that is available under the `serviceDesk` variable when evaluating the expression.",
      "format": "int64"
    },
    "issues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JexpIssues"
        }
      ],
      "description": "The collection of issues that is available under the `issues` variable when evaluating the expression."
    },
    "project": {
      "description": "The project that is available under the `project` variable when evaluating the expression.",
      "allOf": [
        {
          "$ref": "#/components/schemas/IdOrKeyBean"
        }
      ]
    },
    "sprint": {
      "format": "int64",
      "description": "The ID of the sprint that is available under the `sprint` variable when evaluating the expression.",
      "type": "integer"
    },
    "issue": {
      "description": "The issue that is available under the `issue` variable when evaluating the expression.",
      "allOf": [
        {
          "$ref": "#/components/schemas/IdOrKeyBean"
        }
      ]
    },
    "board": {
      "type": "integer",
      "description": "The ID of the board that is available under the `board` variable when evaluating the expression.",
      "format": "int64"
    }
  },
  "additionalProperties": false,
  "type": "object"
}

WorkflowTransition

{
  "type": "object",
  "description": "A workflow transition.",
  "additionalProperties": false,
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "format": "int32",
      "description": "The transition ID.",
      "type": "integer"
    },
    "name": {
      "description": "The transition name.",
      "type": "string"
    }
  }
}

ChangedWorklog

{
  "properties": {
    "properties": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/EntityProperty"
      },
      "description": "Details of properties associated with the change."
    },
    "updatedTime": {
      "type": "integer",
      "description": "The datetime of the change.",
      "readOnly": true,
      "format": "int64"
    },
    "worklogId": {
      "type": "integer",
      "description": "The ID of the worklog.",
      "format": "int64",
      "readOnly": true
    }
  },
  "description": "Details of a changed worklog.",
  "additionalProperties": false,
  "type": "object"
}

Votes

{
  "type": "object",
  "description": "The details of votes on an issue.",
  "additionalProperties": false,
  "properties": {
    "votes": {
      "description": "The number of votes on the issue.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "self": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The URL of these issue vote details."
    },
    "voters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/User"
      },
      "description": "List of the users who have voted on this issue. An empty list is returned when the calling user doesn't have the *View voters and watchers* project permission.",
      "readOnly": true
    },
    "hasVoted": {
      "type": "boolean",
      "description": "Indicates whether the user making this request has voted on the issue.",
      "readOnly": true
    }
  }
}

IssuePickerSuggestionsIssueType

{
  "properties": {
    "sub": {
      "readOnly": true,
      "description": "If issue suggestions are found, returns a message indicating the number of issues suggestions found and returned.",
      "type": "string"
    },
    "issues": {
      "items": {
        "$ref": "#/components/schemas/SuggestedIssue"
      },
      "description": "A list of issues suggested for use in auto-completion.",
      "readOnly": true,
      "type": "array"
    },
    "label": {
      "description": "The label of the type of issues suggested for use in auto-completion.",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the type of issues suggested for use in auto-completion.",
      "readOnly": true,
      "type": "string"
    },
    "msg": {
      "type": "string",
      "description": "If no issue suggestions are found, returns a message indicating no suggestions were found,",
      "readOnly": true
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A type of issue suggested for use in auto-completion."
}

FieldReferenceData

{
  "properties": {
    "operators": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The valid search operators for the field."
    },
    "cfid": {
      "description": "If the item is a custom field, the ID of the custom field.",
      "type": "string"
    },
    "displayName": {
      "description": "The display name of the field.",
      "type": "string"
    },
    "orderable": {
      "enum": [
        "true",
        "false"
      ],
      "type": "string",
      "description": "Indicates whether the field can be used in a query's `ORDER BY` clause."
    },
    "types": {
      "items": {
        "type": "string"
      },
      "description": "The data types of items in the field.",
      "type": "array"
    },
    "searchable": {
      "description": "Indicates whether the content of this field can be searched.",
      "type": "string",
      "enum": [
        "true",
        "false"
      ]
    },
    "value": {
      "description": "The field identifier.",
      "type": "string"
    },
    "auto": {
      "description": "Indicates whether the field provide auto-complete suggestions.",
      "type": "string",
      "enum": [
        "true",
        "false"
      ]
    }
  },
  "description": "Details of a field that can be used in advanced searches.",
  "additionalProperties": false,
  "type": "object"
}

PermissionSchemes

{
  "additionalProperties": false,
  "description": "List of all permission schemes.",
  "type": "object",
  "properties": {
    "permissionSchemes": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/PermissionScheme"
      },
      "description": "Permission schemes list."
    }
  }
}

JQLPersonalDataMigrationRequest

{
  "description": "The JQL queries to be converted.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "queryStrings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of queries with user identifiers. Maximum of 100 queries."
    }
  },
  "title": "JQLPersonalDataMigrationRequest"
}

AttachmentArchiveMetadataReadable

{
  "type": "object",
  "additionalProperties": false,
  "description": "Metadata for an archive (for example a zip) and its contents.",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AttachmentArchiveItemReadable"
      },
      "description": "The list of the items included in the archive.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the archive file."
    },
    "totalEntryCount": {
      "type": "integer",
      "description": "The number of items included in the archive.",
      "format": "int64",
      "readOnly": true
    },
    "mediaType": {
      "type": "string",
      "readOnly": true,
      "description": "The MIME type of the attachment."
    },
    "id": {
      "description": "The ID of the attachment.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    }
  }
}

Avatars

{
  "properties": {
    "custom": {
      "items": {
        "$ref": "#/components/schemas/Avatar"
      },
      "description": "Custom avatars list.",
      "readOnly": true,
      "type": "array"
    },
    "system": {
      "description": "System avatars list.",
      "items": {
        "$ref": "#/components/schemas/Avatar"
      },
      "readOnly": true,
      "type": "array"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details about system and custom avatars."
}

PageBeanChangelog

{
  "properties": {
    "isLast": {
      "description": "Indicates whether this is the last page.",
      "readOnly": true,
      "type": "boolean"
    },
    "self": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the page."
    },
    "total": {
      "description": "The number of items returned.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    },
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Changelog"
      },
      "description": "The list of items.",
      "readOnly": true
    },
    "nextPage": {
      "type": "string",
      "description": "If there is another page of results, the URL of the next page.",
      "format": "uri",
      "readOnly": true
    },
    "maxResults": {
      "format": "int32",
      "readOnly": true,
      "description": "The maximum number of items that could be returned.",
      "type": "integer"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    }
  },
  "description": "A page of items.",
  "additionalProperties": false,
  "type": "object"
}

RuleConfiguration

{
  "type": "object",
  "additionalProperties": false,
  "description": "A rule configuration.",
  "required": [
    "value"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "Configuration of the rule, as it is stored by the Connect app on the rule configuration page."
    }
  }
}

ConnectModules

{
  "description": "A list of app modules in the same format as the `modules` property in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).",
  "additionalProperties": {
    "description": "A list of modules by type.",
    "items": {
      "$ref": "#/components/schemas/ConnectModule"
    },
    "type": "array"
  },
  "type": "object",
  "example": {
    "jiraIssueFields": [
      {
        "key": "dynamic-select-field",
        "extractions": [
          {
            "name": "categoryName",
            "type": "text",
            "path": "category"
          }
        ],
        "description": {
          "value": "A dynamically added single-select field"
        },
        "name": {
          "value": "Dynamic single select"
        },
        "type": "single_select"
      }
    ],
    "jiraEntityProperties": [
      {
        "entityType": "issue",
        "keyConfigurations": [
          {
            "extractions": [
              {
                "alias": "attachmentExtension",
                "type": "text",
                "objectName": "extension"
              }
            ],
            "propertyKey": "attachment"
          }
        ],
        "key": "dynamic-attachment-entity-property",
        "name": {
          "value": "Attachment Index Document"
        }
      }
    ]
  },
  "title": "ConnectModules"
}

Worklog

{
  "properties": {
    "updated": {
      "type": "string",
      "readOnly": true,
      "format": "date-time",
      "description": "The datetime on which the worklog was last updated."
    },
    "issueId": {
      "description": "The ID of the issue this worklog is for.",
      "readOnly": true,
      "type": "string"
    },
    "visibility": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Visibility"
        }
      ],
      "description": "Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog."
    },
    "updateAuthor": {
      "readOnly": true,
      "description": "Details of the user who last updated the worklog.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ]
    },
    "properties": {
      "items": {
        "$ref": "#/components/schemas/EntityProperty"
      },
      "description": "Details of properties for the worklog. Optional when creating or updating a worklog.",
      "type": "array"
    },
    "id": {
      "description": "The ID of the worklog record.",
      "readOnly": true,
      "type": "string"
    },
    "timeSpent": {
      "description": "The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided.",
      "type": "string"
    },
    "comment": {
      "description": "A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog."
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The datetime on which the worklog was created."
    },
    "author": {
      "readOnly": true,
      "description": "Details of the user who created the worklog.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ]
    },
    "started": {
      "format": "date-time",
      "description": "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.",
      "type": "string"
    },
    "timeSpentSeconds": {
      "format": "int64",
      "description": "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.",
      "type": "integer"
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the worklog item."
    }
  },
  "type": "object",
  "xml": {
    "name": "worklog"
  },
  "description": "Details of a worklog.",
  "additionalProperties": true,
  "title": "Worklog"
}

UnrestrictedUserEmail

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "The accountId of the user"
    },
    "email": {
      "type": "string",
      "description": "The email of the user"
    }
  }
}

JqlQueryClauseOperand

{
  "description": "Details of an operand in a JQL clause.",
  "type": "object",
  "anyOf": [
    {
      "$ref": "#/components/schemas/ListOperand"
    },
    {
      "$ref": "#/components/schemas/ValueOperand"
    },
    {
      "$ref": "#/components/schemas/FunctionOperand"
    },
    {
      "$ref": "#/components/schemas/KeywordOperand"
    }
  ]
}

RegisteredWebhook

{
  "additionalProperties": false,
  "description": "ID of a registered webhook or error messages explaining why a webhook wasn't registered.",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error messages specifying why the webhook creation failed.",
      "items": {
        "type": "string",
        "description": "Error messages specifying why the webhook creation failed."
      }
    },
    "createdWebhookId": {
      "type": "integer",
      "description": "The ID of the webhook. Returned if the webhook is created.",
      "format": "int64"
    }
  }
}

Dashboard

{
  "additionalProperties": false,
  "description": "Details of a dashboard.",
  "type": "object",
  "properties": {
    "description": {
      "type": "string"
    },
    "view": {
      "readOnly": true,
      "description": "The URL of the dashboard.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the dashboard."
    },
    "sharePermissions": {
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/SharePermission"
      },
      "description": "The details of any share permissions for the dashboard.",
      "type": "array"
    },
    "popularity": {
      "description": "The number of users who have this dashboard as a favorite.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "description": "The ID of the dashboard.",
      "readOnly": true,
      "type": "string"
    },
    "owner": {
      "description": "The owner of the dashboard.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBean"
        }
      ]
    },
    "rank": {
      "type": "integer",
      "readOnly": true,
      "format": "int32",
      "description": "The rank of this dashboard."
    },
    "self": {
      "type": "string",
      "description": "The URL of these dashboard details.",
      "readOnly": true,
      "format": "uri"
    },
    "isFavourite": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether the dashboard is selected as a favorite by the user."
    }
  }
}

PropertyKeys

{
  "additionalProperties": false,
  "description": "List of property keys.",
  "type": "object",
  "properties": {
    "keys": {
      "type": "array",
      "readOnly": true,
      "description": "Property key details.",
      "items": {
        "$ref": "#/components/schemas/PropertyKey"
      }
    }
  }
}

ParsedJqlQuery

{
  "required": [
    "query"
  ],
  "minLength": 1,
  "properties": {
    "query": {
      "type": "string",
      "description": "The JQL query that was parsed and validated."
    },
    "errors": {
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "description": "The list of syntax or validation errors.",
      "type": "array"
    },
    "structure": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JqlQuery"
        }
      ],
      "description": "The syntax tree of the query. Empty if the query was invalid."
    }
  },
  "type": "object",
  "description": "Details of a parsed JQL query.",
  "additionalProperties": false
}

HierarchyLevel

{
  "properties": {
    "aboveLevelId": {
      "type": "integer",
      "format": "int64"
    },
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "issueTypeIds": {
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "type": "array"
    },
    "projectConfigurationId": {
      "type": "integer",
      "format": "int64"
    },
    "externalUuid": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "belowLevelId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "additionalProperties": false,
  "type": "object"
}

SystemAvatars

{
  "properties": {
    "system": {
      "description": "A list of avatar details.",
      "items": {
        "$ref": "#/components/schemas/Avatar"
      },
      "readOnly": true,
      "type": "array"
    }
  },
  "description": "List of system avatars.",
  "additionalProperties": false,
  "type": "object"
}

CreatedIssues

{
  "type": "object",
  "description": "Details about the issues created and the errors for requests that failed.",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error details for failed issue creation requests.",
      "items": {
        "$ref": "#/components/schemas/BulkOperationErrorResult"
      },
      "readOnly": true
    },
    "issues": {
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/CreatedIssue"
      },
      "description": "Details of the issues created.",
      "type": "array"
    }
  }
}

FunctionReferenceData

{
  "properties": {
    "displayName": {
      "description": "The display name of the function.",
      "type": "string"
    },
    "types": {
      "items": {
        "type": "string"
      },
      "description": "The data types returned by the function.",
      "type": "array"
    },
    "isList": {
      "type": "string",
      "description": "Indicates whether the function can take a list of arguments.",
      "enum": [
        "true",
        "false"
      ]
    },
    "value": {
      "description": "The function identifier.",
      "type": "string"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details of functions that can be used in advanced searches."
}

IssueLinkTypes

{
  "properties": {
    "issueLinkTypes": {
      "xml": {
        "name": "issueLinkTypes"
      },
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IssueLinkType"
      },
      "description": "The issue link type bean.",
      "readOnly": true
    }
  },
  "xml": {
    "name": "issueLinkTypes"
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A list of issue link type beans."
}

IssueTypesWorkflowMapping

{
  "properties": {
    "issueTypes": {
      "items": {
        "type": "string"
      },
      "description": "The list of issue type IDs.",
      "type": "array"
    },
    "defaultMapping": {
      "description": "Indicates whether the workflow is the default workflow for the workflow scheme.",
      "type": "boolean"
    },
    "workflow": {
      "type": "string",
      "description": "The name of the workflow. Optional if updating the workflow-issue types mapping."
    },
    "updateDraftIfNeeded": {
      "description": "Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to `false`.",
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "description": "Details about the mapping between issue types and a workflow.",
  "type": "object",
  "title": "IssueTypesWorkflowMapping"
}

IssueTransition

{
  "additionalProperties": true,
  "description": "Details of an issue transition.",
  "type": "object",
  "properties": {
    "isInitial": {
      "description": "Indicates whether this is the initial issue transition for the workflow.",
      "readOnly": true,
      "type": "boolean"
    },
    "hasScreen": {
      "description": "Indicates whether there is a screen associated with the issue transition.",
      "readOnly": true,
      "type": "boolean"
    },
    "to": {
      "description": "Details of the issue status after the transition.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StatusDetails"
        }
      ]
    },
    "fields": {
      "readOnly": true,
      "description": "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.",
      "additionalProperties": {
        "$ref": "#/components/schemas/FieldMetadata"
      },
      "type": "object"
    },
    "isConditional": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether the issue has to meet certain criteria before the issue transition is applied."
    },
    "isGlobal": {
      "description": "Indicates whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
      "readOnly": true,
      "type": "boolean"
    },
    "id": {
      "description": "The ID of the issue transition. Required when specifying a transition to undertake.",
      "type": "string"
    },
    "expand": {
      "description": "Expand options that include additional transition details in the response.",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the issue transition."
    }
  }
}

SharePermission

{
  "description": "Details of a share permission for the filter.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "project": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Project"
        }
      ],
      "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`.  \nFor a request, specify the `id` for the project."
    },
    "id": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The unique identifier of the share permission."
    },
    "role": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectRole"
        }
      ],
      "description": "The project role that the filter is shared with.  \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
    },
    "group": {
      "description": "The group that the filter is shared with. For a request, specify the `name` property for the group.",
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupName"
        }
      ]
    },
    "type": {
      "description": "The type of share permission:\n\n *  `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n *  `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n *  `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n *  `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n *  `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n *  `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.",
      "type": "string"
    }
  },
  "required": [
    "type"
  ]
}

IssueMatches

{
  "properties": {
    "matches": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IssueMatchesForJQL"
      }
    }
  },
  "required": [
    "matches"
  ],
  "additionalProperties": false,
  "description": "A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.",
  "type": "object"
}

PageBeanWorkflow

{
  "properties": {
    "self": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the page."
    },
    "isLast": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether this is the last page."
    },
    "total": {
      "description": "The number of items returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "values": {
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/Workflow"
      },
      "description": "The list of items.",
      "type": "array"
    },
    "maxResults": {
      "type": "integer",
      "readOnly": true,
      "format": "int32",
      "description": "The maximum number of items that could be returned."
    },
    "nextPage": {
      "format": "uri",
      "readOnly": true,
      "description": "If there is another page of results, the URL of the next page.",
      "type": "string"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    }
  },
  "type": "object",
  "description": "A page of items.",
  "additionalProperties": false
}

JqlQueryOrderByClause

{
  "description": "Details of the order-by JQL clause.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "fields": {
      "type": "array",
      "description": "The list of order-by clause fields and their ordering directives.",
      "items": {
        "$ref": "#/components/schemas/JqlQueryOrderByClauseElement"
      }
    }
  },
  "required": [
    "fields"
  ]
}

PermissionsKeysBean

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "permissions"
  ],
  "properties": {
    "permissions": {
      "type": "array",
      "description": "A list of permission keys.",
      "items": {
        "type": "string"
      }
    }
  },
  "title": "PermissionsKeysBean"
}

JqlQueryClauseTimePredicate

{
  "required": [
    "operand",
    "operator"
  ],
  "properties": {
    "operator": {
      "type": "string",
      "description": "The operator between the field and the operand.",
      "enum": [
        "before",
        "after",
        "from",
        "to",
        "on",
        "during",
        "by"
      ]
    },
    "operand": {
      "$ref": "#/components/schemas/JqlQueryClauseOperand"
    }
  },
  "type": "object",
  "description": "A time predicate for a temporal JQL clause."
}

DeleteAndReplaceVersionBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "customFieldReplacementList": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomFieldReplacement"
      },
      "description": "An array of custom field IDs (`customFieldId`) and version IDs (`moveTo`) to update when the fields contain the deleted version."
    },
    "moveFixIssuesTo": {
      "type": "integer",
      "format": "int64",
      "description": "The ID of the version to update `fixVersion` to when the field contains the deleted version."
    },
    "moveAffectedIssuesTo": {
      "format": "int64",
      "description": "The ID of the version to update `affectedVersion` to when the field contains the deleted version.",
      "type": "integer"
    }
  },
  "title": "DeleteAndReplaceVersionBean"
}

ProjectIssueCreateMetadata

{
  "properties": {
    "expand": {
      "readOnly": true,
      "description": "Expand options that include additional project issue create metadata details in the response.",
      "type": "string",
      "xml": {
        "attribute": true
      }
    },
    "issuetypes": {
      "description": "List of the issue types supported by the project.",
      "items": {
        "$ref": "#/components/schemas/IssueTypeIssueCreateMetadata"
      },
      "readOnly": true,
      "type": "array"
    },
    "key": {
      "description": "The key of the project.",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the project."
    },
    "avatarUrls": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AvatarUrlsBean"
        }
      ],
      "readOnly": true,
      "description": "List of the project's avatars, returning the avatar size and associated URL."
    },
    "id": {
      "readOnly": true,
      "description": "The ID of the project.",
      "type": "string"
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "description": "The URL of the project."
    }
  },
  "description": "Details of the issue creation metadata for a project.",
  "additionalProperties": false,
  "type": "object"
}

JiraExpressionsComplexityBean

{
  "properties": {
    "steps": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JiraExpressionsComplexityValueBean"
        }
      ],
      "description": "The number of steps it took to evaluate the expression."
    },
    "beans": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JiraExpressionsComplexityValueBean"
        }
      ],
      "description": "The number of Jira REST API beans returned in the response."
    },
    "primitiveValues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JiraExpressionsComplexityValueBean"
        }
      ],
      "description": "The number of primitive values returned in the response."
    },
    "expensiveOperations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JiraExpressionsComplexityValueBean"
        }
      ],
      "description": "The number of expensive operations executed while evaluating the expression. Expensive operations are those that load additional data, such as entity properties, comments, or custom fields."
    }
  },
  "type": "object",
  "additionalProperties": false
}

Webhook

{
  "type": "object",
  "description": "A webhook.",
  "additionalProperties": false,
  "required": [
    "expirationDate",
    "id",
    "jqlFilter"
  ],
  "properties": {
    "jqlFilter": {
      "type": "string",
      "description": "The JQL filter that specifies which issues the webhook is sent for."
    },
    "events": {
      "type": "array",
      "description": "The Jira events that trigger the webhook.",
      "items": {
        "enum": [
          "jira:issue_created",
          "jira:issue_updated",
          "jira:issue_deleted",
          "comment_created",
          "comment_updated",
          "comment_deleted"
        ],
        "type": "string"
      }
    },
    "expirationDate": {
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the webhook.",
      "format": "int64"
    }
  }
}

ListWrapperCallbackGroupName

{
  "type": "object",
  "additionalProperties": false
}

WorkflowRules

{
  "required": [
    "conditions",
    "postFunctions",
    "validators"
  ],
  "properties": {
    "validators": {
      "type": "array",
      "description": "The workflow validators.",
      "items": {
        "$ref": "#/components/schemas/WorkflowTransitionRule"
      }
    },
    "conditions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WorkflowTransitionRule"
      },
      "description": "The workflow conditions."
    },
    "postFunctions": {
      "type": "array",
      "description": "The workflow post functions.",
      "items": {
        "$ref": "#/components/schemas/WorkflowTransitionRule"
      }
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A collection of transition rules."
}

IssuesMetaBean

{
  "properties": {
    "jql": {
      "$ref": "#/components/schemas/IssuesJqlMetaDataBean"
    }
  },
  "description": "Meta data describing the `issues` context variable.",
  "additionalProperties": false,
  "type": "object"
}

MinimalIssueTypeOutput

{
  "properties": {
    "name": {
      "type": "string"
    },
    "avatarId": {
      "format": "int64",
      "type": "integer"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object",
  "additionalProperties": false
}

LinkedIssue

{
  "properties": {
    "fields": {
      "description": "The fields associated with the issue.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/Fields"
        }
      ]
    },
    "key": {
      "description": "The key of an issue. Required if `id` isn't provided.",
      "type": "string"
    },
    "id": {
      "description": "The ID of an issue. Required if `key` isn't provided.",
      "type": "string"
    },
    "self": {
      "type": "string",
      "readOnly": true,
      "format": "uri",
      "description": "The URL of the issue."
    }
  },
  "description": "The ID or key of a linked issue.",
  "additionalProperties": false,
  "type": "object"
}

Screen

{
  "description": "A screen.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The ID of the screen."
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "description": "The scope of the screen."
    },
    "name": {
      "description": "The name of the screen.",
      "readOnly": true,
      "type": "string"
    }
  }
}

NotificationEvent

{
  "type": "object",
  "additionalProperties": false,
  "description": "Details about a notification event.",
  "properties": {
    "description": {
      "description": "The description of the event.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The name of the event."
    },
    "id": {
      "format": "int64",
      "description": "The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg).",
      "type": "integer"
    },
    "templateEvent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationEvent"
        }
      ],
      "description": "The template of the event. Only custom events configured by Jira administrators have template."
    }
  }
}

KeywordOperand

{
  "type": "object",
  "description": "An operand that is a JQL keyword. See [Advanced searching - keywords reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY) for more information about operand keywords.",
  "required": [
    "keyword"
  ],
  "properties": {
    "keyword": {
      "enum": [
        "empty"
      ],
      "type": "string",
      "description": "The keyword that is the operand value."
    }
  }
}

ComponentWithIssueCount

{
  "properties": {
    "issueCount": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "Count of issues for the component."
    },
    "assignee": {
      "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.",
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ]
    },
    "isAssigneeTypeValid": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned."
    },
    "realAssigneeType": {
      "type": "string",
      "readOnly": true,
      "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n *  `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n *  `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n *  `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n *  `PROJECT_DEFAULT` when none of the preceding cases are true.",
      "enum": [
        "PROJECT_DEFAULT",
        "COMPONENT_LEAD",
        "PROJECT_LEAD",
        "UNASSIGNED"
      ]
    },
    "project": {
      "type": "string",
      "readOnly": true,
      "description": "The key of the project to which the component is assigned."
    },
    "self": {
      "type": "string",
      "description": "The URL for this count of the issues contained in the component.",
      "readOnly": true,
      "format": "uri"
    },
    "projectId": {
      "description": "Not used.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "realAssignee": {
      "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.",
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ]
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name for the component."
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "The description for the component."
    },
    "id": {
      "type": "string",
      "description": "The unique identifier for the component.",
      "readOnly": true
    },
    "lead": {
      "description": "The user details for the component's lead user.",
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ]
    },
    "assigneeType": {
      "type": "string",
      "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:\n\n *  `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n *  `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n *  `UNASSIGNED` an assignee is not set for issues created with this component.\n *  `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.",
      "readOnly": true,
      "enum": [
        "PROJECT_DEFAULT",
        "COMPONENT_LEAD",
        "PROJECT_LEAD",
        "UNASSIGNED"
      ]
    }
  },
  "additionalProperties": false,
  "description": "Details about a component with a count of the issues it contains.",
  "type": "object"
}

ContainerForRegisteredWebhooks

{
  "type": "object",
  "additionalProperties": false,
  "description": "Container for a list of registered webhooks. Webhook details are returned in the same order as the request.",
  "properties": {
    "webhookRegistrationResult": {
      "items": {
        "$ref": "#/components/schemas/RegisteredWebhook"
      },
      "description": "A list of registered webhooks.",
      "type": "array"
    }
  }
}

BulkOperationErrorResult

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "failedElementNumber": {
      "type": "integer",
      "format": "int32"
    },
    "status": {
      "format": "int32",
      "type": "integer"
    },
    "elementErrors": {
      "$ref": "#/components/schemas/ErrorCollection"
    }
  }
}

Project

{
  "properties": {
    "components": {
      "items": {
        "$ref": "#/components/schemas/Component"
      },
      "description": "List of the components contained in the project.",
      "readOnly": true,
      "type": "array"
    },
    "roles": {
      "additionalProperties": {
        "type": "string",
        "readOnly": true,
        "format": "uri"
      },
      "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).",
      "readOnly": true,
      "type": "object"
    },
    "avatarUrls": {
      "readOnly": true,
      "description": "The URLs of the project's avatars.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AvatarUrlsBean"
        }
      ]
    },
    "email": {
      "type": "string",
      "description": "An email address associated with the project."
    },
    "key": {
      "description": "The key of the project.",
      "readOnly": true,
      "type": "string"
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "A brief description of the project."
    },
    "uuid": {
      "readOnly": true,
      "format": "uuid",
      "description": "unique ID for next-gen projects",
      "type": "string"
    },
    "isPrivate": {
      "type": "boolean",
      "description": "Indicates whether the project is private.",
      "readOnly": true
    },
    "projectCategory": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectCategory"
        }
      ],
      "readOnly": true,
      "description": "The category the project belongs to."
    },
    "style": {
      "type": "string",
      "readOnly": true,
      "description": "The type of the project."
    },
    "issueTypeHierarchy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Hierarchy"
        }
      ],
      "description": "The issue type hierarchy for the project",
      "readOnly": true
    },
    "lead": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "readOnly": true,
      "description": "The username of the project lead."
    },
    "id": {
      "description": "The ID of the project.",
      "type": "string"
    },
    "properties": {
      "description": "Map of project properties",
      "additionalProperties": {
        "readOnly": true
      },
      "readOnly": true,
      "type": "object"
    },
    "projectTypeKey": {
      "enum": [
        "software",
        "service_desk",
        "business"
      ],
      "readOnly": true,
      "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
      "type": "string"
    },
    "issueTypes": {
      "items": {
        "$ref": "#/components/schemas/IssueTypeBean"
      },
      "description": "List of the issue types available in the project.",
      "readOnly": true,
      "type": "array"
    },
    "simplified": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether the project is simplified."
    },
    "self": {
      "type": "string",
      "description": "The URL of the project details.",
      "format": "uri",
      "readOnly": true
    },
    "expand": {
      "type": "string",
      "xml": {
        "attribute": true
      },
      "readOnly": true,
      "description": "Expand options that include additional project details in the response."
    },
    "url": {
      "type": "string",
      "description": "A link to information about this project, such as project documentation.",
      "readOnly": true
    },
    "name": {
      "description": "The name of the project.",
      "readOnly": true,
      "type": "string"
    },
    "permissions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectPermissions"
        }
      ],
      "readOnly": true,
      "description": "User permissions on the project"
    },
    "versions": {
      "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).",
      "items": {
        "$ref": "#/components/schemas/Version"
      },
      "readOnly": true,
      "type": "array"
    },
    "assigneeType": {
      "enum": [
        "PROJECT_LEAD",
        "UNASSIGNED"
      ],
      "type": "string",
      "description": "The default assignee when creating issues for this project.",
      "readOnly": true
    }
  },
  "xml": {
    "name": "project"
  },
  "type": "object",
  "description": "Details about a project.",
  "additionalProperties": false
}

WorklogIdsRequestBean

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "ids"
  ],
  "properties": {
    "ids": {
      "description": "A list of worklog IDs.",
      "items": {
        "format": "int64",
        "type": "integer"
      },
      "uniqueItems": true,
      "type": "array"
    }
  },
  "title": "WorklogIdsRequestBean"
}

AttachmentArchiveImpl

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "totalEntryCount": {
      "type": "integer",
      "description": "The number of items in the archive.",
      "format": "int32"
    },
    "entries": {
      "description": "The list of the items included in the archive.",
      "items": {
        "$ref": "#/components/schemas/AttachmentArchiveEntry"
      },
      "type": "array"
    }
  }
}

Changelog

{
  "description": "A changelog.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "items": {
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/ChangeDetails"
      },
      "description": "The list of items changed.",
      "type": "array"
    },
    "author": {
      "readOnly": true,
      "description": "The user who made the change.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ]
    },
    "created": {
      "readOnly": true,
      "format": "date-time",
      "description": "The date on which the change took place.",
      "type": "string"
    },
    "id": {
      "readOnly": true,
      "description": "The ID of the changelog.",
      "type": "string"
    },
    "historyMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadata"
        }
      ],
      "description": "The history metadata associated with the changed.",
      "readOnly": true
    }
  }
}

FieldMetadata

{
  "xml": {
    "name": "availableField"
  },
  "type": "object",
  "description": "The metadata describing an issue field.",
  "additionalProperties": false,
  "required": [
    "key",
    "name",
    "operations",
    "required"
  ],
  "properties": {
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JsonTypeBean"
        }
      ],
      "readOnly": true,
      "description": "The data type of the field."
    },
    "hasDefaultValue": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether the field has a default value."
    },
    "operations": {
      "type": "array",
      "readOnly": true,
      "items": {
        "type": "string",
        "readOnly": true
      },
      "description": "The list of operations that can be performed on the field."
    },
    "defaultValue": {
      "readOnly": true,
      "description": "The default value of the field."
    },
    "required": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether the field is required."
    },
    "name": {
      "readOnly": true,
      "description": "The name of the field.",
      "type": "string"
    },
    "autoCompleteUrl": {
      "type": "string",
      "readOnly": true,
      "description": "The URL that can be used to automatically complete the field."
    },
    "key": {
      "type": "string",
      "readOnly": true,
      "description": "The key of the field."
    },
    "allowedValues": {
      "type": "array",
      "readOnly": true,
      "items": {
        "readOnly": true
      },
      "description": "The list of values allowed in the field."
    }
  }
}

PermissionGrant

{
  "additionalProperties": false,
  "description": "Details about a permission granted to a user or group.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the permission granted details.",
      "readOnly": true,
      "format": "int64"
    },
    "self": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The URL of the permission granted details."
    },
    "holder": {
      "description": "The user or group being granted the permission. It consists of a `type` and a type-dependent `parameter`. See [Holder object](#holder-object) in *Get all permission schemes* for more information.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PermissionHolder"
        }
      ]
    },
    "permission": {
      "type": "string",
      "description": "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](#built-in-permissions) in *Get all permission schemes* for more information about the built-in permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions."
    }
  },
  "title": "PermissionGrant"
}

CustomFieldReplacement

{
  "properties": {
    "moveTo": {
      "description": "The version number to use as a replacement for the deleted version.",
      "format": "int64",
      "type": "integer"
    },
    "customFieldId": {
      "format": "int64",
      "description": "The ID of the custom field in which to replace the version number.",
      "type": "integer"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details about the replacement for a deleted version."
}

ActorsMap

{
  "properties": {
    "user": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The user account ID of the user to add."
    },
    "group": {
      "description": "The name of the group to add.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "title": "ActorsMap"
}

ProjectScopeBean

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "id": {
      "format": "int64",
      "description": "The ID of the project that the option's behavior applies to.",
      "type": "integer"
    },
    "attributes": {
      "type": "array",
      "items": {
        "enum": [
          "notSelectable",
          "defaultValue"
        ],
        "type": "string"
      },
      "description": "Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.",
      "uniqueItems": true
    }
  }
}

AutoCompleteSuggestions

{
  "additionalProperties": false,
  "description": "The results from a JQL query.",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "description": "The list of suggested item.",
      "items": {
        "$ref": "#/components/schemas/AutoCompleteSuggestion"
      }
    }
  }
}

GroupName

{
  "type": "object",
  "description": "Details about a group name.",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of group."
    },
    "self": {
      "type": "string",
      "description": "The URL for these group details.",
      "format": "uri",
      "readOnly": true
    }
  }
}

PageOfChangelogs

{
  "description": "A page of changelogs.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "readOnly": true,
      "format": "int32",
      "description": "The number of results on the page."
    },
    "histories": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/Changelog"
      },
      "description": "The list of changelogs."
    },
    "startAt": {
      "readOnly": true,
      "format": "int32",
      "description": "The index of the first item returned on the page.",
      "type": "integer"
    },
    "maxResults": {
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "description": "The maximum number of results that could be on the page."
    }
  }
}

EventNotification

{
  "type": "object",
  "additionalProperties": false,
  "description": "Details about a notification associated with an event.",
  "properties": {
    "parameter": {
      "type": "string",
      "description": "The value of the `notificationType`:\n\n *  `User` The `parameter` is the user key.\n *  `Group` The `parameter` is the group name.\n *  `ProjectRole` The `parameter` is the project role ID.\n *  `UserCustomField` The `parameter` is the ID of the custom field.\n *  `GroupCustomField` The `parameter` is the ID of the custom field."
    },
    "user": {
      "description": "The specified user.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ]
    },
    "projectRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectRole"
        }
      ],
      "description": "The specified project role."
    },
    "expand": {
      "description": "Expand options that include additional event notification details in the response.",
      "type": "string"
    },
    "group": {
      "description": "The specified group.",
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupName"
        }
      ]
    },
    "notificationType": {
      "type": "string",
      "description": "Identifies the recipients of the notification.",
      "enum": [
        "CurrentAssignee",
        "Reporter",
        "CurrentUser",
        "ProjectLead",
        "ComponentLead",
        "User",
        "Group",
        "ProjectRole",
        "EmailAddress",
        "AllWatchers",
        "UserCustomField",
        "GroupCustomField"
      ]
    },
    "emailAddress": {
      "type": "string",
      "description": "The email address."
    },
    "id": {
      "type": "integer",
      "description": "The ID of the notification.",
      "format": "int64"
    },
    "field": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FieldDeprecated"
        }
      ],
      "description": "The custom user or group field."
    }
  }
}

OperationMessage

{
  "properties": {
    "statusCode": {
      "type": "integer",
      "format": "int32",
      "description": "The status code of the response."
    },
    "message": {
      "description": "The human-readable message that describes the result.",
      "type": "string"
    }
  },
  "required": [
    "message",
    "statusCode"
  ],
  "example": {
    "statusCode": 200,
    "message": "An example message."
  },
  "additionalProperties": false,
  "type": "object"
}

DeprecatedWorkflow

{
  "properties": {
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "description": "The scope where this workflow applies",
      "readOnly": true
    },
    "lastModifiedDate": {
      "readOnly": true,
      "description": "The datetime the workflow was last modified.",
      "type": "string"
    },
    "lastModifiedUser": {
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "readOnly": true,
      "type": "string"
    },
    "description": {
      "readOnly": true,
      "description": "The description of the workflow.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The name of the workflow.",
      "readOnly": true
    },
    "default": {
      "type": "boolean"
    },
    "steps": {
      "readOnly": true,
      "format": "int32",
      "description": "The number of steps included in the workflow.",
      "type": "integer"
    },
    "lastModifiedUserAccountId": {
      "type": "string",
      "description": "The account ID of the user that last modified the workflow.",
      "readOnly": true
    }
  },
  "type": "object",
  "description": "Details about a workflow.",
  "additionalProperties": false
}

UserKey

{
  "properties": {
    "key": {
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "type": "string"
    },
    "accountId": {
      "description": "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "description": "List of user accountIds.",
  "type": "object"
}

PermittedProjects

{
  "properties": {
    "projects": {
      "type": "array",
      "description": "A list of projects.",
      "items": {
        "$ref": "#/components/schemas/ProjectIdentifierBean"
      },
      "readOnly": true
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A list of projects in which a user is granted permissions."
}

IssueFilterForBulkPropertyDelete

{
  "properties": {
    "entityIds": {
      "items": {
        "format": "int64",
        "type": "integer"
      },
      "description": "List of issues to perform the bulk delete operation on.",
      "uniqueItems": true,
      "type": "array"
    },
    "currentValue": {
      "description": "The value of properties to perform the bulk operation on."
    }
  },
  "description": "Bulk operation filter details.",
  "additionalProperties": false,
  "type": "object",
  "title": "IssueFilterForBulkPropertyDelete"
}

ProjectForScope

{
  "properties": {
    "avatarUrls": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AvatarUrlsBean"
        }
      ],
      "readOnly": true,
      "description": "The URLs of the project's avatars."
    },
    "self": {
      "type": "string",
      "description": "The URL of the project details.",
      "readOnly": true
    },
    "projectTypeKey": {
      "enum": [
        "software",
        "service_desk",
        "business"
      ],
      "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
      "readOnly": true,
      "type": "string"
    },
    "simplified": {
      "description": "Whether or not the project is simplified.",
      "readOnly": true,
      "type": "boolean"
    },
    "projectCategory": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UpdatedProjectCategory"
        }
      ],
      "description": "The category the project belongs to.",
      "readOnly": true
    },
    "id": {
      "type": "string",
      "description": "The ID of the project."
    },
    "key": {
      "readOnly": true,
      "description": "The key of the project.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The name of the project.",
      "readOnly": true
    }
  },
  "description": "Details about a next-gen project.",
  "additionalProperties": false,
  "type": "object"
}

UpdatedProjectCategory

{
  "description": "A project category.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The description of the project category."
    },
    "description": {
      "readOnly": true,
      "description": "The name of the project category.",
      "type": "string"
    },
    "id": {
      "readOnly": true,
      "description": "The ID of the project category.",
      "type": "string"
    },
    "self": {
      "readOnly": true,
      "description": "The URL of the project category.",
      "type": "string"
    }
  }
}

IssueCreateMetadata

{
  "properties": {
    "projects": {
      "items": {
        "$ref": "#/components/schemas/ProjectIssueCreateMetadata"
      },
      "description": "List of projects and their issue creation metadata.",
      "readOnly": true,
      "type": "array"
    },
    "expand": {
      "xml": {
        "attribute": true
      },
      "type": "string",
      "description": "Expand options that include additional project details in the response.",
      "readOnly": true
    }
  },
  "description": "The wrapper for the issue creation metadata for a list of projects.",
  "additionalProperties": false,
  "type": "object"
}

WorkflowTransitionRule

{
  "type": "object",
  "description": "A workflow transition rule.",
  "additionalProperties": false,
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "description": "The type of the transition rule.",
      "type": "string"
    },
    "configuration": {
      "description": "The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change."
    }
  }
}

IdBean

{
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the permission scheme to associate with the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to get a list of permission scheme IDs.",
      "format": "int64"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "title": "IdBean"
}

ProjectInputBean

{
  "properties": {
    "projectTypeKey": {
      "enum": [
        "software",
        "service_desk",
        "business"
      ],
      "type": "string",
      "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which dictates the application-specific feature set. Required when creating a project. Not applicable for the Update project resource."
    },
    "categoryId": {
      "description": "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation.",
      "format": "int64",
      "type": "integer"
    },
    "url": {
      "type": "string",
      "description": "A link to information about this project, such as project documentation"
    },
    "key": {
      "description": "Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters. Required when creating a project. Optional when updating a project.",
      "type": "string"
    },
    "description": {
      "description": "A brief description of the project.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The name of the project. Required when creating a project. Optional when updating a project."
    },
    "permissionScheme": {
      "description": "The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs.",
      "format": "int64",
      "type": "integer"
    },
    "notificationScheme": {
      "type": "integer",
      "format": "int64",
      "description": "The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs."
    },
    "assigneeType": {
      "enum": [
        "PROJECT_LEAD",
        "UNASSIGNED"
      ],
      "type": "string",
      "description": "The default assignee when creating issues for this project."
    },
    "projectTemplateKey": {
      "type": "string",
      "description": "A prebuilt configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`. Required when creating a project. Not applicable for the Update project resource."
    },
    "issueSecurityScheme": {
      "type": "integer",
      "format": "int64",
      "description": "The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs."
    },
    "avatarId": {
      "description": "An integer value for the project's avatar.",
      "format": "int64",
      "type": "integer"
    },
    "leadAccountId": {
      "description": "The account id of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `lead`.",
      "type": "string"
    },
    "lead": {
      "type": "string",
      "description": "This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `leadAccountId`."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "title": "ProjectInputBean"
}

BulkIssuePropertyUpdateRequest

{
  "additionalProperties": false,
  "description": "Bulk issue property update request details.",
  "type": "object",
  "properties": {
    "value": {
      "description": "The value of the property. The value must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters."
    },
    "filter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueFilterForBulkPropertySet"
        }
      ],
      "description": "The bulk operation filter."
    }
  },
  "title": "BulkIssuePropertyUpdateRequest"
}

WebhookDetails

{
  "additionalProperties": false,
  "description": "A list of webhooks.",
  "type": "object",
  "properties": {
    "jqlFilter": {
      "type": "string",
      "description": "The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:\n\n *  Fields: `issueKey`, `project`, `issuetype`, `status`, `assignee`, `reporter`, `issue.property`, and `cf[id]` (for custom fields—only the epic label custom field is supported).\n *  Operators: `=`, `!=`, `IN`, and `NOT IN`."
    },
    "events": {
      "description": "The Jira events that trigger the webhook.",
      "items": {
        "type": "string",
        "enum": [
          "jira:issue_created",
          "jira:issue_updated",
          "jira:issue_deleted",
          "comment_created",
          "comment_updated",
          "comment_deleted"
        ]
      },
      "type": "array"
    }
  },
  "required": [
    "jqlFilter"
  ]
}

Transition

{
  "required": [
    "description",
    "from",
    "id",
    "name",
    "to",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the transition."
    },
    "rules": {
      "$ref": "#/components/schemas/WorkflowRules"
    },
    "name": {
      "description": "The name of the transition.",
      "type": "string"
    },
    "description": {
      "description": "The description of the transition.",
      "type": "string"
    },
    "type": {
      "description": "The type of the transition.",
      "type": "string",
      "enum": [
        "global",
        "initial",
        "directed"
      ]
    },
    "to": {
      "description": "The status to which the transition leads.",
      "type": "string"
    },
    "screen": {
      "$ref": "#/components/schemas/ScreenID"
    },
    "from": {
      "items": {
        "type": "string",
        "description": "The list of statuses from which the transition can be taken."
      },
      "description": "The list of statuses from which the transition can be taken.",
      "type": "array"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details of a workflow transition."
}

AuditRecordBean

{
  "type": "object",
  "description": "An audit record.",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "The ID of the audit record.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "summary": {
      "type": "string",
      "description": "The summary of the audit record.",
      "readOnly": true
    },
    "description": {
      "description": "The description of the audit record.",
      "readOnly": true,
      "type": "string"
    },
    "objectItem": {
      "$ref": "#/components/schemas/AssociatedItemBean"
    },
    "associatedItems": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/AssociatedItemBean"
      },
      "description": "The list of items associated with the changed record."
    },
    "authorKey": {
      "description": "The key of the user who created the audit record.",
      "readOnly": true,
      "type": "string"
    },
    "category": {
      "type": "string",
      "description": "The category of the audit record. For a list of these categories, see the help article [Auditing in Jira applications](https://confluence.atlassian.com/x/noXKM).",
      "readOnly": true
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The date and time on which the audit record was created."
    },
    "remoteAddress": {
      "description": "The URL of the computer where the creation of the audit record was initiated.",
      "readOnly": true,
      "type": "string"
    },
    "changedValues": {
      "items": {
        "$ref": "#/components/schemas/ChangedValueBean"
      },
      "description": "The list of values changed in the record event.",
      "readOnly": true,
      "type": "array"
    },
    "eventSource": {
      "type": "string",
      "description": "The event the audit record originated from.",
      "readOnly": true
    }
  }
}

ContainerForWebhookIDs

{
  "additionalProperties": false,
  "description": "Container for a list of webhook IDs.",
  "type": "object",
  "properties": {
    "webhookIds": {
      "description": "A list of webhook IDs.",
      "items": {
        "format": "int64",
        "description": "A list of webhook IDs.",
        "type": "integer"
      },
      "type": "array"
    }
  },
  "required": [
    "webhookIds"
  ],
  "title": "ContainerForWebhookIDs"
}

AttachmentSettings

{
  "properties": {
    "enabled": {
      "readOnly": true,
      "description": "Whether the ability to add attachments is enabled.",
      "type": "boolean"
    },
    "uploadLimit": {
      "description": "The maximum size of attachments permitted, in bytes.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    }
  },
  "description": "Details of the instance's attachment settings.",
  "additionalProperties": false,
  "type": "object"
}

UserDetails

{
  "properties": {
    "timeZone": {
      "type": "string",
      "description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
      "readOnly": true
    },
    "self": {
      "description": "The URL of the user.",
      "readOnly": true,
      "type": "string"
    },
    "avatarUrls": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AvatarUrlsBean"
        }
      ],
      "readOnly": true,
      "description": "The avatars of the user."
    },
    "active": {
      "description": "Whether the user is active.",
      "readOnly": true,
      "type": "boolean"
    },
    "accountId": {
      "type": "string",
      "description": "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
    },
    "emailAddress": {
      "description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "readOnly": true
    },
    "accountType": {
      "readOnly": true,
      "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
      "type": "string"
    },
    "key": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "readOnly": true
    },
    "displayName": {
      "type": "string",
      "readOnly": true,
      "description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value."
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "User details."
}

ScreenableTab

{
  "additionalProperties": false,
  "description": "A screen tab.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the screen tab. Required on create and update. The maximum length is 255 characters.",
      "type": "string"
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "The ID of the screen tab."
    }
  },
  "required": [
    "name"
  ],
  "title": "ScreenableTab"
}

Operations

{
  "type": "object",
  "additionalProperties": true,
  "description": "Details of the operations that can be performed on the issue.",
  "properties": {
    "linkGroups": {
      "items": {
        "$ref": "#/components/schemas/LinkGroup"
      },
      "description": "Details of the link groups defining issue operations.",
      "readOnly": true,
      "type": "array"
    }
  }
}

RemoteIssueLink

{
  "type": "object",
  "description": "Details of an issue remote link.",
  "additionalProperties": false,
  "properties": {
    "object": {
      "description": "Details of the item linked to.",
      "allOf": [
        {
          "$ref": "#/components/schemas/RemoteObject"
        }
      ]
    },
    "globalId": {
      "type": "string",
      "description": "The global ID of the link, such as the ID of the item on the remote system."
    },
    "relationship": {
      "type": "string",
      "description": "Description of the relationship between the issue and the linked item."
    },
    "id": {
      "type": "integer",
      "description": "The ID of the link.",
      "format": "int64"
    },
    "self": {
      "format": "uri",
      "description": "The URL of the link.",
      "type": "string"
    },
    "application": {
      "description": "Details of the remote application the linked item is in.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Application"
        }
      ]
    }
  }
}

CreatedIssue

{
  "type": "object",
  "additionalProperties": false,
  "description": "Details about a created issue or subtask.",
  "properties": {
    "key": {
      "type": "string",
      "readOnly": true,
      "description": "The key of the created issue or subtask."
    },
    "transition": {
      "readOnly": true,
      "description": "The response code and messages related to any requested transition.",
      "allOf": [
        {
          "$ref": "#/components/schemas/NestedResponse"
        }
      ]
    },
    "self": {
      "type": "string",
      "description": "The URL of the created issue or subtask.",
      "readOnly": true
    },
    "id": {
      "readOnly": true,
      "description": "The ID of the created issue or subtask.",
      "type": "string"
    }
  }
}

HistoryMetadataParticipant

{
  "properties": {
    "url": {
      "description": "The URL of the user or system associated with a history record.",
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "The type of the user or system associated with a history record."
    },
    "avatarUrl": {
      "type": "string",
      "description": "The URL to an avatar for the user or system associated with a history record."
    },
    "displayName": {
      "description": "The display name of the user or system associated with a history record.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the user or system associated with a history record.",
      "type": "string"
    },
    "displayNameKey": {
      "description": "The key of the display name of the user or system associated with a history record.",
      "type": "string"
    }
  },
  "additionalProperties": true,
  "description": "Details of user or system associated with a issue history metadata item.",
  "type": "object"
}

UserPickerUser

{
  "additionalProperties": false,
  "description": "A user found in a search.",
  "type": "object",
  "properties": {
    "displayName": {
      "description": "The display name of the user. Depending on the user’s privacy setting, this may be returned as null.",
      "type": "string"
    },
    "key": {
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
    },
    "avatarUrl": {
      "type": "string",
      "description": "The avatar URL of the user.",
      "format": "uri"
    },
    "html": {
      "description": "The display name, email address, and key of the user with the matched query string highlighted with the HTML bold tag.",
      "type": "string"
    },
    "accountId": {
      "type": "string",
      "description": "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
    }
  }
}

ProjectIdentifiers

{
  "properties": {
    "key": {
      "readOnly": true,
      "description": "The key of the created project.",
      "type": "string"
    },
    "self": {
      "description": "The URL of the created project.",
      "readOnly": true,
      "format": "uri",
      "type": "string"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the created project.",
      "readOnly": true,
      "format": "int64"
    }
  },
  "required": [
    "id",
    "key",
    "self"
  ],
  "additionalProperties": false,
  "description": "Identifiers for a project.",
  "type": "object"
}

BulkProjectPermissions

{
  "required": [
    "permissions"
  ],
  "properties": {
    "issues": {
      "description": "List of issue IDs.",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "uniqueItems": true,
      "type": "array"
    },
    "permissions": {
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "description": "List of project permissions.",
      "type": "array"
    },
    "projects": {
      "type": "array",
      "description": "List of project IDs.",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "uniqueItems": true
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details of project permissions and associated issues and projects to look up."
}

WorkflowScheme

{
  "type": "object",
  "description": "Details about a workflow scheme.",
  "additionalProperties": false,
  "properties": {
    "lastModified": {
      "readOnly": true,
      "description": "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.",
      "type": "string"
    },
    "name": {
      "description": "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.",
      "type": "string"
    },
    "description": {
      "type": "string",
      "description": "The description of the workflow scheme."
    },
    "lastModifiedUser": {
      "description": "The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ]
    },
    "id": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The ID of the workflow scheme."
    },
    "draft": {
      "description": "Indicates whether the workflow scheme is a draft or not.",
      "readOnly": true,
      "type": "boolean"
    },
    "defaultWorkflow": {
      "description": "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*.",
      "type": "string"
    },
    "issueTypeMappings": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme."
    },
    "originalDefaultWorkflow": {
      "type": "string",
      "readOnly": true,
      "description": "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira."
    },
    "originalIssueTypeMappings": {
      "additionalProperties": {
        "type": "string",
        "readOnly": true
      },
      "description": "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.",
      "readOnly": true,
      "type": "object"
    },
    "issueTypes": {
      "description": "The issue types available in Jira.",
      "additionalProperties": {
        "$ref": "#/components/schemas/IssueTypeBean"
      },
      "readOnly": true,
      "type": "object"
    },
    "self": {
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "updateDraftIfNeeded": {
      "description": "Indicates whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n *  Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n *  Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n *  Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`.",
      "type": "boolean"
    }
  },
  "title": "WorkflowScheme"
}

HealthCheckResult

{
  "additionalProperties": false,
  "description": "Jira instance health check results. Deprecated and no longer returned.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Jira health check item."
    },
    "description": {
      "type": "string",
      "description": "The description of the Jira health check item."
    },
    "passed": {
      "type": "boolean",
      "description": "Indicates whether the Jira health check item passed or failed."
    }
  }
}

Application

{
  "type": "object",
  "description": "The application the linked item is in.",
  "additionalProperties": true,
  "properties": {
    "type": {
      "type": "string",
      "description": "The name-spaced type of the application, used by registered rendering apps."
    },
    "name": {
      "description": "The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\". Grouping and sorting of links may place links without an application name last.",
      "type": "string"
    }
  }
}

FoundUsersAndGroups

{
  "properties": {
    "groups": {
      "$ref": "#/components/schemas/FoundGroups"
    },
    "users": {
      "$ref": "#/components/schemas/FoundUsers"
    }
  },
  "description": "List of users and groups found in a search.",
  "additionalProperties": false,
  "type": "object"
}

ActorInputBean

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "user": {
      "description": "The account IDs of the users to add as default actors. You can add multiple account IDs separated by a comma. For example, `\"user\":[\"12345678-9abc-def1-2345-6789abcdef12\", \"abcdef12-3456-789a-bcde-f123456789ab\"]`.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "group": {
      "description": "The name of the group to add as a default actor. You can add multiple groups separated with a comma. For example, `\"group\":[\"project-admin\", \"jira-developers\"]`.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "title": "ActorInputBean"
}

AddGroupBean

{
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the group."
    }
  },
  "type": "object",
  "additionalProperties": true,
  "title": "AddGroupBean"
}

VersionUsageInCustomField

{
  "type": "object",
  "description": "List of custom fields using the version.",
  "additionalProperties": false,
  "properties": {
    "issueCountWithVersionInCustomField": {
      "readOnly": true,
      "format": "int64",
      "description": "Count of the issues where the custom field contains the version.",
      "type": "integer"
    },
    "customFieldId": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "The ID of the custom field."
    },
    "fieldName": {
      "description": "The name of the custom field.",
      "readOnly": true,
      "type": "string"
    }
  }
}

VersionUnresolvedIssuesCount

{
  "type": "object",
  "xml": {
    "name": "version"
  },
  "additionalProperties": false,
  "description": "Count of a version's unresolved issues.",
  "properties": {
    "issuesUnresolvedCount": {
      "type": "integer",
      "readOnly": true,
      "format": "int64",
      "description": "Count of unresolved issues."
    },
    "self": {
      "format": "uri",
      "readOnly": true,
      "description": "The URL of these count details.",
      "type": "string"
    },
    "issuesCount": {
      "description": "Count of issues.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    }
  }
}

IssueTypeBean

{
  "additionalProperties": false,
  "description": "Details about an issue type.",
  "type": "object",
  "properties": {
    "self": {
      "description": "The URL of these issue type details.",
      "readOnly": true,
      "type": "string"
    },
    "entityId": {
      "type": "string",
      "description": "project unique ID for next-gen entities",
      "format": "uuid",
      "readOnly": true
    },
    "avatarId": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "The ID of the issue type's avatar."
    },
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "The ID of the issue type."
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "readOnly": true,
      "description": "Details of the next-gen projects the issue type is available in."
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the issue type."
    },
    "subtask": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether this issue type is used to create subtasks."
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "The description of the issue type."
    },
    "iconUrl": {
      "type": "string",
      "description": "The URL of the issue type's avatar.",
      "readOnly": true
    }
  }
}

BulkProjectPermissionGrants

{
  "type": "object",
  "description": "List of project permissions and the projects and issues those permissions grant access to.",
  "additionalProperties": false,
  "required": [
    "issues",
    "permission",
    "projects"
  ],
  "properties": {
    "permission": {
      "type": "string",
      "description": "A project permission,"
    },
    "projects": {
      "uniqueItems": true,
      "items": {
        "format": "int64",
        "type": "integer"
      },
      "description": "IDs of the projects the user has the permission for.",
      "type": "array"
    },
    "issues": {
      "uniqueItems": true,
      "items": {
        "format": "int64",
        "type": "integer"
      },
      "description": "IDs of the issues the user has the permission for.",
      "type": "array"
    }
  }
}

IssueFieldOptionCreateBean

{
  "additionalProperties": true,
  "type": "object",
  "properties": {
    "value": {
      "description": "The option's name, which is displayed in Jira.",
      "type": "string"
    },
    "properties": {
      "description": "The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.",
      "additionalProperties": {},
      "type": "object"
    },
    "config": {
      "$ref": "#/components/schemas/IssueFieldOptionConfiguration"
    }
  },
  "required": [
    "value"
  ],
  "title": "IssueFieldOptionCreateBean"
}

FoundGroup

{
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the group."
    },
    "labels": {
      "items": {
        "$ref": "#/components/schemas/GroupLabel"
      },
      "type": "array"
    },
    "html": {
      "type": "string",
      "description": "The group name with the matched query string highlighted with the HTML bold tag."
    }
  },
  "type": "object",
  "xml": {
    "name": "group"
  },
  "description": "A group found in a search.",
  "additionalProperties": false
}

AttachmentArchiveItemReadable

{
  "properties": {
    "mediaType": {
      "type": "string",
      "readOnly": true,
      "description": "The MIME type of the archive item."
    },
    "label": {
      "type": "string",
      "description": "The label for the archive item.",
      "readOnly": true
    },
    "path": {
      "description": "The path of the archive item.",
      "readOnly": true,
      "type": "string"
    },
    "index": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "The position of the item within the archive."
    },
    "size": {
      "type": "string",
      "description": "The size of the archive item.",
      "readOnly": true
    }
  },
  "type": "object",
  "description": "Metadata for an item in an attachment archive.",
  "additionalProperties": false
}

DefaultShareScope

{
  "xml": {
    "name": "defaultShareScope"
  },
  "type": "object",
  "additionalProperties": false,
  "description": "Details of the scope of the default sharing for new filters and dashboards.",
  "required": [
    "scope"
  ],
  "properties": {
    "scope": {
      "enum": [
        "GLOBAL",
        "AUTHENTICATED",
        "PRIVATE"
      ],
      "type": "string",
      "description": "The scope of the default sharing for new filters and dashboards:\n\n *  `AUTHENTICATED` Shared with all logged-in users.\n *  `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response.\n *  `PRIVATE` Not shared with any users."
    }
  },
  "title": "DefaultShareScope"
}

AddFieldBean

{
  "required": [
    "fieldId"
  ],
  "properties": {
    "fieldId": {
      "type": "string",
      "description": "The ID of the field to add."
    }
  },
  "type": "object",
  "additionalProperties": false,
  "title": "AddFieldBean"
}

BulkPermissionsRequestBean

{
  "properties": {
    "projectPermissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkProjectPermissions"
      },
      "uniqueItems": true,
      "description": "Project permissions with associated projects and issues to look up."
    },
    "globalPermissions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Global permissions to look up.",
      "uniqueItems": true
    }
  },
  "description": "Details of global permissions to look up and project permissions with associated projects and issues to look up.",
  "additionalProperties": false,
  "type": "object",
  "title": "BulkPermissionsRequestBean"
}

AttachmentArchiveEntry

{
  "properties": {
    "size": {
      "type": "integer",
      "format": "int64"
    },
    "name": {
      "type": "string"
    },
    "entryIndex": {
      "format": "int64",
      "type": "integer"
    },
    "abbreviatedName": {
      "type": "string"
    },
    "mediaType": {
      "type": "string"
    }
  },
  "type": "object",
  "additionalProperties": false
}

JqlQuery

{
  "properties": {
    "where": {
      "$ref": "#/components/schemas/JqlQueryClause"
    },
    "orderBy": {
      "$ref": "#/components/schemas/JqlQueryOrderByClause"
    }
  },
  "type": "object",
  "additionalProperties": false,
  "description": "A parsed JQL query."
}

HierarchyOutputFragment

{
  "properties": {
    "hierarchy": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/HierarchyLevelOutput"
      }
    },
    "projectId": {
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object",
  "additionalProperties": false
}

SimpleLink

{
  "type": "object",
  "xml": {
    "name": "link"
  },
  "additionalProperties": false,
  "description": "Details about the operations available in this version.",
  "properties": {
    "href": {
      "type": "string"
    },
    "weight": {
      "type": "integer",
      "format": "int32"
    },
    "title": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "styleClass": {
      "type": "string"
    },
    "iconClass": {
      "type": "string"
    }
  }
}

VersionMoveBean

{
  "properties": {
    "position": {
      "description": "An absolute position in which to place the moved version. Cannot be used with `after`.",
      "type": "string",
      "enum": [
        "Earlier",
        "Later",
        "First",
        "Last"
      ]
    },
    "after": {
      "type": "string",
      "description": "The URL (self link) of the version after which to place the moved version. Cannot be used with `position`.",
      "format": "uri"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "xml": {
    "name": "version"
  },
  "title": "VersionMoveBean"
}

UserBean

{
  "properties": {
    "accountId": {
      "description": "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
      "type": "string"
    },
    "self": {
      "type": "string",
      "description": "The URL of the user.",
      "format": "uri"
    },
    "avatarUrls": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBeanAvatarUrls"
        }
      ],
      "description": "The avatars of the user."
    },
    "name": {
      "description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.  \nThe username of the user.",
      "type": "string"
    },
    "key": {
      "type": "string",
      "description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.  \nThe key of the user."
    },
    "displayName": {
      "description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
      "type": "string"
    },
    "active": {
      "description": "Indicates whether the user is active.",
      "type": "boolean"
    }
  },
  "type": "object",
  "additionalProperties": false
}

RemoteObject

{
  "description": "The linked item.",
  "additionalProperties": true,
  "type": "object",
  "properties": {
    "url": {
      "description": "The URL of the item.",
      "type": "string"
    },
    "icon": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Icon"
        }
      ],
      "description": "Details of the icon for the item. If no icon is defined, the default link icon is used in Jira."
    },
    "summary": {
      "type": "string",
      "description": "The summary details of the item."
    },
    "status": {
      "description": "The status of the item.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Status"
        }
      ]
    },
    "title": {
      "type": "string",
      "description": "The title of the item."
    }
  },
  "required": [
    "title",
    "url"
  ]
}

FieldValueClause

{
  "properties": {
    "field": {
      "$ref": "#/components/schemas/JqlQueryField"
    },
    "operator": {
      "description": "The operator between the field and operand.",
      "type": "string"
    },
    "operand": {
      "$ref": "#/components/schemas/JqlQueryClauseOperand"
    }
  },
  "required": [
    "field",
    "operand",
    "operator"
  ],
  "description": "A clause that asserts the current value of a field. For example, `summary ~ test`.",
  "type": "object"
}

ProjectRoleActorsUpdateBean

{
  "properties": {
    "categorisedActors": {
      "description": "The actors to add to the project role. Add groups using `atlassian-group-role-actor` and a list of group names. For example, `\"atlassian-group-role-actor\":[\"another\",\"administrators\"]}`. Add users using `atlassian-user-role-actor` and a list of account IDs. For example, `\"atlassian-user-role-actor\":[\"12345678-9abc-def1-2345-6789abcdef12\", \"abcdef12-3456-789a-bcde-f123456789ab\"]`.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.",
      "readOnly": true,
      "format": "int64",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "xml": {
    "name": "actor"
  },
  "type": "object",
  "title": "ProjectRoleActorsUpdateBean"
}

WorkflowStatusProperties

{
  "properties": {
    "issueEditable": {
      "type": "boolean",
      "description": "Whether issues are editable in this status."
    }
  },
  "required": [
    "issueEditable"
  ],
  "additionalProperties": false,
  "description": "Properties of a workflow status.",
  "type": "object"
}

AutoCompleteSuggestion

{
  "description": "A field auto-complete suggestion.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The value of a suggested item."
    },
    "displayName": {
      "description": "The display name of a suggested item. If `fieldValue` or `predicateValue` are provided, the matching text is highlighted with the HTML bold tag.",
      "type": "string"
    }
  }
}

Comment

{
  "type": "object",
  "description": "A comment.",
  "additionalProperties": true,
  "properties": {
    "updateAuthor": {
      "description": "The ID of the user who updated the comment last.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ]
    },
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "The ID of the comment."
    },
    "properties": {
      "items": {
        "$ref": "#/components/schemas/EntityProperty"
      },
      "description": "A list of comment properties. Optional on create and update.",
      "type": "array"
    },
    "updated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The date and time at which the comment was updated last."
    },
    "visibility": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Visibility"
        }
      ],
      "description": "The group or role to which this comment is visible. Optional on create and update."
    },
    "body": {
      "description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."
    },
    "self": {
      "readOnly": true,
      "description": "The URL of the comment.",
      "type": "string"
    },
    "renderedBody": {
      "type": "string",
      "readOnly": true,
      "description": "The rendered version of the comment."
    },
    "jsdPublic": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation."
    },
    "created": {
      "description": "The date and time at which the comment was created.",
      "readOnly": true,
      "format": "date-time",
      "type": "string"
    },
    "author": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ],
      "readOnly": true,
      "description": "The ID of the user who created the comment."
    }
  },
  "title": "Comment"
}

ApplicationProperty

{
  "description": "Details of an application property.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The data type of the application property."
    },
    "name": {
      "type": "string",
      "description": "The name of the application property."
    },
    "key": {
      "description": "The key of the application property. The ID and key are the same.",
      "type": "string"
    },
    "defaultValue": {
      "type": "string",
      "description": "The default value of the application property."
    },
    "desc": {
      "type": "string",
      "description": "The description of the application property."
    },
    "id": {
      "type": "string",
      "description": "The ID of the application property. The ID and key are the same."
    },
    "value": {
      "type": "string",
      "description": "The new value."
    },
    "example": {
      "type": "string"
    },
    "allowedValues": {
      "type": "array",
      "description": "The allowed values, if applicable.",
      "items": {
        "type": "string"
      }
    }
  }
}

CompoundClause

{
  "description": "A JQL query clause that consists of nested clauses. For example, `(labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator precedence. For example, \"A OR B AND C\" is parsed as \"(A OR B) AND C\". See Setting the precedence of operators for more information about precedence in JQL queries.`",
  "type": "object",
  "properties": {
    "operator": {
      "description": "The operator between the clauses.",
      "type": "string",
      "enum": [
        "and",
        "or",
        "not"
      ]
    },
    "clauses": {
      "type": "array",
      "description": "The list of nested clauses.",
      "items": {
        "$ref": "#/components/schemas/JqlQueryClause"
      }
    }
  },
  "required": [
    "clauses",
    "operator"
  ]
}

Avatar

{
  "type": "object",
  "additionalProperties": false,
  "description": "Details of an avatar.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the avatar. Required when setting the project avatar."
    },
    "fileName": {
      "type": "string",
      "description": "The file name of the avatar icon. Returned for system avatars.",
      "readOnly": true
    },
    "urls": {
      "type": "object",
      "readOnly": true,
      "description": "The list of avatar icon URLs.",
      "additionalProperties": {
        "type": "string",
        "readOnly": true,
        "format": "uri"
      }
    },
    "isSystemAvatar": {
      "description": "Indicates whether the avatar is a system avatar.",
      "readOnly": true,
      "type": "boolean"
    },
    "owner": {
      "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the accountId for a user.",
      "readOnly": true,
      "type": "string"
    },
    "isDeletable": {
      "type": "boolean",
      "description": "Indicates whether the avatar can be deleted.",
      "readOnly": true
    },
    "isSelected": {
      "type": "boolean",
      "description": "Indicates whether the avatar is used in Jira. For example, shown as a project's avatar.",
      "readOnly": true
    }
  },
  "title": "Avatar"
}

SearchResults

{
  "description": "The result of a JQL search.",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "warningMessages": {
      "readOnly": true,
      "items": {
        "type": "string",
        "readOnly": true
      },
      "description": "Any warnings related to the JQL query.",
      "type": "array"
    },
    "expand": {
      "description": "Expand options that include additional search result details in the response.",
      "readOnly": true,
      "type": "string"
    },
    "startAt": {
      "format": "int32",
      "readOnly": true,
      "description": "The index of the first item returned on the page.",
      "type": "integer"
    },
    "names": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "readOnly": true,
        "type": "string"
      },
      "description": "The ID and name of each field in the search results."
    },
    "schema": {
      "type": "object",
      "readOnly": true,
      "description": "The schema describing the field types in the search results.",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonTypeBean"
      }
    },
    "maxResults": {
      "format": "int32",
      "readOnly": true,
      "description": "The maximum number of results that could be on the page.",
      "type": "integer"
    },
    "issues": {
      "type": "array",
      "readOnly": true,
      "description": "The list of issues found by the search.",
      "items": {
        "$ref": "#/components/schemas/IssueBean"
      }
    },
    "total": {
      "type": "integer",
      "description": "The number of results on the page.",
      "format": "int32",
      "readOnly": true
    }
  }
}

bodies_setIssueNavigatorDefaultColumns

{
  "type": "array",
  "items": {
    "type": "string"
  }
}

bodies_addWatcher

{
  "type": "string"
}

bodies_setWorklogProperty

{}

bodies_setColumns

{
  "type": "array",
  "items": {
    "type": "string"
  }
}

bodies_setPreference

{
  "type": "string"
}

bodies_setProjectProperty

{}

bodies_setIssueProperty

{}

bodies_putAddonProperty

{}

bodies_setIssueTypeProperty

{}

bodies_storeAvatar

{}

bodies_setUserColumns

{
  "items": {
    "type": "string"
  },
  "type": "array"
}

bodies_setDashboardItemProperty

{}

bodies_setUserProperty

{}

bodies_addAttachment

{
  "type": "string",
  "format": "binary"
}

bodies_createProjectAvatar

{}

bodies_createIssueTypeAvatar

{}

bodies_setCommentProperty

{}