@managed-api/jira-cloud-v3-stitch-it NPM

ScriptRunner Connect Managed API for Jira Cloud

Managed API for Jira Cloud is an API Client for Jira Cloud by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

fetch
Application
- Role
  - getRole
  - getRoles
Avatar
Dashboard
Filter
- createFilter
- deleteFilter
- getFilter
- getMyFilters
- searchFilters
- updateFilter
- Column
- Favourite
- Share
  - getDefaultScope
  - setDefaultScope
  - Permission
Group
GroupAndUserPicker
- findUsersAndGroups
Instance
Issue
- assignIssue
- createIssue
- createIssues
- deleteIssue
- editIssue
- getChangeLogs
- getChangeLogsById
- getIssue
- sendNotification
- Attachment
  - addAttachments
  - deleteAttachment
  - Metadata
- Comment
  - addComment
  - deleteComment
  - getComment
  - getComments
  - getCommentsByIds
  - updateComment
  - Property
- Field
  - getContexts
  - getFields
  - getFieldsPaginated
  - Configuration
  - Custom
- Link
  - createLink
  - deleteLink
  - getLink
  - Remote
  - Type
- Metadata
  - getCreateMetadata
  - getEditMetadata
- Navigator
  - getDefaultColumns
  - setDefaultColumns
- Notification
  - Scheme
    - getScheme
    - getSchemes
- Priority
  - getPriorities
  - getPriority
  - searchPriorities
- Property
  - deleteProperty
  - getKeys
  - getProperty
  - setProperty
- Resolution
  - getResolution
  - getResolutions
- Search
  - checkAgainstJql
  - searchByJql
- Security
  - getLevel
  - getMembers
  - Scheme
    - getScheme
    - getSchemes
- Transition
  - getTransitions
  - performTransition
- Type
  - createType
  - deleteType
  - getAlternativeTypes
  - getType
  - getTypesForProject
  - getTypesForUser
  - loadTypeAvatar
  - updateType
  - Property
  - Scheme
  - Screen
    - Scheme
- Vote
  - addVote
  - deleteVote
  - getVotes
- Watcher
  - addWatcher
  - deleteWatcher
  - getWatchers
- Worklog
  - addWorklog
  - deleteWorklog
  - getDeletedIds
  - getFromIds
  - getUpdatedIds
  - getWorklog
  - getWorklogs
  - updateWorklog
  - Property
Jql
Label
- getLabels
Myself
Permission
Project
- createProject
- deleteProject
- deleteProjectAsync
- getProject
- getProjects
- getStatuses
- restoreDeletedProject
- updateProject
- Avatar
  - deleteAvatar
  - getAvatars
  - loadAvatar
  - setAvatar
- Category
  - createCategory
  - deleteCategory
  - getCategories
  - getCategory
  - updateCategory
- Component
  - createComponent
  - deleteComponent
  - getComponent
  - getComponents
  - getComponentsPaginated
  - getIssueCount
  - updateComponent
- IssueType
  - getHierarchy
- Notification
  - Scheme
    - getScheme
- Permission
  - Scheme
- Property
  - deleteProperty
  - getProperty
  - getPropertyKeys
  - setProperty
- Role
  - createRole
  - deleteRole
  - fullyUpdateRole
  - getDetails
  - getRole
  - getRoleForProject
  - getRoles
  - getRolesForProject
  - partiallyUpdateRole
  - Actor
    - addActors
    - deleteActors
    - setActors
    - Default
- Security
  - Scheme
    - getIssueScheme
- Type
  - getAccessibleTypeByKey
  - getLicensedTypes
  - getTypeByKey
  - getTypes
- Validation
  - getValidProjectKey
  - getValidProjectName
  - validateProjectKey
- Version
  - createVersion
  - deleteAndReplaceVersion
  - getVersion
  - getVersions
  - getVersionsPaginated
  - mergeVersions
  - moveVersion
  - updateVersion
  - Count
    - getRelatedIssueCount
    - getUnresolvedIssueCount
Screen
User
Workflow

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { JiraCloudApi } from '@managed-api/jira-cloud-v3-sr-connect';

export default async function() {
    const api = new JiraCloudApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

1.0.0

Added support to pass key property for project field, name property for issuetype, fixVersions, priority, versions, resolution fields for the following methods:
- Create issue that can be used as Issue.createIssue or All.createIssue.
- Bulk create issue that can be used as Issue.createIssues or All.createIssues.
- Edit issue that can be used as Issue.editIssue or All.editIssue.

0.22.0

Custom fields can be added to field object in following Issue methods:
- Create issue that can be used as Issue.createIssue or All.createIssue.
- Bulk create issue that can be used as Issue.createIssues or All.createIssues.
- Edit issue that can be used as Issue.editIssue or All.editIssue.

0.21.0

Updated OpenApi Specification

0.20.0

Added support for the following Issue.Priority method:
- Search priorities that can be used as Issue.Priority.searchPriorities or All.searchIssuePriorities.
The following methods are no longer deprecated:
- Get notification scheme that can be used as Issue.Notification.Scheme.getScheme or All.getIssueNotificationScheme.
- Get resolution that can be used as Issue.Resolution.getResolution or All.getIssueResolution.
- Get priority that can be used as Issue.Priority.getPriority or All.getIssuePriority.

0.18.0

The following methods are deprecated:
- Get priorities that can be used as Issue.Priority.getPriorities or All.getIssuePriorities.
- Get priority that can be used as Issue.Priority.getPriority or All.getIssuePriority.
- Get resolutions that can be used as Issue.Resolution.getResolutions or All.getIssueResolutions.
- Get resolution that can be used as Issue.Resolution.getResolution or All.getIssueResolution.
- Get notification scheme that can be used as Issue.Notification.Scheme.getScheme or All.getIssueNotificationScheme.
- Get project notification scheme that can be used as Project.Notification.Scheme.getScheme or All.getProjectNotificationScheme.