@managed-api/jira-on-prem-v8-sr-connect NPM

ScriptRunner Connect Managed API for Jira On-Premises

Managed API for Jira On-Premises is an API Client for Jira On-Premises 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
Dashboard
- getDashboard
- getDashboards
Filter
Group
- createGroup
- removeGroup
- User
Instance
Issue
- assignIssue
- createIssue
- deleteIssue
- editIssue
- getIssue
- sendNotification
- Attachment
  - addAttachment
  - getAttachment
  - removeAttachment
- Comment
  - addComment
  - deleteComment
  - getComments
  - getComment
  - updateComment
  - Property
- Field
  - getFields
  - Custom
    - getFields
    - Option
      - getOption
- Link
  - createLink
  - deleteLink
  - getLink
  - Remote
  - Type
- Metadata
  - getEditMetadata
  - getCreateMetadata
- Notification
  - Scheme
    - getSchemes
    - getScheme
- Priority
  - getPriorities
  - getPriority
  - Scheme
- Property
  - getProperty
  - getPropertyKeys
  - deleteProperty
  - setProperty
- Resolution
  - getResolutions
  - getResolution
- Search
  - searchByJql
- Security
  - Scheme
    - getSchemes
    - getScheme
- Subtask
  - canMoveSubTask
  - getSubTasks
  - moveSubTasks
- Transition
  - getTransitions
  - performTransition
- Type
  - createType
  - deleteType
  - getAlternativeTypes
  - getTypes
  - getType
  - updateType
  - Scheme
- Vote
  - addVote
  - getVotes
  - removeVote
- Watcher
  - addWatcher
  - getWatchers
  - removeWatcher
- Worklog
  - addWorklog
  - deleteWorklog
  - getWorklogs
  - getWorklog
  - getDeletedWorklogIds
  - getWorklogsForIds
  - getUpdatedWorklogIds
  - updateWorklog
Myself
Permission
- getPermissions
- getMyPermissions
- Scheme
  - createScheme
  - deleteScheme
  - getSchemes
  - getScheme
  - updateScheme
  - Attribute
    - getAttribute
  - Grant
Project
- archiveProject
- createProject
- deleteProject
- getComponents
- getProjects
- getProject
- getStatuses
- getVersionsPaginated
- getVersions
- restoreProject
- updateProject
- updateProjectType
- Component
  - createComponent
  - deleteComponent
  - getRelatedIssueCount
  - getComponent
  - updateComponent
- Issue
  - Security
    - Scheme
      - getScheme
- Notification
  - Scheme
    - getScheme
- Permission
  - Scheme
    - getScheme
- Priority
  - Scheme
    - getScheme
- Role
  - getRole
  - getRoles
  - Actor
- Security
  - getLevels
- Type
  - getAccessibleType
  - getTypes
  - getType
- Validation
  - validateProjectKey
- Version
  - createVersion
  - deleteVersion
  - getVersion
  - moveVersion
  - mergeVersion
  - removeAndReplaceVersion
  - updateVersion
  - Count
    - getVersionRelatedIssueCount
    - getVersionUnresolvedIssueCount
  - Remote
Role
- Project
Screen
- getFieldsToAdd
- getScreens
- Field
- Tab
User
Workflow
- getWorkflows
- Scheme
- Status
  - getStatus
  - getStatuses
  - Category
    - getCategories
    - getCategory

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 { JiraOnPremApi } from '@managed-api/jira-on-prem-v8-sr-connect';

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

Contact

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

Changelog

2.0.0
- Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.
1.2.0
- Added support for custom fields in Issue.editIssue.
- Added null type to duedate field.

@stitch-it/runtime @managed-api/commons-core @managed-api/jira-on-prem-v8-core

@everything-registry/sub-chunk-576

1 year ago

1 year ago

2 years ago

2 years ago