@datafire/jira v3.0.0

@datafire/jira

Client library for Jira

Installation and Usage

npm install --save @datafire/jira

let jira = require('@datafire/jira').create({
  username: "",
  password: "",
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

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

Description

The Jira Cloud Platform REST API

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

jira.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

jira.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

application_properties.get

Returns all application properties or a single application property.

jira.application_properties.get({}, context)

Input

• input object
  • key string: The key of the application property.
  • keyFilter string: When a key isn't provided, this filters the list of results by the application property key using a regular expression. For example, using jira.lf.* will return all application properties with keys that start with jira.lf..
  • permissionLevel string: The permission level of all items being returned in the list.

Output

• output array
  • items object
    • defaultValue required string
    • desc required string
    • id required string
    • key required string
    • name required string
    • type required string
    • value required string

application_properties.id.put

Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.

jira.application_properties.id.put({
  "id": ""
}, context)

Input

• input object
  • body object
    • id string: The ID of the application property, for example jira.newsletter.tip.delay.days.
    • value string: The new value, for example -1.
  • id required string: The key of the application property to update.

Output

Output schema unknown

application_properties.advanced_settings.get

Returns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon > Jira settings > System, General Configuration and then click Advanced Settings (in the upper right).

jira.application_properties.advanced_settings.get(null, context)

Input

This action has no parameters

Output

• output array
  • items object
    • defaultValue required string
    • desc required string
    • id required string
    • key required string
    • name required string
    • type required string
    • value required string

applicationrole.get

Returns all application roles. In Jira, application roles are managed using the Application access configuration page.

jira.applicationrole.get(null, context)

Input

This action has no parameters

Output

• output array
  • items object
    • defaultGroups required array
      • items object
    • defined required boolean
    • groups required array
      • items object
    • hasUnlimitedSeats required boolean
    • key required string
    • name required string
    • numberOfSeats required number
    • platform required boolean
    • remainingSeats required number
    • selectedByDefault required boolean
    • userCount required number
    • userCountDescription required string

applicationrole.key.get

Returns an application role.

jira.applicationrole.key.get({
  "key": ""
}, context)

Input

• input object
  • key required string: The key of the application role. Use the Get all application roles method to get the key for each application role.

Output

• output object
  • defaultGroups required array
    • items object
  • defined required boolean
  • groups required array
    • items object
  • hasUnlimitedSeats required boolean
  • key required string
  • name required string
  • numberOfSeats required number
  • platform required boolean
  • remainingSeats required number
  • selectedByDefault required boolean
  • userCount required number
  • userCountDescription required string

attachment.id.delete

Deletes an attachment from an issue.

jira.attachment.id.delete({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the attachment.

Output

Output schema unknown

attachment.id.get

Returns the metadata for an attachment. Note that the attachment itself is not returned.

jira.attachment.id.get({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the attachment.

Output

• output object
  • author required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • content required string
  • created required string
  • filename required string
  • id required number
  • mimeType required string
  • self required string
  • size required number
  • thumbnail required string

attachment.id.expand.human.get

Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.

jira.attachment.id.expand.human.get({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the attachment.

Output

• output object
  • entries required array
    • items object
      • index required number
      • label required string
      • mediaType required string
      • path required string
      • size required string
  • id required number
  • mediaType required string
  • name required string
  • totalEntryCount required number

attachment.id.expand.raw.get

Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.

jira.attachment.id.expand.raw.get({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the attachment.

Output

• output object
  • entries required array
    • items object
      • entryIndex required number
      • mediaType required string
      • name required string
      • size required number
  • totalEntryCount required number

attachment.meta.get

Returns the global attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.

jira.attachment.meta.get(null, context)

Input

This action has no parameters

Output

• output object
  • enabled required boolean
  • uploadLimit required number

auditing.record.get

Returns a list of audit records. The list can be filtered to include items:

jira.auditing.record.get({}, context)

Input

• input object
  • filter string: The query string.
  • from string: The date and time on or after which returned audit records must have been created. If to is provided from must be before to or the result set will be empty.
  • limit integer: The maximum number of results to return. The maximum is 1000.
  • offset integer: The number of records to skip before returning the first result.
  • to string: The date and time on or before which returned audit results must have been created. If from is provided to must be after from or the result set will be empty.

Output

• output object
  • limit required number
  • offset required number
  • records required array
    • items object
      • associatedItems array
        • items object
          • id required string
          • name required string
          • parentId required string
          • parentName required string
          • typeName required string
      • authorKey required string
      • category required string
      • changedValues array
        • items object
          • changedFrom required string
          • changedTo required string
          • fieldName required string
      • created required string
      • description required string
      • eventSource required string
      • id required number
      • objectItem object
        • id required string
        • name required string
        • parentId required string
        • parentName required string
        • typeName required string
      • remoteAddress required string
      • summary required string
  • total required number

avatar.type.system.get

Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.

jira.avatar.type.system.get({
  "type": ""
}, context)

Input

• input object
  • type required string: The avatar type.

Output

• output object
  • system required array
    • items object
      • id required string
      • isDeletable required boolean
      • isSelected required boolean
      • isSystemAvatar required boolean
      • urls object
        • 16x16 required string
        • 24x24 required string
        • 32x32 required string
        • 48x48 required string

comment.commentId.properties.get

Returns the keys of all the properties of a comment.

jira.comment.commentId.properties.get({
  "commentId": ""
}, context)

Input

• input object
  • commentId required string: The ID of the comment.

Output

• output object
  • keys required array
    • items object
      • key required string
      • self required string

comment.commentId.properties.propertyKey.delete

Deletes a comment property.

jira.comment.commentId.properties.propertyKey.delete({
  "commentId": "",
  "propertyKey": ""
}, context)

Input

• input object
  • commentId required string: The ID of the comment.
  • propertyKey required string: The key of the property.

Output

Output schema unknown

comment.commentId.properties.propertyKey.get

Returns the value of a comment property.

jira.comment.commentId.properties.propertyKey.get({
  "commentId": "",
  "propertyKey": ""
}, context)

Input

• input object
  • commentId required string: The ID of the comment.
  • propertyKey required string: The key of the property.

Output

• output object
  • key required string
  • value required object
    • stride.conversation.id required string
    • support.time required string

comment.commentId.properties.propertyKey.put

Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.

jira.comment.commentId.properties.propertyKey.put({
  "commentId": "",
  "propertyKey": ""
}, context)

Input

• input object
  • commentId required string: The ID of the comment.
  • propertyKey required string: The key of the property. The maximum length is 255 characters.

Output

Output schema unknown

comment.list.post

Returns the comments for a list of comment IDs.

jira.comment.list.post({}, context)

Input

• input object
  • body object
    • ids array: The list of comment IDs. Maximum of 1000 IDs can be specified. Required
      • items integer
  • expand string (values: renderedBody, properties): Use expand to include additional information about comments in the response. This parameter accepts multiple values separated by a comma:

Output

• output object
  • isLast required boolean
  • maxResults required number
  • startAt required number
  • total required number
  • values required array
    • items object
      • author object
        • active required boolean
        • displayName required string
        • name required string
        • self required string
      • body object
        • content required array
          • items object
        • type required string
        • version required number
      • created required string
      • id required string
      • self required string
      • updateAuthor object
        • active required boolean
        • displayName required string
        • name required string
        • self required string
      • updated required string
      • visibility object
        • type required string
        • value required string

component.post

Creates a component. Use components to provide containers for issues within a project. Permissions required: Any of the following:

jira.component.post({}, context)

Input

• input object
  • body object
    • assignee object: A user.
    • assigneeType string (values: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED): The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:
    • description string: The description for the component. Optional when creating or updating a component.
    • lead object: A user.
    • leadAccountId string: The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.Optional when creating or updating a component.
    • leadUserName string: This property has been deprecated in favour of leadAccountId due to privacy changes. See the migration guide for details.The username of the component's lead user. Optional when creating or updating a component.
    • name string: The unique name for the component in the project. Required when creating a component. Optional when updating a component. Maximum length 255 chars.
    • project string: The key of the project to which the component is assigned. Required when creating a component. Can't be updated.
    • projectId integer: Not used.
    • realAssignee object: A user.

Output

• output object
  • assignee required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • assigneeType required string
  • description required string
  • id required string
  • isAssigneeTypeValid required boolean
  • lead required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • name required string
  • project required string
  • projectId required number
  • realAssignee required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • realAssigneeType required string
  • self required string

component.id.delete

Deletes a component. Permissions required: Any of the following:

jira.component.id.delete({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the component.
  • moveIssuesTo string: The ID of the component to replace the deleted component. If this value is null no replacement is made.

Output

Output schema unknown

component.id.get

Returns a component. Permissions required: Browse projects project permission.

jira.component.id.get({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the component.

Output

• output object
  • assignee required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • assigneeType required string
  • description required string
  • id required string
  • isAssigneeTypeValid required boolean
  • lead required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • name required string
  • project required string
  • projectId required number
  • realAssignee required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • realAssigneeType required string
  • self required string

component.id.put

Modifies a component. Any fields included in the request are overwritten. If leadUserName is an empty string ("") the component lead is removed. Permissions required: Any of the following:

jira.component.id.put({
  "id": ""
}, context)

Input

• input object
  • body object
    • assignee object: A user.
    • assigneeType string (values: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED): The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:
    • description string: The description for the component. Optional when creating or updating a component.
    • lead object: A user.
    • leadAccountId string: The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.Optional when creating or updating a component.
    • leadUserName string: This property has been deprecated in favour of leadAccountId due to privacy changes. See the migration guide for details.The username of the component's lead user. Optional when creating or updating a component.
    • name string: The unique name for the component in the project. Required when creating a component. Optional when updating a component. Maximum length 255 chars.
    • project string: The key of the project to which the component is assigned. Required when creating a component. Can't be updated.
    • projectId integer: Not used.
    • realAssignee object: A user.
  • id required string

Output

Output schema unknown

component.id.relatedIssueCounts.get

Returns the counts of issues assigned to the component. Permissions required: Permission to access Jira.

jira.component.id.relatedIssueCounts.get({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the component.

Output

• output object
  • issueCount required number
  • self required string

configuration.get

Returns the global settings in Jira. These settings determine whether optional features (for example, sub-tasks, time tracking, and others) are enabled. If time tracking is enabled, this method also returns the time tracking configuration.

jira.configuration.get(null, context)

Input

This action has no parameters

Output

• output object
  • attachmentsEnabled required boolean
  • issueLinkingEnabled required boolean
  • subTasksEnabled required boolean
  • timeTrackingConfiguration required object
    • defaultUnit required string
    • timeFormat required string
    • workingDaysPerWeek required number
    • workingHoursPerDay required number
  • timeTrackingEnabled required boolean
  • unassignedIssuesAllowed required boolean
  • votingEnabled required boolean
  • watchingEnabled required boolean

configuration.timetracking.delete

Disables time tracking.

jira.configuration.timetracking.delete(null, context)

Input

This action has no parameters

Output

Output schema unknown

configuration.timetracking.get

Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.

jira.configuration.timetracking.get(null, context)

Input

This action has no parameters

Output

• output object
  • key required string
  • name required string
  • url required string

configuration.timetracking.put

Selects a time tracking provider.

jira.configuration.timetracking.put({}, context)

Input

• input object
  • body object
    • key string: The key for the time tracking provider (for example, JIRA).
    • name string: The name of the time tracking provider (for example, JIRA provided time tracking).

Output

Output schema unknown

configuration.timetracking.list.get

Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.

jira.configuration.timetracking.list.get(null, context)

Input

This action has no parameters

Output

• output array
  • items object
    • key required string
    • name required string
    • url required string

configuration.timetracking.options.get

Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.

jira.configuration.timetracking.options.get(null, context)

Input

This action has no parameters

Output

• output object
  • defaultUnit required string
  • timeFormat required string
  • workingDaysPerWeek required number
  • workingHoursPerDay required number

configuration.timetracking.options.put

Sets the time tracking settings.

jira.configuration.timetracking.options.put({}, context)

Input

• input object
  • body object
    • defaultUnit string (values: minute, hour, day, week): The unit of time that will be applied to logged time by default.
    • timeFormat string (values: pretty, days, hours): The format that will appear on an issue's Time Spent field.
    • workingDaysPerWeek number: The number of days in a working week (for example, 5.5). This value is specified in days.
    • workingHoursPerDay number: The number of hours in a working day (for example, 7.6). This value is specified in hours.

Output

• output object
  • defaultUnit required string
  • timeFormat required string
  • workingDaysPerWeek required number
  • workingHoursPerDay required number

customFieldOption.id.get

Returns a custom field option. For example, an option in a cascading select list.

jira.customFieldOption.id.get({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the custom field option. To find this ID, configure the custom field and edit its options in Jira. Click the option and its ID will show in the URL as the selectedParentOptionId parameter.

Output

• output object
  • self required string
  • value required string

dashboard.get

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

jira.dashboard.get({}, context)

Input

• input object
  • filter string (values: favourite, my): The filter applied to the list of dashboards. Valid values are:
  • maxResults integer: The maximum number of items to return per page. Maximum is 1000.
  • startAt integer: The index of the first item to return in a page of results (page offset).

Output

• output object
  • dashboards required array
    • items object
      • id required string
      • isFavourite required boolean
      • name required string
      • owner object
        • avatarUrls required object
          • 16x16 required string
          • 24x24 required string
          • 32x32 required string
          • 48x48 required string
        • displayName required string
        • key required string
        • name required string
        • self required string
      • popularity required number
      • self required string
      • sharePermissions array
        • items object
          • group object
          • id required number
          • type required string
      • view required string
  • maxResults required number
  • next required string
  • prev required string
  • startAt required number
  • total required number

dashboard.dashboardId.items.itemId.properties.get

Returns the keys of all properties for a dashboard item.

jira.dashboard.dashboardId.items.itemId.properties.get({
  "dashboardId": "",
  "itemId": ""
}, context)

Input

• input object
  • dashboardId required string: The ID of the dashboard.
  • itemId required string: The ID of the dashboard item.

Output

• output object
  • keys required array
    • items object
      • key required string
      • self required string

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

Deletes a dashboard item property.

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

Input

• input object
  • dashboardId required string: The ID of the dashboard.
  • itemId required string: The ID of the dashboard item.
  • propertyKey required string: The key of the dashboard item property.

Output

Output schema unknown

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

Returns the key and value of a dashboard item property.

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

Input

• input object
  • dashboardId required string: The ID of the dashboard.
  • itemId required string: The ID of the dashboard item.
  • propertyKey required string: The key of the dashboard item property.

Output

• output object
  • key required string
  • value required object
    • stride.conversation.id required string
    • support.time required string

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

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

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

Input

• input object
  • dashboardId required string: The ID of the dashboard.
  • itemId required string: The ID of the dashboard item.
  • propertyKey required string: The key of the dashboard item property. The maximum length of the key is 255 bytes.

Output

Output schema unknown

dashboard.id.get

Returns a dashboard.

jira.dashboard.id.get({
  "id": ""
}, context)

Input

• input object
  • id required string: The ID of the dashboard.

Output

• output object
  • id required string
  • isFavourite required boolean
  • name required string
  • popularity required number
  • self required string
  • sharePermissions required array
    • items object
      • type required string
  • view required string

expression.eval.post

Evaluates a Jira expression and returns its value.

jira.expression.eval.post({}, context)

Input

• input object
  • body object
    • context object
    • expression string: The Jira expression to evaluate.
  • expand string (values: meta.complexity): Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:

Output

• output object
  • meta required object
    • complexity required object
      • beans required object
        • limit required number
        • value required number
      • expensiveOperations required object
        • limit required number
        • value required number
      • primitiveValues required object
        • limit required number
        • value required number
      • steps required object
        • limit required number
        • value required number
  • value required string

field.get

Returns all issue fields in Jira, both system and custom fields.

jira.field.get(null, context)

Input

This action has no parameters

Output

• output array
  • items object
    • clauseNames required array
      • items object
    • custom required boolean
    • id required string
    • key required string
    • name required string
    • navigable required boolean
    • orderable required boolean
    • schema required object
      • system required string
      • type required string
    • searchable required boolean

field.post

Creates a custom field.

jira.field.post({}, context)

Input

• input object
  • body object
    • description string: The description of the custom field, which is displayed in the UI.
    • name string: The name of the custom field, which is displayed in the UI. This is not the unique identifier.
    • searcherKey string (values: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher, com.atlassian.jira.plugin.system.customfieldtypes:daterange, com.atlassian.jira.plugin.system.customfieldtypes:datetimerange, com.atlassian.jira.plugin.system.customfieldtypes:exactnumber, com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher, com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher, com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher, com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher, com.atlassian.jira.plugin.system.customfieldtypes:numberrange, com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher): The searcher defines the way the field is searched in Jira. For example, com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher.The search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):
    • type string (values: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect, com.atlassian.jira.plugin.system.customfieldtypes:datepicker, com.atlassian.jira.plugin.system.customfieldtypes:datetime, com.atlassian.jira.plugin.system.customfieldtypes:float, com.atlassian.jira.plugin.system.customfieldtypes:grouppicker, com.atlassian.jira.plugin.system.customfieldtypes:importid, com.atlassian.jira.plugin.system.customfieldtypes:labels, com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes, com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker, com.atlassian.jira.plugin.system.customfieldtypes:multiselect): The type of the custom field. For example, com.atlassian.jira.plugin.system.customfieldtypes:grouppicker.

Output

• output object
  • clauseNames required array
    • items object
  • custom required boolean
  • id required string
  • name required string
  • navigable required boolean
  • orderable required boolean
  • schema required object
    • custom required string
    • customId required number
    • type required string
  • searchable required boolean

field.fieldKey.option.get

Returns all options defined for a select list issue field. A select list issue field is a type of issue field that allows a user to select an value from a list of options.

jira.field.fieldKey.option.get({
  "fieldKey": ""
}, context)

Input

• input object
  • fieldKey required string: The field key is specified in the following format: $(app-key)$(field-key). For example, example-add-onexample-issue-field.
  • maxResults integer: The maximum number of items to return per page. For example, 20.
  • startAt integer: The starting index of the returned objects. For example, 1.

Output

• output object
  • isLast required boolean
  • maxResults required number
  • nextPage required string
  • self required string
  • startAt required number
  • total required number
  • values required array
    • items object
      • config object
        • attributes required array
          • items object
        • scope required object
          • global required object
          • projects required array
          • projects2 required array
      • id required number
      • properties object
        • description required string
        • founded required string
        • leader required object
          • email required string
          • name required string
        • members required number
      • value required string

field.fieldKey.option.post

Creates an option for a select list issue field.

jira.field.fieldKey.option.post({
  "fieldKey": ""
}, context)

Input

• input object
  • body object
    • config object
    • properties object: The properties can be any arbitrary key value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.
    • value string: The option's name, which is displayed in the UI.
  • fieldKey required string

Output

• output object
  • config required object
    • attributes required array
      • items object
    • scope required object
      • global required object
      • projects required array
        • items object
      • projects2 required array
        • items object
          • attributes array
          • id required number
  • properties required object
    • description required string
    • founded required string
    • leader required object
      • email required string
      • name required string
    • members required number
  • value required string

field.fieldKey.option.optionId.delete

Deletes an option from a select list issue field.

jira.field.fieldKey.option.optionId.delete({
  "fieldKey": "",
  "optionId": 0
}, context)

Input

• input object
  • fieldKey required string: The field key is specified in the following format: $(app-key)$(field-key). For example, example-add-onexample-issue-field.
  • optionId required integer: The ID of the option to be deleted. For example, 3.

Output

Output schema unknown

field.fieldKey.option.optionId.get

Returns an option from a select list issue field.

jira.field.fieldKey.option.optionId.get({
  "fieldKey": "",
  "optionId": 0
}, context)

Input

• input object
  • fieldKey required string: The field key is specified in the following format: $(app-key)$(field-key). For example, example-add-onexample-issue-field.
  • optionId required integer: The ID of the option to be returned. For example, 3.

Output

• output object
  • config required object
    • attributes required array
      • items object
    • scope required object
      • global required object
      • projects required array
        • items object
      • projects2 required array
        • items object
          • attributes array
          • id required number
  • id required number
  • properties required object
    • description required string
    • founded required string
    • leader required object
      • email required string
      • name required string
    • members required number
  • value required string

field.fieldKey.option.optionId.put

Updates an option for a select list issue field. If the option does not exist, a new option is created.

jira.field.fieldKey.option.optionId.put({
  "fieldKey": "",
  "optionId": 0
}, context)

Input

• input object
  • body object
    • config object
    • properties object: The properties can be any arbitrary key value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.
    • value string: The option's name, which is displayed in the UI.
  • fieldKey required string: The field key is specified in the following format: $(app-key)$(field-key). For example, example-add-onexample-issue-field.
  • optionId required integer: The ID of the option to be updated. For example, 3.

Output

• output object
  • config required object
    • attributes required array
      • items object
    • scope required object
      • global required object
      • projects required array
        • items object
      • projects2 required array
        • items object
          • attributes array
          • id required number
  • id required number
  • properties required object
    • description required string
    • founded required string
    • leader required object
      • email required string
      • name required string
    • members required number
  • value required string

field.fieldKey.option.optionId.issue.delete

Deselects a select list issue field option in all issues that it has been selected in. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query.

jira.field.fieldKey.option.optionId.issue.delete({
  "fieldKey": "",
  "optionId": 0
}, context)

Input

• input object
  • fieldKey required string: The field key is specified in the following format: $(app-key)$(field-key). For example, example-add-onexample-issue-field.
  • jql string: A JQL query that specifies the issues to be updated. For example, project=10000.
  • optionId required integer: The ID of the option to be deselected. For example, 3.
  • replaceWith integer: The ID of the option that will replace the currently selected option. For example, 2.

Output

• output object
  • description required string
  • elapsedRuntime required number
  • id required string
  • result required object
    • errors required object
      • errorMessages required array
        • items object
      • errors required object
    • modifiedIssues required array
      • items object
    • unmodifiedIssues required array
      • items object
  • self required string
  • status required string

field.fieldKey.option.suggestions.edit.get

Returns options defined for a select list issue field that can be viewed and selected by the currently logged in user.

jira.field.fieldKey.option.suggestions.edit.get({
  "fieldKey": ""
}, context)

Input

• input object
  • fieldKey required string: The field key is specified in the following format: $(app-key)$(field-key). For example, example-add-onexample-issue-field.
  • maxResults integer: The maximum number of items to return per page. For example, 20.
  • projectId integer: Filters the results to options that are only available in the specified project. For example, 10000.
  • startAt integer: The starting index of the returned objects. For example, 1.

Output

• output object
  • isLast required boolean
  • maxResults required number
  • nextPage required string
  • self required string
  • startAt required number
  • total required number
  • values required array
    • items object
      • id required number
      • properties object
        • description required string
        • founded required string
        • leader required object
          • email required string
          • name required string
        • members required number
      • value required string

field.fieldKey.option.suggestions.search.get

Returns options defined for a select list issue field that can be viewed by the currently logged in user.

jira.field.fieldKey.option.suggestions.search.get({
  "fieldKey": ""
}, context)

Input

• input object
  • fieldKey required string: The field key is specified in the following format: $(app-key)$(field-key). For example, example-add-onexample-issue-field.
  • maxResults integer: The maximum number of items to return per page. For example, 20.
  • projectId integer: Filters the results to options that are only available in the specified project. For example, 10000.
  • startAt integer: The starting index of the returned objects. For example, 1.

Output

• output object
  • isLast required boolean
  • maxResults required number
  • nextPage required string
  • self required string
  • startAt required number
  • total required number
  • values required array
    • items object
      • id required number
      • properties object
        • description required string
        • founded required string
        • leader required object
          • email required string
          • name required string
        • members required number
      • value required string

filter.get

Returns all filters. Deprecated, use Search for filters that supports search and pagination. Permissions required: None, however only the following filters are returned:

jira.filter.get({}, context)

Input

• input object
  • expand string (values: sharedUsers, subscriptions): Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:

Output

• output object
  • description required string
  • favourite required boolean
  • favouritedCount required number
  • id required string
  • jql required string
  • name required string
  • owner required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • searchUrl required string
  • self required string
  • sharePermissions required array
    • items object
  • subscriptions required object
    • end-index required number
    • items required array
      • items object
    • max-results required number
    • size required number
    • start-index required number
  • viewUrl required string

filter.post

Creates a new filter. The new filter is not shared and not selected as a favorite. Permissions required: Permission to log in to Jira.

jira.filter.post({}, context)

Input

• input object
  • body object
    • description string: A description of the filter (e.g., This filter returns open bugs for the Example project).
    • name string: The name of the filter (e.g., Open bugs for Example project). Must be unique.
    • owner object: A user.
    • sharedUsers object
    • sharePermissions array: The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.
      • items object
    • subscriptions object
  • expand string (values: sharedUsers, subscriptions): Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:

Output

• output object
  • description required string
  • favourite required boolean
  • favouritedCount required number
  • id required string
  • jql required string
  • name required string
  • owner required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • searchUrl required string
  • self required string
  • sharePermissions required array
    • items object
  • subscriptions required object
    • end-index required number
    • items required array
      • items object
    • max-results required number
    • size required number
    • start-index required number
  • viewUrl required string

filter.id.delete

Delete a filter. Permissions required: Permission to log in to Jira, however the following rules govern what a user can delete:

jira.filter.id.delete({
  "id": 0
}, context)

Input

• input object
  • id required integer: The ID of the filter to delete.

Output

Output schema unknown

filter.id.get

Returns a filter. Permissions required: None, however the calling user must have permission view the filter.

jira.filter.id.get({
  "id": 0
}, context)

Input

• input object
  • expand string (values: sharedUsers, subscriptions): Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
  • id required integer: The ID of the filter to return.

Output

• output object
  • description required string
  • favourite required boolean
  • favouritedCount required number
  • id required string
  • jql required string
  • name required string
  • owner required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • searchUrl required string
  • self required string
  • sharePermissions required array
    • items object
  • subscriptions required object
    • end-index required number
    • items required array
      • items object
    • max-results required number
    • size required number
    • start-index required number
  • viewUrl required string

filter.id.put

Updates an existing filter. Use this method to update a filter's name, description, JQL, or sharing. Permissions required: Permission to log in to Jira, however the following rules govern what a user can update:

jira.filter.id.put({
  "id": 0
}, context)

Input

• input object
  • body object
    • description string: A description of the filter (e.g., This filter returns open bugs for the Example project).
    • name string: The name of the filter (e.g., Open bugs for Example project). Must be unique.
    • owner object: A user.
    • sharedUsers object
    • sharePermissions array: The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.
      • items object
    • subscriptions object
  • expand string (values: sharedUsers, subscriptions): Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
  • id required integer: The ID of the filter to update.

Output

• output object
  • description required string
  • favourite required boolean
  • favouritedCount required number
  • id required string
  • jql required string
  • name required string
  • owner required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • searchUrl required string
  • self required string
  • sharePermissions required array
    • items object
  • subscriptions required object
    • end-index required number
    • items required array
      • items object
    • max-results required number
    • size required number
    • start-index required number
  • viewUrl required string

filter.id.columns.delete

Reset the user's column configuration for the filter to the default. Permissions required: Permission to log in to Jira (i.e., member of the users group) and permission to view the filter.

jira.filter.id.columns.delete({
  "id": 0
}, context)

Input

• input object
  • id required integer: The ID of the filter.

Output

Output schema unknown

filter.id.columns.get

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter. Permissions required: None, however the calling user must have permission to view the filter.

jira.filter.id.columns.get({
  "id": 0
}, context)

Input

• input object
  • id required integer: The ID of the filter.

Output

• output array
  • items object
    • label required string
    • value required string

filter.id.columns.put

Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true. Permissions required: Permission to log in to Jira (i.e., member of the users group) and permission to view the filter.

jira.filter.id.columns.put({
  "id": 0
}, context)

Input

• input object
  • id required integer: The ID of the filter.

Output

Output schema unknown

filter.id.favourite.delete

Removes a filter as a favorite for the calling user. Permissions required: Permission to log in to Jira (i.e., member of the users group) and permission to view the filter.

jira.filter.id.favourite.delete({
  "id": 0
}, context)

Input

• input object
  • expand string (values: sharedUsers, subscriptions): Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
  • id required integer: The ID of the filter.

Output

• output object
  • description required string
  • favourite required boolean
  • favouritedCount required number
  • id required string
  • jql required string
  • name required string
  • owner required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • searchUrl required string
  • self required string
  • sharePermissions required array
    • items object
  • subscriptions required object
    • end-index required number
    • items required array
      • items object
    • max-results required number
    • size required number
    • start-index required number
  • viewUrl required string

filter.id.favourite.put

Add a filter as a favorite for the calling user. Permissions required: Permission to log in to Jira (i.e., member of the users group) and permission to view the filter.

jira.filter.id.favourite.put({
  "id": 0
}, context)

Input

• input object
  • expand string (values: sharedUsers, subscriptions): Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
  • id required integer: The ID of the filter.

Output

• output object
  • description required string
  • favourite required boolean
  • favouritedCount required number
  • id required string
  • jql required string
  • name required string
  • owner required object
    • accountId required string
    • active required boolean
    • avatarUrls required object
      • 16x16 required string
      • 24x24 required string
      • 32x32 required string
      • 48x48 required string
    • displayName required string
    • key required string
    • name required string
    • self required string
  • searchUrl required string
  • self required string
  • sharePermissions required array
    • items object
  • subscriptions required object
    • end-index required number
    • items required array
      • items object
    • max-results required number
    • size required number
    • start-index required number
  • viewUrl required string

filter.id.permission.get

Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. Permissions required: None, however the calling user must have permission to view the filter.

jira.filter.id.permission.get({
  "id": 0
}, context)

Input

• input object
  • id required integer: The ID of the filter.

Output

• output array
  • items object
    • id required number
    • project required object
      • avatarUrls required object
        • 16x16 required string
        • 24x24 required string
        • 32x32 required string
        • 48x48 required string
      • id required string
      • key required string
      • name required string
      • projectCategory required object
        • description required string
        • id required string
        • name required string
        • self required string
      • self required string
      • simplified required boolean
      • style required string
    • role required object
      • actors required array
        • items object
          • actorGroup object
          • displayName required string
          • id required number
          • name required string
          • type required string
      • description required string
      • id required number
      • name required string
      • scope required object
        • project required object
          • id required string
        • type required string
      • self required string
    • type required string

filter.id.permission.post

Add a share permissions to a filter. If you add a global share permission (i.e., all logged-in users or the public) it will overwrite all share permissions for the filter.Be aware that this method uses different objects for updating share permissions compared to Update filter. Permissions required: Share dashboards and filters global permission and the calling user must own the filter.

jira.filter.id.permission.post({
  "id": 0
}, context)

Input

• input object
  • body object
    • groupname string: The name of the group to share the filter with. Set type to group.
    • projectId string: The ID of the project to share the filter with. Set type to project.
    • projectRoleId string: The ID of the project role to share the filter with. Set type to projectRole and the projectId for the project that the role is in.
    • type string (values: project, group, projectRole, global, authenticated): The type of the share permission.Specify the type as follows:
  • id required integer: The ID of the filter.

Output

• output array
  • items object
    • id required number
    • project required object
      • avatarUrls required object
        • 16x16 required string
        • 24x24 required string
        • 32x32 required string
        • 48x48 required string
      • id required string
      • key required string
      • name required string
      • projectCategory required object
        • description required string
        • id required string
        • name required string
        • self required string
      • self required string
      • simplified required boolean
      • style required string
    • role required object
      • actors required array
        • items object
          • actorGroup object
          • displayName required string
          • id required number
          • name required string
          • type required string
      • description required string
      • id required number
      • name required string
      • scope required object
        • project required object
          • id required string
        • type required string
      • self required string
    • type required string

filter.id.permission.permissionId.delete

Deletes a share permission from a filter. Permissions required: Permission to log in to Jira (i.e., member of the users group) and the calling user must own the filter.

jira.filter.id.permission.permissionId.delete({
  "id": 0,
  "permissionId": 0
}, context)

Input

• input object
  • id required integer: The ID of the filter.
  • permissionId required integer: The ID of the share permission.

Output

Output schema unknown

filter.id.permission.permissionId.get

Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. Permissions required: None, however the calling user must have permission to view the filter.

jira.filter.id.permission.permissionId.get({
  "id": 0,
  "permissionId": 0
}, context)

Input

• input object
  • id required integer: The ID of the filter.
  • permissionId required integer: The ID of the share permission.

Output

• output object
  • id required number
  • type required string

filter.defaultShareScope.get

Returns the default sharing settings for new filters and dashboards for a user. Permissions required: Permission to log in to Jira (i.e., member of the users group).

jira.filter.defaultShareScope.get(null, context)

Input

This action has no parameters

Output

• output object
  • scope required string

filter.defaultShareScope.put

Sets the default sharing for new filters and dashboards for a user. Permissions required: Permission to log in to Jira (i.e., member of the users group).

jira.filter.defaultShareScope.put({}, context)

Input

• input object
  • body object
    • scope string (values: GLOBAL, AUTHENTICATED, PRIVATE): The scope of the default sharing for new filters and dashboards:

Output

• output object
  • scope required string

filter.favourite.get

Returns the favorite filters of the calling user. Permissions required: Permission to log in to Jira (i.e., member of the users group).

jira.filter.favourite.get({}, context)

Input

• input object
  • expand string (values: sharedUsers, subscriptions): Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:

Output

• output array
  • items object
    • description required string
    • favourite required boolean
    • favouritedCount required number
    • id required string
    • jql required string
    • name required string
    • owner required object
      • accountId required string
      • active required boolean
      • avatarUrls required object
        • 16x16 required string
        • 24x24 required string
        • 32x32 required string
        • 48x48 required string
      • displayName required string
      • key required string
      • name required string
      • self required string
    • searchUrl required string
    • self required string
    • sharePermissions required array
      • items object
    • subscriptions required object
      • end-index required number
      • items required array
        • items object
      • max-results required number
      • size **requi