Construct a new JiraApi
Optional httpsOptional intermediateOptional portAdd attachment to a Issue Jira Doc
issue id
readStream object from fs
Optional mimeType: stringmime type of attachment, this used by jira to preview files
Optional originalFileName: stringthe original (or new) file name for the attachment
Add a comment to an issue Jira Doc
Issue to add a comment to
string containing comment
Optional author?: { The ID of the user who created the comment.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional accountThe type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
Optional active?: booleanWhether the user is active.
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringThe URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
Optional body?: unknownThe comment text in Atlassian Document Format.
Optional created?: stringFormat: date-time
The date and time at which the comment was created.
Optional id?: stringThe ID of the comment.
Optional jsdWhether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.
Optional jsdWhether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.
Optional properties?: { A list of comment properties. Optional on create and update.
Optional renderedThe rendered version of the comment.
Optional self?: stringThe URL of the comment.
Optional updateThe ID of the user who updated the comment last.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional accountThe type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
Optional active?: booleanWhether the user is active.
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringThe URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
Optional updated?: stringFormat: date-time
The date and time at which the comment was updated last.
Optional visibility?: { The group or role to which this comment is visible. Optional on create and update.
Optional identifier?: null | stringThe ID of the group or the name of the role that visibility of this item is restricted to.
Optional type?: "group" | "role"Whether visibility of this item is restricted to a group or role.
Optional value?: stringThe name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.
Add component to Jira Jira Doc
Properly Formatted Component
Optional ari?: stringCompass component's ID. Can't be updated. Not required for creating a Project Component.
Optional assignee?: { The details of the user associated with assigneeType, if any. See realAssignee for details of the user assigned to issues created with this component.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
Optional accountThe user account type. Can take the following values:
atlassian regular Atlassian user accountapp system account used for Connect applications and OAuth to represent external systemscustomer Jira Service Desk account representing an external service deskOptional active?: booleanWhether the user is active.
Optional applicationThe application roles the user is assigned to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional expand?: stringExpand options that include additional user details in the response.
Optional groups?: { The groups that the user belongs to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional locale?: stringThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringFormat: uri
The URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.
Optional assigneeThe 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:
PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in.COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component.UNASSIGNED an assignee is not set for issues created with this component.PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.Default value: PROJECT_DEFAULT.
Optional when creating or updating a component.
Optional description?: stringThe description for the component. Optional when creating or updating a component.
Optional id?: stringThe unique identifier for the component.
Optional isWhether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.
Optional lead?: { The user details for the component's lead user.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
Optional accountThe user account type. Can take the following values:
atlassian regular Atlassian user accountapp system account used for Connect applications and OAuth to represent external systemscustomer Jira Service Desk account representing an external service deskOptional active?: booleanWhether the user is active.
Optional applicationThe application roles the user is assigned to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional expand?: stringExpand options that include additional user details in the response.
Optional groups?: { The groups that the user belongs to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional locale?: stringThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringFormat: uri
The URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.
Optional leadThe accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional leadThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional metadata?: { Compass component's metadata. Can't be updated. Not required for creating a Project Component.
Optional name?: stringThe unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.
Optional project?: stringThe key of the project the component is assigned to. Required when creating a component. Can't be updated.
Optional projectFormat: int64
The ID of the project the component is assigned to.
Optional realThe user assigned to issues created with this component, when assigneeType does not identify a valid assignee.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
Optional accountThe user account type. Can take the following values:
atlassian regular Atlassian user accountapp system account used for Connect applications and OAuth to represent external systemscustomer Jira Service Desk account representing an external service deskOptional active?: booleanWhether the user is active.
Optional applicationThe application roles the user is assigned to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional expand?: stringExpand options that include additional user details in the response.
Optional groups?: { The groups that the user belongs to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional locale?: stringThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringFormat: uri
The URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.
Optional realThe type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values:
PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues.PROJECT_DEFAULT when none of the preceding cases are true.Optional self?: stringFormat: uri
The URL of the component.
Add issue to Jira Jira Doc
Optional fields?: { List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.
Optional historyAdditional issue history details.
Optional activityThe activity described in the history record.
Optional activityThe key of the activity described in the history record.
Optional actor?: { Details of the user whose action created the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional cause?: { Details of the cause that triggered the creation the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional description?: stringThe description of the history record.
Optional descriptionThe description key of the history record.
Optional emailThe description of the email address associated the history record.
Optional emailThe description key of the email address associated the history record.
Optional extraAdditional arbitrary information about the history record.
Optional generator?: { Details of the system that generated the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional type?: stringThe type of the history record.
Optional properties?: { Details of issue properties to be add or update.
Optional transition?: { Details of a transition. Required when performing a transition, optional when creating or editing an issue.
Optional expand?: stringExpand options that include additional transition details in the response.
Optional fields?: { Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request.
Optional hasWhether there is a screen associated with the issue transition.
Optional id?: stringThe ID of the issue transition. Required when specifying a transition to undertake.
Optional isWhether the transition is available to be performed.
Optional isWhether the issue has to meet criteria before the issue transition is applied.
Optional isWhether the issue transition is global, that is, the transition is applied to issues regardless of their status.
Optional isWhether this is the initial issue transition for the workflow.
Optional looped?: booleanOptional name?: stringThe name of the issue transition.
Optional to?: { Details of the issue status after the transition.
Optional description?: stringThe description of the status.
Optional iconThe URL of the icon used to represent the status.
Optional id?: stringThe ID of the status.
Optional name?: stringThe name of the status.
Optional scope?: { The scope of the field.
Optional project?: { The project the item has scope in.
Optional avatarThe URLs of the project's avatars.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional id?: stringThe ID of the project.
Optional key?: stringThe key of the project.
Optional name?: stringThe name of the project.
Optional projectThe category the project belongs to.
Optional description?: stringThe name of the project category.
Optional id?: stringThe ID of the project category.
Optional name?: stringThe description of the project category.
Optional self?: stringThe URL of the project category.
Optional projectThe project type of the project.
Optional self?: stringThe URL of the project details.
Optional simplified?: booleanWhether or not the project is simplified.
Optional type?: "PROJECT" | "TEMPLATE"The type of scope.
Optional self?: stringThe URL of the status.
Optional statusThe category assigned to the status.
Optional colorThe name of the color used to represent the status category.
Optional id?: numberFormat: int64
The ID of the status category.
Optional key?: stringThe key of the status category.
Optional name?: stringThe name of the status category.
Optional self?: stringThe URL of the status category.
Optional update?: { A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.
Add a worklog to a project Jira Doc
Issue to add a worklog to
worklog object from the rest API
Optional author?: { Details of the user who created the worklog.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional accountThe type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
Optional active?: booleanWhether the user is active.
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringThe URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
Optional comment?: unknownA comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
Optional created?: stringFormat: date-time
The datetime on which the worklog was created.
Optional id?: stringThe ID of the worklog record.
Optional issueThe ID of the issue this worklog is for.
Optional properties?: { Details of properties for the worklog. Optional when creating or updating a worklog.
Optional self?: stringFormat: uri
The URL of the worklog item.
Optional started?: stringFormat: date-time
The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
Optional timeThe time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.
Optional timeFormat: int64
The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.
Optional updateDetails of the user who last updated the worklog.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional accountThe type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
Optional active?: booleanWhether the user is active.
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringThe URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
Optional updated?: stringFormat: date-time
The datetime on which the worklog was last updated.
Optional visibility?: { Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.
Optional identifier?: null | stringThe ID of the group or the name of the role that visibility of this item is restricted to.
Optional type?: "group" | "role"Whether visibility of this item is restricted to a group or role.
Optional value?: stringThe name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.
Optional newEstimate: stringthe new value for the remaining estimate field
Optional options: { extra options
Optional adjustDefines how to update the issue's time estimate, the options are:
new Sets the estimate to a specific value, defined in newEstimate.leave Leaves the estimate unchanged.manual Reduces the estimate by amount specified in reduceBy.auto Reduces the estimate by the value of timeSpent in the worklog.Optional expand?: stringUse expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.
Optional newThe value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.
Optional notifyWhether users watching the issue are notified by email.
Optional overrideWhether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.
Optional reduceThe amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when adjustEstimate is manual.
Create Board Jira Doc
Optional filterFormat: int64
Optional location?: { Optional projectOptional type?: "user" | "project"Optional name?: stringOptional type?: "kanban" | "scrum" | "agility"Create custom Jira field Jira Doc
Properly formatted Field object
Optional description?: stringThe description of the custom field, which is displayed in Jira.
The name of the custom field, which is displayed in Jira. This is not the unique identifier.
Optional searcherThe 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):
cascadingselect: cascadingselectsearcherdatepicker: daterangedatetime: datetimerangefloat: exactnumber or numberrangegrouppicker: grouppickersearcherimportid: exactnumber or numberrangelabels: labelsearchermulticheckboxes: multiselectsearchermultigrouppicker: multiselectsearchermultiselect: multiselectsearchermultiuserpicker: userpickergroupsearchermultiversion: versionsearcherproject: projectsearcherradiobuttons: multiselectsearcherreadonlyfield: textsearcherselect: multiselectsearchertextarea: textsearchertextfield: textsearcherurl: exacttextsearcheruserpicker: userpickergroupsearcherversion: versionsearcherIf no searcher is provided, the field isn't searchable. However, Forge custom fields have a searcher set automatically, so are always searchable.
The type of the custom field. These built-in custom field types are available:
cascadingselect: Enables values to be selected from two levels of select lists (value: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect)datepicker: Stores a date using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:datepicker)datetime: Stores a date with a time component (value: com.atlassian.jira.plugin.system.customfieldtypes:datetime)float: Stores and validates a numeric (floating point) input (value: com.atlassian.jira.plugin.system.customfieldtypes:float)grouppicker: Stores a user group using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:grouppicker)importid: A read-only field that stores the ID the issue had in the system it was imported from (value: com.atlassian.jira.plugin.system.customfieldtypes:importid)labels: Stores labels (value: com.atlassian.jira.plugin.system.customfieldtypes:labels)multicheckboxes: Stores multiple values using checkboxes (value: ``)multigrouppicker: Stores multiple user groups using a picker control (value: ``)multiselect: Stores multiple values using a select list (value: com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes)multiuserpicker: Stores multiple users using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker)multiversion: Stores multiple versions from the versions available in a project using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:multiversion)project: Stores a project from a list of projects that the user is permitted to view (value: com.atlassian.jira.plugin.system.customfieldtypes:project)radiobuttons: Stores a value using radio buttons (value: com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons)readonlyfield: Stores a read-only text value, which can only be populated via the API (value: com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield)select: Stores a value from a configurable list of options (value: com.atlassian.jira.plugin.system.customfieldtypes:select)textarea: Stores a long text string using a multiline text area (value: com.atlassian.jira.plugin.system.customfieldtypes:textarea)textfield: Stores a text string using a single-line text box (value: com.atlassian.jira.plugin.system.customfieldtypes:textfield)url: Stores a URL (value: com.atlassian.jira.plugin.system.customfieldtypes:url)userpicker: Stores a user using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:userpicker)version: Stores a version using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:version)To create a field based on a Forge custom field type, use the ID of the Forge custom field type as the value. For example, ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key.
Add an option for a select list issue field. Jira Doc
the key of the select list field
properly formatted Option object
Optional config?: { Optional attributes?: ("notSelectable" | "defaultValue")[]DEPRECATED
Optional scope?: { Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects.
Optional global?: { Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects.
Optional attributes?: ("notSelectable" | "defaultValue")[]Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
Optional projects?: number[]DEPRECATED
Optional projects2?: { Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.
Optional properties?: { The properties of the option as 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.
The option's name, which is displayed in Jira.
Create a new Project [Jira Doc](https://docs.atlassian.com/jira/REST/latest/#api/2/project-createproject: string)
with specs
Creates a remote link associated with the given issue.
The issue number to create the remotelink under
the remotelink object as specified by the Jira API
Optional application?: { Details of the remote application the linked item is in. For example, trello.
Optional name?: stringThe name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last.
Optional type?: stringThe name-spaced type of the application, used by registered rendering apps.
Optional globalAn identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123.
Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.
The maximum length is 255 characters.
Details of the item linked to.
Optional icon?: { Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.
Optional link?: stringThe URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
Optional title?: stringThe title of the icon. This is used as follows:
Optional url16x16?: stringThe URL of an icon that displays at 16x16 pixel in Jira.
Optional status?: { The status of the item.
Optional icon?: { Details of the icon representing the status. If not provided, no status icon displays in Jira.
Optional link?: stringThe URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
Optional title?: stringThe title of the icon. This is used as follows:
Optional url16x16?: stringThe URL of an icon that displays at 16x16 pixel in Jira.
Optional resolved?: booleanWhether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.
Optional summary?: stringThe summary details of the item.
The title of the item.
The URL of the item.
Optional relationship?: stringDescription of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.
Create a Jira user Jira Doc
Properly Formatted User object
Optional applicationDeprecated, do not use.
Optional displayThis property is no longer available. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.
The email address for the user.
Optional key?: stringThis property is no longer available. See the migration guide for details.
Optional name?: stringThis property is no longer available. See the migration guide for details.
Optional password?: stringThis property is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.
Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. To create a user without product access, set this field to be an empty array.
Optional self?: stringThe URL of the user.
Create a version Jira Doc
an object of the new version
Optional approvers?: readonly { If the expand option approvers is used, returns a list containing the approvers for this version.
Optional archived?: booleanIndicates that the version is archived. Optional when creating or updating a version.
Optional description?: stringThe description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
Optional driver?: stringIf the expand option driver is used, returns the Atlassian account ID of the driver.
Optional expand?: stringUse expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:
operations Returns the list of operations available for this version.issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.driver Returns the Atlassian account ID of the version driver.approvers Returns a list containing approvers for this version.Optional for create and update.
Optional id?: stringThe ID of the version.
Optional issuesIf the expand option issuesstatus is used, returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
Optional done?: numberFormat: int64
Count of issues with status done.
Optional inFormat: int64
Count of issues with status in progress.
Optional toFormat: int64
Count of issues with status to do.
Optional unmapped?: numberFormat: int64
Count of issues with a status other than to do, in progress, and done.
Optional moveFormat: uri
The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.
Optional name?: stringThe unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.
Optional operations?: readonly { If the expand option operations is used, returns the list of operations available for this version.
Optional overdue?: booleanIndicates that the version is overdue.
Optional project?: stringDeprecated. Use projectId.
Optional projectFormat: int64
The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
Optional releaseFormat: date
The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
Optional released?: booleanIndicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.
Optional self?: stringFormat: uri
The URL of the version.
Optional startFormat: date
The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
Optional userThe date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.
Optional userThe date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.
Remove the attachment Jira Doc
the attachment id
Delete Board Jira Doc
Id of board to retrieve
Delete Board Property Jira Doc
Id of board to retrieve
Id of property to delete
Delete Comments by Id. Jira Doc
this issue this comment is on
the id of the comment
Delete component from Jira Jira Doc
The ID of the component.
The ID of the component to replace the deleted component. If this value is null no replacement is made.
Deletes an option from a select list issue field. Jira Doc
the key of the select list field
the id of the deleted option
Delete issue from Jira Jira Doc
the Id of the issue to delete
Deletes an issue link. Jira Doc
the Id of the issue link to delete
Delete a version Jira Doc
the ID of the version to delete
when provided, existing fixVersions will be moved to this ID. Otherwise, the deleted version will be removed from all issue fixVersions.
when provided, existing affectedVersions will be moved to this ID. Otherwise, the deleted version will be removed from all issue affectedVersions.
Delete a registered webhook Jira Doc
id of the webhook to delete
Delete worklog from issue Jira Doc
the Id of the issue to delete
the Id of the worklog in issue to delete
Download an attachment Jira Doc
the attachment
Download an avatar Jira Doc
The avatar to download
Download an avatar Jira Doc
The avatar to download
Estimate issue for board Jira Doc
Id of issue
The id of the board required to determine which field is used for estimation.
value to set
Optional value?: stringFind an issue in jira Jira Doc
The issue number to search for including the project key
Optional expand: stringThe resource expansion to return additional fields in the response
Optional fields: stringComma separated list of field ids or keys to retrieve
Optional properties: stringComma separated list of properties to retrieve
Optional fieldsByKeys: booleanFalse by default, used to retrieve fields by key instead of id
Generic Get Request to the Agile API Jira Doc
Rest API endpoint
Generic Get Request Jira Doc
Rest API endpoint
Get all boards Jira Doc
Optional type: stringFilters results to boards of the specified type.
Optional name: stringFilters results to boards that match the specified name.
Optional projectKeyOrId: stringFilters results to boards that are relevant to a project.
Optional startAt: number = 0The starting index of the returned boards.
Optional maxResults: number = 50The maximum number of boards to return per page.
Get All Sprints Jira Doc
Id of board to retrieve
Optional startAt: number = 0The starting index of the returned sprints. Base index: 0.
Optional maxResults: number = 50The maximum number of sprints to return per page. Default: 50.
Optional state: string = undefinedFilters results to sprints in specified states. Valid values: future, active, closed.
Get All Versions Jira Doc
Id of board to retrieve
Optional startAt: number = 0The starting index of the returned versions. Base index: 0.
Optional maxResults: number = 50The maximum number of versions to return per page. Default: 50.
Optional released: boolean = undefinedFilters results to versions that are either released or unreleased.Valid values: true, false.
Retrieve the backlog of a certain Board
rapid view id
Get Board Jira Doc
Id of board to retrieve
Id of board to retrieve
Id of epic to retrieve, specify 'none' to get issues without an epic.
Optional startAt: number = 0The starting index of the returned issues. Base index: 0.
Optional maxResults: number = 50The maximum number of issues to return per page. Default: 50.
Optional jql: undefined = undefinedFilters results using a JQL query.
Optional validateQuery: boolean = trueSpecifies whether to validate the JQL query or not. Default: true.
Optional fields: undefined = undefinedThe list of fields to return for each issue.
Get Board issues for sprint Jira Doc
Id of board to retrieve
Id of sprint to retrieve
Optional startAt: number = 0The starting index of the returned issues. Base index: 0.
Optional maxResults: number = 50The maximum number of issues to return per page. Default: 50.
Optional jql: string = undefinedFilters results using a JQL query.
Optional validateQuery: boolean = trueSpecifies whether to validate the JQL query or not. Default: true.
Optional fields: string[] = undefinedThe list of fields to return for each issue.
Optional expand: string[] = undefinedA comma-separated list of the parameters to expand.
Get Board Properties Keys Jira Doc
Id of board to retrieve
Get Board Property Jira Doc
Id of board to retrieve
Id of property to retrieve
Get Comment by Id. Jira Doc
this issue this comment is on
the id of the comment
Get Comments by IssueId. Jira Doc
this issue this comment is on
Get Configuration Jira Doc
Id of board to retrieve
Describe the currently authenticated user Jira Doc
Get Epic Jira Doc
Id of epic to retrieve
Get Epics Jira Doc
Id of board to retrieve
Optional startAt: number = 0The starting index of the returned epics. Base index: 0.
Optional maxResults: number = 50The maximum number of epics to return per page. Default: 50.
Optional done: undefined = undefinedFilters results to epics that are either done or not done. Valid values: true, false.
Returns an option for a select list issue field. Jira Doc
the key of the select list field
the id of the option
Get Filter Jira Doc
Id of filter to retrieve
Get issue Jira Doc
Id of issue
Optional fields: string[]The list of fields to return for each issue.
Optional expand: string[]A comma-separated list of the parameters to expand.
List all changes for an issue, sorted by date, starting from the latest Jira Doc
The issue number to search for including the project key
Optional startAt: number = 0optional starting index number
Optional maxResults: number = 50optional ending index number
Get metadata for creating an issue. Jira Doc
Get issue estimation for board Jira Doc
Id of issue
The id of the board required to determine which field is used for estimation.
Get Property of Issue by Issue and Property Id Jira Doc
The issue number to search for including the project key
The property key to search for
List all watchers for an issue Jira Doc
The issue number to search for including the project key
Get worklogs list from a given issue Jira Doc
the Id of the issue to find worklogs for
Optional startAt: number = 0optional starting index number
Optional maxResults: number = 1000optional ending index number
Get issues for backlog Jira Doc
Id of board to retrieve
Optional jql: stringFilters results using a JQL query.
Optional fields: string[]The list of fields to return for each issue.
Optional startAt: number = 0The starting index of the returned issues. Base index: 0.
Optional maxResults: number = 50The maximum number of issues to return per page. Default: 50.
Optional validateQuery: boolean = trueSpecifies whether to validate the JQL query or not. Default: true.
Get issues for board Jira Doc
Id of board to retrieve
Optional jql: string = undefinedFilters results using a JQL query.
Optional fields: undefined = undefinedThe list of fields to return for each issue.
Optional startAt: number = 0The starting index of the returned issues. Base index: 0.
Optional maxResults: number = 50The maximum number of issues to return per page. Default: 50.
Optional validateQuery: boolean = trueSpecifies whether to validate the JQL query or not. Default: true.
Id of epic to retrieve, specify 'none' to get issues without an epic.
Optional startAt: number = 0The starting index of the returned issues. Base index: 0.
Optional maxResults: number = 50The maximum number of issues to return per page. Default: 50.
Optional jql: string = undefinedFilters results using a JQL query.
Optional validateQuery: boolean = trueSpecifies whether to validate the JQL query or not. Default: true.
Optional fields: string[] = undefinedThe list of fields to return for each issue.
Get all members of group on Jira
A query string used to search users in group
Optional startAt: number = 0The index of the first user to return (0-based)
Optional maxResults: number = 50The maximum number of users to return (defaults to 50).
Optional includeInactiveUsers: boolean = falseFetch inactive users too (defaults to false).
Get the Project by project key Jira Doc
key for the project
Get Projects Jira Doc
Id of board to retrieve
Optional startAt: number = 0The starting index of the returned projects. Base index: 0.
Optional maxResults: number = 50The maximum number of projects to return per page. Default: 50.
Get Projects Full Jira Doc
Id of board to retrieve
Retrieves the remote links associated with the given issue.
the issue number to find remote links for.
Get server info Jira Doc
Get the issues for a board / sprint
the id for the sprint
Get the unresolved issue count Jira Doc
the version of your product you want to find the unresolved issues of.
Returns a user. Jira Doc
The accountId of user to search for
Optional expand: string[]The expand for additional info (groups,applicationRoles)
Returns a list of all (active and inactive) users. Jira Doc
Optional startAt: number = 0The index of the first user to return (0-based)
Optional maxResults: number = 100The maximum number of users to return (defaults to 50).
Get all users in group on Jira
A query string used to search users in group
Optional startAt: number = 0The index of the first user to return (0-based)
Optional maxResults: number = 50The maximum number of users to return (defaults to 50).
Get issues related to a user Jira Doc
username of user to search for
determines if only open issues should be returned
Get details of single Version in project Jira Doc
The id of this version
Get Versions for a project Jira Doc
A project key to get versions for
Optional query: Partial<Pick<PaginationParams, "expand">>An object containing the query params
Get a webhook by its ID Jira Doc
id of webhook to get
Returns worklog details for a list of worklog IDs. Jira Doc
a list of worklog IDs.
expand to include additional information about worklogs
Get issue edit metadata Jira Doc
the Id of the issue to retrieve edit metadata for
Create an issue link between two issues
a link object formatted how the Jira API specifies
Optional application?: { Details of the remote application the linked item is in. For example, trello.
Optional name?: stringThe name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last.
Optional type?: stringThe name-spaced type of the application, used by registered rendering apps.
Optional globalAn identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123.
Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.
The maximum length is 255 characters.
Details of the item linked to.
Optional icon?: { Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.
Optional link?: stringThe URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
Optional title?: stringThe title of the icon. This is used as follows:
Optional url16x16?: stringThe URL of an icon that displays at 16x16 pixel in Jira.
Optional status?: { The status of the item.
Optional icon?: { Details of the icon representing the status. If not provided, no status icon displays in Jira.
Optional link?: stringThe URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
Optional title?: stringThe title of the icon. This is used as follows:
Optional url16x16?: stringThe URL of an icon that displays at 16x16 pixel in Jira.
Optional resolved?: booleanWhether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.
Optional summary?: stringThe summary details of the item.
The title of the item.
The URL of the item.
Optional relationship?: stringDescription of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.
Notify people related to issue Jira Doc
issue id
properly formatted body
Optional htmlThe HTML body of the email notification for the issue.
Optional restrict?: { Restricts the notifications to users with the specified permissions.
Optional groupList of groupId memberships required to receive the notification.
Optional groups?: { List of group memberships required to receive the notification.
Optional permissions?: { List of permissions required to receive the notification.
Optional subject?: stringThe subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.
Optional textThe plain text body of the email notification for the issue.
Optional to?: { The recipients of the email notification for the issue.
Optional assignee?: booleanWhether the notification should be sent to the issue's assignees.
Optional groupList of groupIds to receive the notification.
Optional groups?: { List of groups to receive the notification.
Optional reporter?: booleanWhether the notification should be sent to the issue's reporter.
Optional users?: { List of users to receive the notification.
Optional voters?: booleanWhether the notification should be sent to the issue's voters.
Optional watchers?: booleanWhether the notification should be sent to the issue's watchers.
List Components Jira Doc
key for the project
Returns all options defined for a select list issue field. Jira Doc
the key of the select list field
List all fields custom and not that jira knows about. Jira Doc
List all issue link types jira knows about
List all Issue Types jira knows about Jira Doc
List all priorities jira knows about Jira Doc
List all Viewable Projects Jira Doc
Get list of possible statuses Jira Doc
List Transitions for a specific issue that are available to the current user Jira Doc
get transitions available for the issue
List all registered webhooks Jira Doc
Creates a URI object for a given pathname
Creates a URI object for a given pathname
Optional options: MakeUrlParamsan object containing path information
Move issues to backlog Jira Doc
id or key of issues to get
Move version Jira Doc
the ID of the version to delete
an object of the new position
Optional after?: stringFormat: uri
The URL (self link) of the version after which to place the moved version. Cannot be used with position.
Optional position?: "Earlier" | "Later" | "First" | "Last"An absolute position in which to place the moved version. Cannot be used with after.
Partially update epic Jira Doc
Id of epic to retrieve
data to set
Optional color?: { Optional key?: "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"Optional done?: booleanOptional name?: stringOptional summary?: stringRank Epics Jira Doc
Id of epic
value to set
Optional rankOptional rankOptional rankFormat: int64
Rank Issues Jira Doc
value to set
Optional issues?: string[]Optional rankOptional rankOptional rankFormat: int64
Register a webhook Jira Doc
properly formatted webhook
The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered.
A list of webhooks.
Get count of issues assigned to the component. Jira Doc
Component Id.
Pass a search query to Jira Jira Doc
jira query string in JQL
object containing any of the pagination properties
Search user on Jira
Set Board Property Jira Doc
Id of board to retrieve
Id of property to delete
value to set, for objects make sure to stringify first
Transition issue in Jira Jira Doc
the Id of the issue to delete
transition object from the jira rest API
Optional fields?: { List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.
Optional historyAdditional issue history details.
Optional activityThe activity described in the history record.
Optional activityThe key of the activity described in the history record.
Optional actor?: { Details of the user whose action created the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional cause?: { Details of the cause that triggered the creation the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional description?: stringThe description of the history record.
Optional descriptionThe description key of the history record.
Optional emailThe description of the email address associated the history record.
Optional emailThe description key of the email address associated the history record.
Optional extraAdditional arbitrary information about the history record.
Optional generator?: { Details of the system that generated the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional type?: stringThe type of the history record.
Optional properties?: { Details of issue properties to be add or update.
Optional transition?: { Details of a transition. Required when performing a transition, optional when creating or editing an issue.
Optional expand?: stringExpand options that include additional transition details in the response.
Optional fields?: { Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request.
Optional hasWhether there is a screen associated with the issue transition.
Optional id?: stringThe ID of the issue transition. Required when specifying a transition to undertake.
Optional isWhether the transition is available to be performed.
Optional isWhether the issue has to meet criteria before the issue transition is applied.
Optional isWhether the issue transition is global, that is, the transition is applied to issues regardless of their status.
Optional isWhether this is the initial issue transition for the workflow.
Optional looped?: booleanOptional name?: stringThe name of the issue transition.
Optional to?: { Details of the issue status after the transition.
Optional description?: stringThe description of the status.
Optional iconThe URL of the icon used to represent the status.
Optional id?: stringThe ID of the status.
Optional name?: stringThe name of the status.
Optional scope?: { The scope of the field.
Optional project?: { The project the item has scope in.
Optional avatarThe URLs of the project's avatars.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional id?: stringThe ID of the project.
Optional key?: stringThe key of the project.
Optional name?: stringThe name of the project.
Optional projectThe category the project belongs to.
Optional description?: stringThe name of the project category.
Optional id?: stringThe ID of the project category.
Optional name?: stringThe description of the project category.
Optional self?: stringThe URL of the project category.
Optional projectThe project type of the project.
Optional self?: stringThe URL of the project details.
Optional simplified?: booleanWhether or not the project is simplified.
Optional type?: "PROJECT" | "TEMPLATE"The type of scope.
Optional self?: stringThe URL of the status.
Optional statusThe category assigned to the status.
Optional colorThe name of the color used to represent the status category.
Optional id?: numberFormat: int64
The ID of the status category.
Optional key?: stringThe key of the status category.
Optional name?: stringThe name of the status category.
Optional self?: stringThe URL of the status category.
Optional update?: { A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.
Change an assignee on an issue Jira Doc
the key of the existing issue
the jira username to add as a new assignee to the issue
Change an assignee on an issue Jira Doc
the key of the existing issue
the jira username to add as a new assignee to the issue
Update comment for an issue Jira Doc
Issue with the comment
Comment that is updated
string containing new comment
Optional author?: { The ID of the user who created the comment.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional accountThe type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
Optional active?: booleanWhether the user is active.
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringThe URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
Optional body?: unknownThe comment text in Atlassian Document Format.
Optional created?: stringFormat: date-time
The date and time at which the comment was created.
Optional id?: stringThe ID of the comment.
Optional jsdWhether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.
Optional jsdWhether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.
Optional properties?: { A list of comment properties. Optional on create and update.
Optional renderedThe rendered version of the comment.
Optional self?: stringThe URL of the comment.
Optional updateThe ID of the user who updated the comment last.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional accountThe type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
Optional active?: booleanWhether the user is active.
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringThe URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
Optional updated?: stringFormat: date-time
The date and time at which the comment was updated last.
Optional visibility?: { The group or role to which this comment is visible. Optional on create and update.
Optional identifier?: null | stringThe ID of the group or the name of the role that visibility of this item is restricted to.
Optional type?: "group" | "role"Whether visibility of this item is restricted to a group or role.
Optional value?: stringThe name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.
Optional options: { extra options
Optional expand?: stringUse expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
Optional notifyWhether users are notified when a comment is updated.
Optional overrideWhether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.
Update Jira component [Jira Doc](http://docs.atlassian.com/jira/REST/latest/#api/2/component-updatecomponent: string)
the Id of the component to update
Properly Formatted Component
Optional ari?: stringCompass component's ID. Can't be updated. Not required for creating a Project Component.
Optional assignee?: { The details of the user associated with assigneeType, if any. See realAssignee for details of the user assigned to issues created with this component.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
Optional accountThe user account type. Can take the following values:
atlassian regular Atlassian user accountapp system account used for Connect applications and OAuth to represent external systemscustomer Jira Service Desk account representing an external service deskOptional active?: booleanWhether the user is active.
Optional applicationThe application roles the user is assigned to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional expand?: stringExpand options that include additional user details in the response.
Optional groups?: { The groups that the user belongs to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional locale?: stringThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringFormat: uri
The URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.
Optional assigneeThe 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:
PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in.COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component.UNASSIGNED an assignee is not set for issues created with this component.PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.Default value: PROJECT_DEFAULT.
Optional when creating or updating a component.
Optional description?: stringThe description for the component. Optional when creating or updating a component.
Optional id?: stringThe unique identifier for the component.
Optional isWhether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.
Optional lead?: { The user details for the component's lead user.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
Optional accountThe user account type. Can take the following values:
atlassian regular Atlassian user accountapp system account used for Connect applications and OAuth to represent external systemscustomer Jira Service Desk account representing an external service deskOptional active?: booleanWhether the user is active.
Optional applicationThe application roles the user is assigned to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional expand?: stringExpand options that include additional user details in the response.
Optional groups?: { The groups that the user belongs to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional locale?: stringThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringFormat: uri
The URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.
Optional leadThe accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional leadThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional metadata?: { Compass component's metadata. Can't be updated. Not required for creating a Project Component.
Optional name?: stringThe unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.
Optional project?: stringThe key of the project the component is assigned to. Required when creating a component. Can't be updated.
Optional projectFormat: int64
The ID of the project the component is assigned to.
Optional realThe user assigned to issues created with this component, when assigneeType does not identify a valid assignee.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
Optional accountThe user account type. Can take the following values:
atlassian regular Atlassian user accountapp system account used for Connect applications and OAuth to represent external systemscustomer Jira Service Desk account representing an external service deskOptional active?: booleanWhether the user is active.
Optional applicationThe application roles the user is assigned to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional expand?: stringExpand options that include additional user details in the response.
Optional groups?: { The groups that the user belongs to.
Optional callback?: Record<string, never>Optional items?: { Optional max-Format: int32
Optional pagingOptional size?: numberFormat: int32
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional locale?: stringThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringFormat: uri
The URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.
Optional realThe type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values:
PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues.PROJECT_DEFAULT when none of the preceding cases are true.Optional self?: stringFormat: uri
The URL of the component.
Update issue in Jira Jira Doc
the Id of the issue to update
update Object as specified by the rest api
Optional fields?: { List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.
Optional historyAdditional issue history details.
Optional activityThe activity described in the history record.
Optional activityThe key of the activity described in the history record.
Optional actor?: { Details of the user whose action created the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional cause?: { Details of the cause that triggered the creation the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional description?: stringThe description of the history record.
Optional descriptionThe description key of the history record.
Optional emailThe description of the email address associated the history record.
Optional emailThe description key of the email address associated the history record.
Optional extraAdditional arbitrary information about the history record.
Optional generator?: { Details of the system that generated the history record.
Optional avatarThe URL to an avatar for the user or system associated with a history record.
Optional displayThe display name of the user or system associated with a history record.
Optional displayThe key of the display name of the user or system associated with a history record.
Optional id?: stringThe ID of the user or system associated with a history record.
Optional type?: stringThe type of the user or system associated with a history record.
Optional url?: stringThe URL of the user or system associated with a history record.
Optional type?: stringThe type of the history record.
Optional properties?: { Details of issue properties to be add or update.
Optional transition?: { Details of a transition. Required when performing a transition, optional when creating or editing an issue.
Optional expand?: stringExpand options that include additional transition details in the response.
Optional fields?: { Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request.
Optional hasWhether there is a screen associated with the issue transition.
Optional id?: stringThe ID of the issue transition. Required when specifying a transition to undertake.
Optional isWhether the transition is available to be performed.
Optional isWhether the issue has to meet criteria before the issue transition is applied.
Optional isWhether the issue transition is global, that is, the transition is applied to issues regardless of their status.
Optional isWhether this is the initial issue transition for the workflow.
Optional looped?: booleanOptional name?: stringThe name of the issue transition.
Optional to?: { Details of the issue status after the transition.
Optional description?: stringThe description of the status.
Optional iconThe URL of the icon used to represent the status.
Optional id?: stringThe ID of the status.
Optional name?: stringThe name of the status.
Optional scope?: { The scope of the field.
Optional project?: { The project the item has scope in.
Optional avatarThe URLs of the project's avatars.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional id?: stringThe ID of the project.
Optional key?: stringThe key of the project.
Optional name?: stringThe name of the project.
Optional projectThe category the project belongs to.
Optional description?: stringThe name of the project category.
Optional id?: stringThe ID of the project category.
Optional name?: stringThe description of the project category.
Optional self?: stringThe URL of the project category.
Optional projectThe project type of the project.
Optional self?: stringThe URL of the project details.
Optional simplified?: booleanWhether or not the project is simplified.
Optional type?: "PROJECT" | "TEMPLATE"The type of scope.
Optional self?: stringThe URL of the status.
Optional statusThe category assigned to the status.
Optional colorThe name of the color used to represent the status category.
Optional id?: numberFormat: int64
The ID of the status category.
Optional key?: stringThe key of the status category.
Optional name?: stringThe name of the status category.
Optional self?: stringThe URL of the status category.
Optional update?: { A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.
Optional query: { adds parameters to the query string
Optional expand?: stringThe Get issue API expand parameter to use in the response if the returnIssue parameter is true.
Optional notifyWhether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.
Optional overrideWhether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.
Optional overrideWhether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.
Optional returnWhether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the Get issue API.
Update a version Jira Doc
a new object of the version to update
Optional approvers?: readonly { If the expand option approvers is used, returns a list containing the approvers for this version.
Optional archived?: booleanIndicates that the version is archived. Optional when creating or updating a version.
Optional description?: stringThe description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
Optional driver?: stringIf the expand option driver is used, returns the Atlassian account ID of the driver.
Optional expand?: stringUse expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:
operations Returns the list of operations available for this version.issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.driver Returns the Atlassian account ID of the version driver.approvers Returns a list containing approvers for this version.Optional for create and update.
Optional id?: stringThe ID of the version.
Optional issuesIf the expand option issuesstatus is used, returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
Optional done?: numberFormat: int64
Count of issues with status done.
Optional inFormat: int64
Count of issues with status in progress.
Optional toFormat: int64
Count of issues with status to do.
Optional unmapped?: numberFormat: int64
Count of issues with a status other than to do, in progress, and done.
Optional moveFormat: uri
The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.
Optional name?: stringThe unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.
Optional operations?: readonly { If the expand option operations is used, returns the list of operations available for this version.
Optional overdue?: booleanIndicates that the version is overdue.
Optional project?: stringDeprecated. Use projectId.
Optional projectFormat: int64
The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
Optional releaseFormat: date
The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
Optional released?: booleanIndicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.
Optional self?: stringFormat: uri
The URL of the version.
Optional startFormat: date
The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
Optional userThe date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.
Optional userThe date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.
Update worklog from issue Jira Doc
the Id of the issue to update
the Id of the worklog in issue to update
value to set
Optional author?: { Details of the user who created the worklog.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional accountThe type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
Optional active?: booleanWhether the user is active.
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringThe URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
Optional comment?: unknownA comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
Optional created?: stringFormat: date-time
The datetime on which the worklog was created.
Optional id?: stringThe ID of the worklog record.
Optional issueThe ID of the issue this worklog is for.
Optional properties?: { Details of properties for the worklog. Optional when creating or updating a worklog.
Optional self?: stringFormat: uri
The URL of the worklog item.
Optional started?: stringFormat: date-time
The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
Optional timeThe time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.
Optional timeFormat: int64
The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.
Optional updateDetails of the user who last updated the worklog.
Optional accountThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Optional accountThe type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
Optional active?: booleanWhether the user is active.
Optional avatarThe avatars of the user.
Optional 16x16?: stringFormat: uri
The URL of the item's 16x16 pixel avatar.
Optional 24x24?: stringFormat: uri
The URL of the item's 24x24 pixel avatar.
Optional 32x32?: stringFormat: uri
The URL of the item's 32x32 pixel avatar.
Optional 48x48?: stringFormat: uri
The URL of the item's 48x48 pixel avatar.
Optional displayThe display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
Optional emailThe email address of the user. Depending on the user’s privacy settings, this may be returned as null.
Optional key?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional name?: stringThis property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Optional self?: stringThe URL of the user.
Optional timeThe time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
Optional updated?: stringFormat: date-time
The datetime on which the worklog was last updated.
Optional visibility?: { Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.
Optional identifier?: null | stringThe ID of the group or the name of the role that visibility of this item is restricted to.
Optional type?: "group" | "role"Whether visibility of this item is restricted to a group or role.
Optional value?: stringThe name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.
Get ids of worklogs modified since Jira Doc
a date time in unix timestamp format since when updated worklogs will be returned.
ptional comma separated list of parameters to expand: properties (provides worklog properties).
Creates or updates an option for a select list issue field. Jira Doc
the key of the select list field
the id of the modified option
properly formatted Option object
Optional config?: { Optional attributes?: ("notSelectable" | "defaultValue")[]DEPRECATED
Optional scope?: { Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects.
Optional global?: { Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects.
Optional attributes?: ("notSelectable" | "defaultValue")[]Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
Optional projects?: number[]DEPRECATED
Optional projects2?: { Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.
Format: int64
The unique identifier for the option. This is only unique within the select field's set of options.
Optional properties?: { The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see Issue Field Option Property Index) are defined in the descriptor for the issue field module.
The option's name, which is displayed in Jira.
Generated using TypeDoc
Wrapper for the JIRA Rest Api https://docs.atlassian.com/jira/REST/6.4.8/