3.0.0 • Published 5 years ago

@datafire/jira_local v3.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/jira_local

Client library for JIRA 7.6.1

Installation and Usage

npm install --save @datafire/jira_local
let jira_local = require('@datafire/jira_local').create();

.then(data => {
  console.log(data);
});

Description

Actions

api.2.application_properties.get

Returns an application property.

jira_local.api.2.application_properties.get({}, context)

Input

  • input object
    • key string: a String containing the property key
    • permissionLevel string: when fetching a list specifies the permission level of all items in the list
    • keyFilter string: when fetching a list allows the list to be filtered by the property's start of key

Output

Output schema unknown

getAdvancedSettings

Returns the properties that are displayed on the "General Configuration > Advanced Settings" page.

jira_local.getAdvancedSettings(null, context)

Input

This action has no parameters

Output

Output schema unknown

setPropertyViaRestfulTable

Modify an application property via PUT. The "value" field present in the PUT will override the existing value.

jira_local.setPropertyViaRestfulTable({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

getAll

Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the collection of ApplicationRoles.

jira_local.getAll(null, context)

Input

This action has no parameters

Output

Output schema unknown

putBulk

Updates the ApplicationRoles with the passed data if the version hash is the same as the server. Only the groups and default groups setting of the role may be updated. Requests to change the key or the name of the role will be silently ignored. It is acceptable to pass only the roles that are updated as roles that are present in the server but not in data to update with, will not be deleted.

jira_local.putBulk({}, context)

Input

  • input object
    • If-Match string

Output

Output schema unknown

get

Returns the ApplicationRole with passed key if it exists.

jira_local.get({
  "key": ""
}, context)

Input

  • input object
    • key required string: the key of the role to update.

Output

Output schema unknown

put

Updates the ApplicationRole with the passed data. Only the groups and default groups setting of the role may be updated. Requests to change the key or the name of the role will be silently ignored.

jira_local.put({
  "key": ""
}, context)

Input

  • input object
    • If-Match string: the hash of the version to update. Optional Param
    • key required string: the key of the role to update.

Output

Output schema unknown

getAttachmentMeta

Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size allowed.

jira_local.getAttachmentMeta(null, context)

Input

This action has no parameters

Output

Output schema unknown

removeAttachment

Remove an attachment from an issue.

jira_local.removeAttachment({
  "id": ""
}, context)

Input

  • input object
    • id required string: id of the attachment to remove

Output

Output schema unknown

getAttachment

Returns the meta-data for an attachment, including the URI of the actual attached file.

jira_local.getAttachment({
  "id": ""
}, context)

Input

  • input object
    • id required string: id of the attachment to remove

Output

Output schema unknown

expandForHumans

Tries to expand an attachment. Output is human-readable and subject to change.

jira_local.expandForHumans({
  "id": ""
}, context)

Input

  • input object
    • id required string: the id of the attachment to expand.

Output

Output schema unknown

expandForMachines

Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time.

jira_local.expandForMachines({
  "id": ""
}, context)

Input

  • input object
    • id required string: the id of the attachment to expand.

Output

Output schema unknown

getRecords

Returns auditing records filtered using provided parameters

jira_local.getRecords({}, context)

Input

  • input object
    • offset integer: - the number of record from which search starts
    • limit integer: - maximum number of returned results (if is limit is <= 0 or > 1000, it will be set do default value: 1000)
    • filter string: - text query; each record that will be returned must contain the provided text in one of its fields
    • from string: - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty
    • to string: - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty
    • projectIds string: - list of project ids to look for
    • userIds string: - list of user ids to look for

Output

Output schema unknown

addRecord

Store a record in Audit Log

jira_local.addRecord(null, context)

Input

This action has no parameters

Output

Output schema unknown

getAllSystemAvatars

Returns all system avatars of the given type.

jira_local.getAllSystemAvatars({
  "type": ""
}, context)

Input

  • input object
    • type required string: the avatar type

Output

Output schema unknown

storeTemporaryAvatar

Creates temporary avatar

jira_local.storeTemporaryAvatar({
  "type": ""
}, context)

Input

  • input object
    • filename string: name of file being uploaded
    • size integer: size of file
    • type required string: the avatar type

Output

Output schema unknown

api.2.avatar.type.temporaryCrop.post

Updates the cropping instructions of the temporary avatar.

jira_local.api.2.avatar.type.temporaryCrop.post({
  "type": ""
}, context)

Input

  • input object
    • type required string: the avatar type

Output

Output schema unknown

approveUpgrade

jira_local.approveUpgrade(null, context)

Input

This action has no parameters

Output

Output schema unknown

cancelUpgrade

jira_local.cancelUpgrade(null, context)

Input

This action has no parameters

Output

Output schema unknown

acknowledgeErrors

jira_local.acknowledgeErrors(null, context)

Input

This action has no parameters

Output

Output schema unknown

setReadyToUpgrade

jira_local.setReadyToUpgrade(null, context)

Input

This action has no parameters

Output

Output schema unknown

getState

jira_local.getState(null, context)

Input

This action has no parameters

Output

Output schema unknown

api.2.comment.commentId.properties.get

Returns the keys of all properties for the comment identified by the key or by the id.

jira_local.api.2.comment.commentId.properties.get({
  "commentId": ""
}, context)

Input

  • input object
    • commentId required string: the comment from which keys will be returned.

Output

Output schema unknown

api.2.comment.commentId.properties.propertyKey.delete

Removes the property from the comment identified by the key or by the id. Ths user removing the property is required to have permissions to administer the comment.

jira_local.api.2.comment.commentId.properties.propertyKey.delete({
  "commentId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • commentId required string: the comment from which keys will be returned.
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

api.2.comment.commentId.properties.propertyKey.get

Returns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves the property is required to have permissions to read the comment.

jira_local.api.2.comment.commentId.properties.propertyKey.get({
  "commentId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • commentId required string: the comment from which keys will be returned.
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

api.2.comment.commentId.properties.propertyKey.put

Sets the value of the specified comment's property.

jira_local.api.2.comment.commentId.properties.propertyKey.put({
  "commentId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • commentId required string: the comment from which keys will be returned.
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

createComponent

Create a component via POST.

jira_local.createComponent(null, context)

Input

This action has no parameters

Output

Output schema unknown

api.2.component.id.delete

Delete a project component.

jira_local.api.2.component.id.delete({
  "id": ""
}, context)

Input

  • input object
    • moveIssuesTo string: The new component applied to issues whose 'id' component will be deleted.
    • id required string: The component to delete.

Output

Output schema unknown

getComponent

Returns a project component.

jira_local.getComponent({
  "id": ""
}, context)

Input

  • input object
    • id required string: The component to delete.

Output

Output schema unknown

updateComponent

Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

jira_local.updateComponent({
  "id": ""
}, context)

Input

  • input object
    • id required string: The component to delete.

Output

Output schema unknown

getComponentRelatedIssues

Returns counts of issues related to this component.

jira_local.getComponentRelatedIssues({
  "id": ""
}, context)

Input

  • input object
    • id required string: a String containing the component id

Output

Output schema unknown

getConfiguration

Returns the information if the optional features in JIRA are enabled or disabled. If the time tracking is enabled, it also returns the detailed information about time tracking configuration.

jira_local.getConfiguration(null, context)

Input

This action has no parameters

Output

Output schema unknown

getCustomFieldOption

Returns a full representation of the Custom Field Option that has the given id.

jira_local.getCustomFieldOption({
  "id": ""
}, context)

Input

  • input object
    • id required string: a String containing an Custom Field Option id

Output

Output schema unknown

list

Returns a list of all dashboards, optionally filtering them.

jira_local.list({}, context)

Input

  • input object
    • filter string: an optional filter that is applied to the list of dashboards. Valid values include
    • startAt integer: the index of the first dashboard to return (0-based). must be 0 or a multiple of
    • maxResults integer: a hint as to the the maximum number of dashboards to return in each call. Note that the

Output

Output schema unknown

api.2.dashboard.dashboardId.items.itemId.properties.get

Returns the keys of all properties for the dashboard item identified by the id.

jira_local.api.2.dashboard.dashboardId.items.itemId.properties.get({
  "itemId": "",
  "dashboardId": ""
}, context)

Input

  • input object
    • itemId required string: the dashboard item from which keys will be returned.
    • dashboardId required string

Output

Output schema unknown

api.2.dashboard.dashboardId.items.itemId.properties.propertyKey.delete

Removes the property from the dashboard item identified by the key or by the id. Ths user removing the property is required to have permissions to administer the dashboard item.

jira_local.api.2.dashboard.dashboardId.items.itemId.properties.propertyKey.delete({
  "itemId": "",
  "dashboardId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • itemId required string: the dashboard item from which keys will be returned.
    • dashboardId required string
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

api.2.dashboard.dashboardId.items.itemId.properties.propertyKey.get

Returns the value of the property with a given key from the dashboard item identified by the id. The user who retrieves the property is required to have permissions to read the dashboard item.

jira_local.api.2.dashboard.dashboardId.items.itemId.properties.propertyKey.get({
  "itemId": "",
  "dashboardId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • itemId required string: the dashboard item from which keys will be returned.
    • dashboardId required string
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

api.2.dashboard.dashboardId.items.itemId.properties.propertyKey.put

Sets the value of the specified dashboard item's property.

jira_local.api.2.dashboard.dashboardId.items.itemId.properties.propertyKey.put({
  "itemId": "",
  "dashboardId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • itemId required string: the dashboard item from which keys will be returned.
    • dashboardId required string
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

getDashboard

Returns a single dashboard.

jira_local.getDashboard({
  "id": ""
}, context)

Input

  • input object
    • id required string: the dashboard id

Output

Output schema unknown

getFields

Returns a list of all fields, both System and Custom

jira_local.getFields(null, context)

Input

This action has no parameters

Output

Output schema unknown

createCustomField

Creates a custom field using a definition (object encapsulating custom field data)

jira_local.createCustomField(null, context)

Input

This action has no parameters

Output

Output schema unknown

createFilter

Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions

jira_local.createFilter({}, context)

Input

  • input object
    • expand string: the parameters to expand

Output

Output schema unknown

getDefaultShareScope

Returns the default share scope of the logged-in user.

jira_local.getDefaultShareScope(null, context)

Input

This action has no parameters

Output

Output schema unknown

setDefaultShareScope

Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE.

jira_local.setDefaultShareScope(null, context)

Input

This action has no parameters

Output

Output schema unknown

getFavouriteFilters

Returns the favourite filters of the logged-in user.

jira_local.getFavouriteFilters({}, context)

Input

  • input object
    • expand string: the parameters to expand
    • enableSharedUsers boolean: enable calculating shared users collection

Output

Output schema unknown

deleteFilter

Delete a filter.

jira_local.deleteFilter({
  "id": 0
}, context)

Input

  • input object
    • id required integer: the id of the filter being looked up

Output

Output schema unknown

getFilter

Returns a filter given an id

jira_local.getFilter({
  "id": 0
}, context)

Input

  • input object
    • expand string: the parameters to expand
    • enableSharedUsers boolean: enable calculating shared users collection
    • id required integer: the id of the filter being looked up

Output

Output schema unknown

editFilter

Updates an existing filter, and returns its new value.

jira_local.editFilter({
  "id": 0
}, context)

Input

  • input object
    • expand string: the parameters to expand
    • id required integer: the id of the filter being looked up

Output

Output schema unknown

api.2.filter.id.columns.delete

Resets the columns for the given filter such that the filter no longer has its own column config.

jira_local.api.2.filter.id.columns.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: id of the filter

Output

Output schema unknown

api.2.filter.id.columns.get

Returns the default columns for the given filter. Currently logged in user will be used as the user making such request.

jira_local.api.2.filter.id.columns.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: id of the filter

Output

Output schema unknown

api.2.filter.id.columns.put

Sets the default columns for the given filter.

jira_local.api.2.filter.id.columns.put({
  "id": 0
}, context)

Input

  • input object
    • id required integer: id of the filter

Output

Output schema unknown

getSharePermissions

Returns all share permissions of the given filter.

jira_local.getSharePermissions({
  "id": 0
}, context)

Input

  • input object
    • id required integer

Output

Output schema unknown

addSharePermission

Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter.

jira_local.addSharePermission({
  "id": 0
}, context)

Input

  • input object
    • id required integer

Output

Output schema unknown

deleteSharePermission

Removes a share permissions from the given filter.

jira_local.deleteSharePermission({
  "id": 0,
  "permission-id": 0
}, context)

Input

  • input object
    • id required integer
    • permission-id required integer

Output

Output schema unknown

getSharePermission

Returns a single share permission of the given filter.

jira_local.getSharePermission({
  "permissionId": 0,
  "id": 0
}, context)

Input

  • input object
    • permissionId required integer
    • id required integer

Output

Output schema unknown

removeGroup

Deletes a group by given group parameter.

jira_local.removeGroup({}, context)

Input

  • input object
    • groupname string: (mandatory) The name of the group to delete.
    • swapGroup string: If you delete a group and content is restricted to that group, the content will be hidden from all users.

Output

Output schema unknown

getGroup

Returns REST representation for the requested group. Allows to get list of active users belonging to the specified group and its subgroups if "users" expand option is provided. You can page through users list by using indexes in expand param. For example to get users from index 10 to index 15 use "users10:15" expand value. This will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.

jira_local.getGroup({}, context)

Input

  • input object
    • groupname string: A name of requested group.
    • expand string: List of fields to expand. Currently only available expand is "users".

Output

Output schema unknown

createGroup

Creates a group by given group parameter

jira_local.createGroup(null, context)

Input

This action has no parameters

Output

Output schema unknown

getUsersFromGroup

This resource returns a paginated list of users who are members of the specified group and its subgroups. Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions.

jira_local.getUsersFromGroup({}, context)

Input

  • input object
    • groupname string: a name of the group for which members will be returned.
    • includeInactiveUsers boolean: inactive users will be included in the response if set to true.
    • startAt integer: the index of the first user in group to return (0 based).
    • maxResults integer: the maximum number of users to return (max 50).

Output

Output schema unknown

removeUserFromGroup

Removes given user from a group.

jira_local.removeUserFromGroup({}, context)

Input

  • input object
    • groupname string: A name of requested group.
    • username string: User to remove from a group

Output

Output schema unknown

addUserToGroup

Adds given user to a group.

jira_local.addUserToGroup({}, context)

Input

  • input object
    • groupname string: A name of requested group.

Output

Output schema unknown

findGroups

Returns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker suggestions. The groups are also wrapped in a single response object that also contains a header for use in the picker, specifically Showing X of Y matching groups.

jira_local.findGroups({}, context)

Input

  • input object
    • query string: a String to match groups agains
    • exclude string
    • maxResults integer
    • userName string

Output

Output schema unknown

findUsersAndGroups

Returns a list of users and groups matching query with highlighting. This resource cannot be accessed anonymously.

jira_local.findUsersAndGroups({}, context)

Input

  • input object
    • query string: A string used to search username, Name or e-mail address
    • maxResults integer: the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If
    • showAvatar boolean
    • fieldId string: The custom field id, if this request comes from a custom field, such as a user picker. Optional.
    • projectId string: The list of project ids to further restrict the search
    • issueTypeId string: The list of issue type ids to further restrict the search.

Output

Output schema unknown

getIndexSummary

Summarizes index condition of current node.

jira_local.getIndexSummary(null, context)

Input

This action has no parameters

Output

Output schema unknown

createIssue

Creates an issue or a sub-task from a JSON representation.

jira_local.createIssue(null, context)

Input

This action has no parameters

Output

Output schema unknown

createIssues

Creates issues or sub-tasks from a JSON representation.

jira_local.createIssues(null, context)

Input

This action has no parameters

Output

Output schema unknown

getCreateIssueMeta

Returns the meta data for creating issues. This includes the available projects, issue types and fields, including field types and whether or not those fields are required. Projects will not be returned if the user does not have permission to create issues in that project.

jira_local.getCreateIssueMeta({}, context)

Input

  • input object
    • projectIds string: combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned.
    • projectKeys string: combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned.
    • issuetypeIds string: combinded with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned.
    • issuetypeNames string: combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned.

Output

Output schema unknown

getIssuePickerResource

Returns suggested issues which match the auto-completion query for the user which executes this request. This REST method will check the user's history and the user's browsing context and select this issues, which match the query.

jira_local.getIssuePickerResource({}, context)

Input

  • input object
    • query string: the query.
    • currentJQL string: the JQL in context of which the request is executed. Only issues which match this JQL query will be included in results.
    • currentIssueKey string: the key of the issue in context of which the request is executed. The issue which is in context will not be included in the auto-completion result, even if it matches the query.
    • currentProjectId string: the id of the project in context of which the request is executed. Suggested issues will be only from this project.
    • showSubTasks boolean: if set to false, subtasks will not be included in the list.
    • showSubTaskParent boolean: if set to false and request is executed in context of a subtask, the parent issue will not be included in the auto-completion result, even if it matches the query.

Output

Output schema unknown

deleteIssue

Delete an issue.

jira_local.deleteIssue({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • deleteSubtasks string: a String of true or false indicating that any subtasks should also be deleted. If the
    • issueIdOrKey required string: the issue id or key to update (i.e. JRA-1330)

Output

Output schema unknown

getIssue

Returns a full representation of the issue for the given issue key.

jira_local.getIssue({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • fields string: the list of fields to return for the issue. By default, all fields are returned.
    • expand string
    • properties string: the list of properties to return for the issue. By default no properties are returned.
    • issueIdOrKey required string: the issue id or key to update (i.e. JRA-1330)

Output

Output schema unknown

editIssue

Edits an issue from a JSON representation.

jira_local.editIssue({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • notifyUsers boolean: send the email with notification that the issue was updated to users that watch it.
    • issueIdOrKey required string: the issue id or key to update (i.e. JRA-1330)

Output

Output schema unknown

assign

Assigns an issue to a user. You can use this resource to assign issues when the user submitting the request has the assign permission but not the edit issue permission. If the name is "-1" automatic assignee is used. A null name will remove the assignee.

jira_local.assign({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: a String containing an issue key

Output

Output schema unknown

addAttachment

Add one or more attachments to an issue.

jira_local.addAttachment({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue that you want to add the attachments to

Output

Output schema unknown

getComments

Returns all comments for an issue.

jira_local.getComments({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • startAt integer: the page offset, if not specified then defaults to 0
    • maxResults integer: how many results on the page should be included. Defaults to 50.
    • orderBy string: ordering of the results.
    • expand string: optional flags: renderedBody (provides body rendered in HTML)
    • issueIdOrKey required string: a string containing the issue id or key the comment will be added to

Output

Output schema unknown

addComment

Adds a new comment to an issue.

jira_local.addComment({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • expand string: optional flags: renderedBody (provides body rendered in HTML)
    • issueIdOrKey required string: a string containing the issue id or key the comment will be added to

Output

Output schema unknown

deleteComment

Deletes an existing comment .

jira_local.deleteComment({
  "issueIdOrKey": "",
  "id": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: of the issue the comment belongs to
    • id required string: the ID of the comment to request

Output

Output schema unknown

getComment

Returns a single comment.

jira_local.getComment({
  "issueIdOrKey": "",
  "id": ""
}, context)

Input

  • input object
    • expand string: optional flags: renderedBody (provides body rendered in HTML)
    • issueIdOrKey required string: of the issue the comment belongs to
    • id required string: the ID of the comment to request

Output

Output schema unknown

updateComment

Updates an existing comment using its JSON representation.

jira_local.updateComment({
  "issueIdOrKey": "",
  "id": ""
}, context)

Input

  • input object
    • expand string: optional flags: renderedBody (provides body rendered in HTML)
    • issueIdOrKey required string: of the issue the comment belongs to
    • id required string: the ID of the comment to request

Output

Output schema unknown

getEditIssueMeta

Returns the meta data for editing an issue.

jira_local.getEditIssueMeta({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue whose edit meta data you want to view

Output

Output schema unknown

notify

Sends a notification (email) to the list or recipients defined in the request.

jira_local.notify({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: a string containing the issue id or key the comment will be added to

Output

Output schema unknown

api.2.issue.issueIdOrKey.properties.get

Returns the keys of all properties for the issue identified by the key or by the id.

jira_local.api.2.issue.issueIdOrKey.properties.get({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue from which keys will be returned.

Output

Output schema unknown

api.2.issue.issueIdOrKey.properties.propertyKey.delete

Removes the property from the issue identified by the key or by the id. Ths user removing the property is required to have permissions to edit the issue.

jira_local.api.2.issue.issueIdOrKey.properties.propertyKey.delete({
  "issueIdOrKey": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue from which keys will be returned.
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

api.2.issue.issueIdOrKey.properties.propertyKey.get

Returns the value of the property with a given key from the issue identified by the key or by the id. The user who retrieves the property is required to have permissions to read the issue.

jira_local.api.2.issue.issueIdOrKey.properties.propertyKey.get({
  "issueIdOrKey": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue from which keys will be returned.
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

api.2.issue.issueIdOrKey.properties.propertyKey.put

Sets the value of the specified issue's property.

jira_local.api.2.issue.issueIdOrKey.properties.propertyKey.put({
  "issueIdOrKey": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue from which keys will be returned.
    • propertyKey required string: the key of the property to return.

Output

Output schema unknown

deleteRemoteIssueLinkByGlobalId

Delete the remote issue link with the given global id on the issue.

jira_local.deleteRemoteIssueLinkByGlobalId({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • globalId string: the global id of the remote issue link
    • issueIdOrKey required string: the issue to create the remote issue link for

Output

Output schema unknown

getRemoteIssueLinks

A REST sub-resource representing the remote issue links on the issue.

jira_local.getRemoteIssueLinks({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • globalId string: The id of the remote issue link to be returned. If null (not provided) all remote links for the
    • issueIdOrKey required string: the issue to create the remote issue link for

Output

Output schema unknown

createOrUpdateRemoteIssueLink

Creates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created.

jira_local.createOrUpdateRemoteIssueLink({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue to create the remote issue link for

Output

Output schema unknown

deleteRemoteIssueLinkById

Delete the remote issue link with the given id on the issue.

jira_local.deleteRemoteIssueLinkById({
  "linkId": "",
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • linkId required string: the id of the remote issue link
    • issueIdOrKey required string: the issue to create the remote issue link for

Output

Output schema unknown

getRemoteIssueLinkById

Get the remote issue link with the given id on the issue.

jira_local.getRemoteIssueLinkById({
  "linkId": "",
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • linkId required string: the id of the remote issue link
    • issueIdOrKey required string: the issue to create the remote issue link for

Output

Output schema unknown

updateRemoteIssueLink

Updates a remote issue link from a JSON representation. Any fields not provided are set to null.

jira_local.updateRemoteIssueLink({
  "linkId": "",
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • linkId required string: the id of the remote issue link
    • issueIdOrKey required string: the issue to create the remote issue link for

Output

Output schema unknown

getSubTasks

Returns an issue's subtask list

jira_local.getSubTasks({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: The parent issue's key or id

Output

Output schema unknown

canMoveSubTask

jira_local.canMoveSubTask({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: The parent issue's key or id

Output

Output schema unknown

moveSubTasks

Reorders an issue's subtasks by moving the subtask at index "from" to index "to".

jira_local.moveSubTasks({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: The parent issue's key or id

Output

Output schema unknown

getTransitions

Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.

jira_local.getTransitions({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • transitionId string
    • issueIdOrKey required string: the issue whose transitions you want to view

Output

Output schema unknown

doTransition

Perform a transition on an issue. When performing the transition you can update or set other issue fields.

jira_local.doTransition({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue whose transitions you want to view

Output

Output schema unknown

removeVote

Remove your vote from an issue. (i.e. "unvote")

jira_local.removeVote({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue to view voting information for

Output

Output schema unknown

getVotes

A REST sub-resource representing the voters on the issue.

jira_local.getVotes({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue to view voting information for

Output

Output schema unknown

addVote

Cast your vote in favour of an issue.

jira_local.addVote({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: the issue to view voting information for

Output

Output schema unknown

removeWatcher

Removes a user from an issue's watcher list.

jira_local.removeWatcher({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • username string: a String containing the name of the user to remove from the watcher list. Must not be null.
    • issueIdOrKey required string: a String containing an issue key.

Output

Output schema unknown

getIssueWatchers

Returns the list of watchers for the issue with the given key.

jira_local.getIssueWatchers({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: a String containing an issue key.

Output

Output schema unknown

addWatcher

Adds a user to an issue's watcher list.

jira_local.addWatcher({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: a String containing an issue key.

Output

Output schema unknown

getIssueWorklog

Returns all work logs for an issue. Note: Work logs won't be returned if the Log work field is hidden for the project.

jira_local.getIssueWorklog({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: a string containing the issue id or key the worklog will be added to

Output

Output schema unknown

addWorklog

Adds a new worklog entry to an issue.

jira_local.addWorklog({
  "issueIdOrKey": ""
}, context)

Input

  • input object
    • adjustEstimate string: (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
    • newEstimate string: (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"
    • reduceBy string: (required when "manual" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. "2d"
    • issueIdOrKey required string: a string containing the issue id or key the worklog will be added to

Output

Output schema unknown

deleteWorklog

Deletes an existing worklog entry.

jira_local.deleteWorklog({
  "issueIdOrKey": "",
  "id": ""
}, context)

Input

  • input object
    • adjustEstimate string: (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
    • newEstimate string: (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"
    • increaseBy string: (required when "manual" is selected for adjustEstimate) the amount to increase the remaining estimate by e.g. "2d"
    • issueIdOrKey required string: a string containing the issue id or key the worklog belongs to
    • id required string: id of the worklog to be deleted

Output

Output schema unknown

getWorklog

Returns a specific worklog. Note: The work log won't be returned if the Log work field is hidden for the project.

jira_local.getWorklog({
  "issueIdOrKey": "",
  "id": ""
}, context)

Input

  • input object
    • issueIdOrKey required string: a string containing the issue id or key the worklog belongs to
    • id required string: id of the worklog to be deleted

Output

Output schema unknown

updateWorklog

Updates an existing worklog entry.

jira_local.updateWorklog({
  "issueIdOrKey": "",
  "id": ""
}, context)

Input

  • input object
    • adjustEstimate string: (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
    • newEstimate string: (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field.
    • issueIdOrKey required string: a string containing the issue id or key the worklog belongs to
    • id required string: id of the worklog to be deleted

Output

Output schema unknown

linkIssues

Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issue to the second issue using the outward description. It also create a link from the second issue to the first issue using the inward description of the issue link type. It will add the supplied comment to the first issue. The comment can have a restriction who can view it. If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment. The user who creates the issue link needs to belong to the specified group or have the specified role.

jira_local.linkIssues(null, context)

Input

This action has no parameters

Output

Output schema unknown

deleteIssueLink

Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues.

jira_local.deleteIssueLink({
  "linkId": ""
}, context)

Input

  • input object
    • linkId required string: the issue link id.

Output

Output schema unknown

getIssueLink

Returns an issue link with the specified id.

jira_local.getIssueLink({
  "linkId": ""
}, context)

Input

  • input object
    • linkId required string: the issue link id.

Output

Output schema unknown

getIssueLinkTypes

Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship.

jira_local.getIssueLinkTypes(null, context)

Input

This action has no parameters

Output

Output schema unknown

createIssueLinkType

Create a new issue link type.

jira_local.createIssueLinkType(null, context)

Input

This action has no parameters

Output

Output schema unknown

deleteIssueLinkType

Delete the specified issue link type.

jira_local.deleteIssueLinkType({
  "issueLinkTypeId": ""
}, context)

Input

  • input object
    • issueLinkTypeId required string

Output

Output schema unknown

getIssueLinkType

Returns for a given issue link type id all information about this issue link type.

jira_local.getIssueLinkType({
  "issueLinkTypeId": ""
}, context)

Input

  • input object
    • issueLinkTypeId required string

Output

Output schema unknown

updateIssueLinkType

Update the specified issue link type.

jira_local.updateIssueLinkType({
  "issueLinkTypeId": ""
}, context)

Input

  • input object
    • issueLinkTypeId required string

Output

Output schema unknown

getIssueSecuritySchemes

Returns all issue security schemes that are defined.

jira_local.getIssueSecuritySchemes(null, context)

Input

This action has no parameters

Output

Output schema unknown

api.2.issuesecurityschemes.id.get

Returns the issue security scheme along with that are defined.

jira_local.api.2.issuesecurityschemes.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer

Output

Output schema unknown

getIssueAllTypes

Returns a list of all issue types visible to the user

jira_local.getIssueAllTypes(null, context)

Input

This action has no parameters

Output

Output schema unknown

createIssueType

Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue type scheme.

jira_local.createIssueType(null, context)

Input

This action has no parameters

Output

Output schema unknown

api.2.issuetype.id.delete

Deletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to the alternative issue type specified in the parameter. You can determine the alternative issue types by calling the /rest/api/2/issuetype/{id}/alternatives resource.

jira_local.api.2.issuetype.id.delete({
  "id": ""
}, context)

Input

  • input object
    • alternativeIssueTypeId string: the id of an issue type to which issues associated with the removed issue type will be migrated.
    • id required string: the id of the issue type to update.

Output

Output schema unknown

api.2.issuetype.id.get

Returns a full representation of the issue type that has the given id.

jira_local.api.2.issuetype.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: the id of the issue type to update.

Output

Output schema unknown

updateIssueType

Updates the specified issue type from a JSON representation.

jira_local.updateIssueType({
  "id": ""
}, context)

Input

  • input object
    • id required string: the id of the issue type to update.

Output

Output schema unknown

getAlternativeIssueTypes

Returns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which issues assigned to the given issue type can be migrated. The suitable alternatives are issue types which are assigned to the same workflow, the same field configuration and the same screen scheme.

jira_local.getAlternativeIssueTypes({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

api.2.issuetype.id.avatar.post

Converts temporary avatar into a real avatar

jira_local.api.2.issuetype.id.avatar.post({
  "id": ""
}, context)

Input

  • input object
    • id required string: the id of the issue type, which avatar is updated.

Output

Output schema unknown

api.2.issuetype.id.avatar.temporary.post

Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from which the client parses the JSON from.

jira_local.api.2.issuetype.id.avatar.temporary.post({
  "id": ""
}, context)

Input

  • input object
    • id required string: the id of the issue type, which avatar is updated.

Output

Output schema unknown

getPropertyKeys

Returns the keys of all properties for the issue type identified by the id.

jira_local.getPropertyKeys({
  "issueTypeId": ""
}, context)

Input

  • input object
    • issueTypeId required string: the issue type from which the keys will be returned

Output

Output schema unknown

api.2.issuetype.issueTypeId.properties.propertyKey.delete

Removes the property from the issue type identified by the id. Ths user removing the property is required to have permissions to edit the issue type.

jira_local.api.2.issuetype.issueTypeId.properties.propertyKey.delete({
  "issueTypeId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • issueTypeId required string: the issue type from which the keys will be returned
    • propertyKey required string: the key of the property to return

Output

Output schema unknown

api.2.issuetype.issueTypeId.properties.propertyKey.get

Returns the value of the property with a given key from the issue type identified by the id. The user who retrieves the property is required to have permissions to view the issue type.

jira_local.api.2.issuetype.issueTypeId.properties.propertyKey.get({
  "issueTypeId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • issueTypeId required string: the issue type from which the keys will be returned
    • propertyKey required string: the key of the property to return

Output

Output schema unknown

api.2.issuetype.issueTypeId.properties.propertyKey.put

Sets the value of the specified issue type's property.

jira_local.api.2.issuetype.issueTypeId.properties.propertyKey.put({
  "issueTypeId": "",
  "propertyKey": ""
}, context)

Input

  • input object
    • issueTypeId required string: the issue type from which the keys will be returned
    • propertyKey required string: the key of the property to return

Output

Output schema unknown

getAutoComplete

Returns the auto complete data required for JQL searches.

jira_local.getAutoComplete(null, context)

Input

This action has no parameters

Output

Output schema unknown

getFieldAutoCompleteForQueryString

Returns auto complete suggestions for JQL search.

jira_local.getFieldAutoCompleteForQueryString({}, context)

Input

  • input object
    • fieldName string: the field name for which the suggestions are generated.
    • fieldValue string: the portion of the field value that has already been provided by the user.
    • predicateName string: the predicate for which the suggestions are generated. Suggestions are generated only for: "by", "from" and "to".
    • predicateValue string: the portion of the predicate value that has already been provided by the user.

Output

Output schema unknown

validate

jira_local.validate(null, context)

Input

This action has no parameters

Output

Output schema unknown

areMetricsExposed

jira_local.areMetricsExposed(null, context)

Input

This action has no parameters

Output

Output schema unknown

getAvailableMetrics

jira_local.getAvailableMetrics(null, context)

Input

This action has no parameters

Output

Output schema unknown

start

jira_local.start(null, context)

Input

This action has no parameters

Output

Output schema unknown

stop

jira_local.stop(null, context)

Input

This action has no parameters

Output

Output schema unknown

getPermissions

Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for (projectKey OR projectId OR issueKey OR issueId)

jira_local.getPermissions({}, context)

Input

  • input object
    • projectKey string: - key of project to scope returned permissions for.
    • projectId string: - id of project to scope returned permissions for.
    • issueKey string: - key of the issue to scope returned permissions for.
    • issueId string: - id of the issue to scope returned permissions for.

Output

Output schema unknown

removePreference

Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). If key parameter is not provided or wrong - status code 404. If preference is unset - status code 204.

jira_