fetch-jira
v1.0.148fetch-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, Configuratio