Class: Issue

Issue

new Issue()

Issue

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

addComment(options, callbackopt) → {Promise.<any>}

Adds a new comment to an issue.optional flags: renderedBody (provides body rendered in HTML)

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

expand string

expand optional flags: renderedBody (provides body rendered in HTML)

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

addVote(options, callbackopt) → {Promise.<any>}

Cast your vote in favour of an issue.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

addWatcher(options, callbackopt) → {Promise.<any>}

Adds a user to an issue's watcher list.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

addWorklog(options, callbackopt) → {Promise.<any>}

Adds a new worklog entry to an issue.(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are

                  "new" - sets the estimate to a specific value
                  "leave"- leaves the estimate as is
                  "manual" - specify a specific amount to increase remaining estimate by
                  "auto"- Default option.  Will automatically adjust the value based on the new timeSpent specified on the worklog (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"(required when "manual" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. "2d"
Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

adjustEstimate string

adjustEstimate (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are

                       "new" - sets the estimate to a specific value
                       "leave"- leaves the estimate as is
                       "manual" - specify a specific amount to increase remaining estimate by
                       "auto"- Default option.  Will automatically adjust the value based on the new timeSpent specified on the worklog
newEstimate string

newEstimate (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"

reduceBy string

reduceBy (required when "manual" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. "2d"

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

assign(options, callbackopt) → {Promise.<any>}

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.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

key string

key

name string

name

emailAddress string

emailAddress

avatarUrls string

avatarUrls

displayName string

displayName

active string

active

timeZone string

timeZone

locale string

locale

groups string

groups

applicationRoles string

applicationRoles

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

create(options, callbackopt) → {Promise.<any>}

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

The fields that can be set on create, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/createmeta resource. If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field validation error will occur if it is submitted.

Creating a sub-task is similar to creating a regular issue, with two important differences:

the issueType field must correspond to a sub-task issue type (you can use /issue/createmeta to discover sub-task issue types), and you must provide a parent field in the issue create request containing the id or key of the parent issue.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
transition string

transition

fields string

fields

update string

update

historyMetadata string

historyMetadata

properties string

properties

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

createIssues(options, callbackopt) → {Promise.<any>}

Creates issues or sub-tasks from a JSON representation.

Creates many issues in one bulk operation.

Creating a sub-task is similar to creating a regular issue. More details can be found in createIssue section: IssueResource#createIssue(IssueUpdateBean)}

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueUpdates string

issueUpdates

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

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.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

globalId string

globalId

application string

application

relationship string

relationship

object string

object

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

deleteById(options, callbackopt) → {Promise.<any>}

Delete an issue.

If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an issue without its subtasks also being deleted.a String of true or false indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

deleteSubtasks string

deleteSubtasks a String of true or false indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

deleteComment(options, callbackopt) → {Promise.<any>}

Deletes an existing comment .

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

id string

id

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

deleteRemoteIssueLinkByGlobalId(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

globalId string

globalId the global id of the remote issue link

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

deleteRemoteIssueLinkById(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

linkId string

linkId

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

deleteWorklog(options, callbackopt) → {Promise.<any>}

Deletes an existing worklog entry.(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are

                  "new" - sets the estimate to a specific value
                  "leave"- leaves the estimate as is
                  "manual" - specify a specific amount to increase remaining estimate by
                  "auto"- Default option.  Will automatically adjust the value based on the new timeSpent specified on the worklog (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"(required when "manual" is selected for adjustEstimate) the amount to increase the remaining estimate by e.g. "2d"
Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

id string

id

adjustEstimate string

adjustEstimate (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are

                       "new" - sets the estimate to a specific value
                       "leave"- leaves the estimate as is
                       "manual" - specify a specific amount to increase remaining estimate by
                       "auto"- Default option.  Will automatically adjust the value based on the new timeSpent specified on the worklog
newEstimate string

newEstimate (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"

increaseBy string

increaseBy (required when "manual" is selected for adjustEstimate) the amount to increase the remaining estimate by e.g. "2d"

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

doTransition(options, callbackopt) → {Promise.<any>}

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

The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource. If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field validation error will occur if it is submitted.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

transition string

transition

fields string

fields

update string

update

historyMetadata string

historyMetadata

properties string

properties

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

editIssue(options, callbackopt) → {Promise.<any>}

Edits an issue from a JSON representation.

The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value.

The fields that can be updated, in either the fields parameter or the update parameter, can be determined using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource. If a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field validation error will occur if it is submitted.

Specifying a "field_id": field_value in the "fields" is a shorthand for a "set" operation in the "update" section. Field should appear either in "fields" or "update", not in both.Default: truesend the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

notifyUsers string

notifyUsers Default: truesend the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

findById(options, callbackopt) → {Promise.<any>}

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

An issue JSON consists of the issue key, a collection of fields, a link to the workflow transition sub-resource, and (optionally) the HTML rendered values of any fields that support it (e.g. if wiki syntax is enabled for the description or comments).

The fields param (which can be specified multiple times) gives a comma-separated list of fields to include in the response. This can be used to retrieve a subset of fields. A particular field can be excluded by prefixing it with a minus.

By default, all (all) fields are returned in this get-issue resource. Note: the default is different when doing a jql search -- the default there is just navigable fields (navigable).

all - include all fields navigable - include just navigable fields summary,comment - include just the summary and comments -comment - include everything except comments (the default is all for get-issue) all,-comment - include everything except comments

The {@code properties} param is similar to {@code fields} and specifies a comma-separated list of issue properties to include. Unlike {@code fields}, properties are not included by default. To include them all send {@code ?properties=*all}. You can also include only specified properties or exclude some properties with a minus (-) sign.

{@code all} - include all properties {@code all, -prop1} - include all properties except {@code prop1} {@code prop1, prop1} - include {@code prop1} and {@code prop2} properties

JIRA will attempt to identify the issue by the issueIdOrKey path parameter. This can be an issue id, or an issue key. If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or by looking to see if the issue was moved. In either of these cases, the request will proceed as normal (a 302 or other redirect will not be returned). The issue key contained in the response will indicate the current value of issue's key.

The expand param is used to include, hidden by default, parts of response. This can be used to include:

renderedFields - field values in HTML format names - display name of each field schema - schema for each field which describes a type of the field transitions - all possible transitions for the given issue operations - all possibles operations which may be applied on issue editmeta - information about how each field may be edited. It contains field's schema as well. changelog - history of all changes of the given issue versionedRepresentations - REST representations of all fields. Some field may contain more recent versions. RESET representations are numbered. The greatest number always represents the most recent version. It is recommended that the most recent version is used. version for these fields which provide a more recent REST representation. After including versionedRepresentations "fields" field become hidden. the list of fields to return for the issue. By default, all fields are returned.the list of properties to return for the issue. By default no properties are returned.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

fields string

fields the list of fields to return for the issue. By default, all fields are returned.

expand string

expand

properties string

properties the list of properties to return for the issue. By default no properties are returned.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getComment(options, callbackopt) → {Promise.<any>}

Returns a single comment.optional flags: renderedBody (provides body rendered in HTML)

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

id string

id

expand string

expand optional flags: renderedBody (provides body rendered in HTML)

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getComments(options, callbackopt) → {Promise.<any>}

Returns all comments for an issue.

Results can be ordered by the "created" field which means the date a comment was added. the page offset, if not specified then defaults to 0how many results on the page should be included. Defaults to 50.ordering of the results.optional flags: renderedBody (provides body rendered in HTML)

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

startAt string

startAt the page offset, if not specified then defaults to 0

maxResults string

maxResults how many results on the page should be included. Defaults to 50.

orderBy string

orderBy ordering of the results.

expand string

expand optional flags: renderedBody (provides body rendered in HTML)

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getCreateIssueMeta(options, callbackopt) → {Promise.<any>}

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.

The fields in the createmeta correspond to the fields in the create screen for the project/issuetype. Fields not in the screen will not be in the createmeta.

Fields will only be returned if expand=projects.issuetypes.fields.

The results can be filtered by project and/or issue type, given by the query params.combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.combinded with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying an issue type that does not exist is not an error.combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Specifiying an issue type that does not exist is not an error.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
projectIds string

projectIds combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.

projectKeys string

projectKeys combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.

issuetypeIds string

issuetypeIds combinded with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying an issue type that does not exist is not an error.

issuetypeNames string

issuetypeNames combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Specifiying an issue type that does not exist is not an error.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getEditIssueMeta(options, callbackopt) → {Promise.<any>}

Returns the meta data for editing an issue.

The fields in the editmeta correspond to the fields in the edit screen for the issue. Fields not in the screen will not be in the editmeta.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getIssuePickerResource(options, callbackopt) → {Promise.<any>}

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.the query.the JQL in context of which the request is executed. Only issues which match this JQL query will be included in results.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.the id of the project in context of which the request is executed. Suggested issues will be only from this project.if set to false, subtasks will not be included in the list.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.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
query string

query the query.

currentJQL string

currentJQL the JQL in context of which the request is executed. Only issues which match this JQL query will be included in results.

currentIssueKey string

currentIssueKey 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

currentProjectId the id of the project in context of which the request is executed. Suggested issues will be only from this project.

showSubTasks string

showSubTasks if set to false, subtasks will not be included in the list.

showSubTaskParent string

showSubTaskParent 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.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getIssueWatchers(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getIssueWorklog(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getRemoteIssueLinkById(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

linkId string

linkId

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

A REST sub-resource representing the remote issue links on the issue.The id of the remote issue link to be returned. If null (not provided) all remote links for the issue are returned. For a fullexplanation of Issue Link fields please refer to https://developer.atlassian.com/display/JIRADEV/Fields+in+Remote+Issue+Links

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

globalId string

globalId The id of the remote issue link to be returned. If null (not provided) all remote links for the issue are returned. For a fullexplanation of Issue Link fields please refer to https://developer.atlassian.com/display/JIRADEV/Fields+in+Remote+Issue+Links

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getTransitions(options, callbackopt) → {Promise.<any>}

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

Fields will only be returned if expand=transitions.fields.

The fields in the metadata correspond to the fields in the transition screen for that transition. Fields not in the screen will not be in the metadata.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

transitionId string

transitionId

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getVotes(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getWorklog(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

id string

id

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

notify(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

subject string

subject

textBody string

textBody

htmlBody string

htmlBody

to string

to

restrict string

restrict

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

removeVote(options, callbackopt) → {Promise.<any>}

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

removeWatcher(options, callbackopt) → {Promise.<any>}

Removes a user from an issue's watcher list.a String containing the name of the user to remove from the watcher list. Must not be null.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

username string

username a String containing the name of the user to remove from the watcher list. Must not be null.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

updateComment(options, callbackopt) → {Promise.<any>}

Updates an existing comment using its JSON representation.optional flags: renderedBody (provides body rendered in HTML)

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

id string

id

expand string

expand optional flags: renderedBody (provides body rendered in HTML)

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

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

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

linkId string

linkId

globalId string

globalId

application string

application

relationship string

relationship

object string

object

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

updateWorklog(options, callbackopt) → {Promise.<any>}

Updates an existing worklog entry. Note that:(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are

                  "new" - sets the estimate to a specific value
                  "leave"- leaves the estimate as is
                  "auto"- Default option.  Will automatically adjust the value based on the new timeSpent specified on the worklog (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field.
Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
issueIdOrKey string

issueIdOrKey

id string

id

adjustEstimate string

adjustEstimate (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are

                       "new" - sets the estimate to a specific value
                       "leave"- leaves the estimate as is
                       "auto"- Default option.  Will automatically adjust the value based on the new timeSpent specified on the worklog
newEstimate string

newEstimate (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>