jira API reference

179 public APIs from jira (pycontribs/jira) — 51 classes, 7 functions, 121 methods. Signatures extracted by static analysis of the actual source.

Repository: pycontribs/jira

Kind	Count
Classes	51
Functions	7
Methods	121

API list

classjira.client.JIRA

User interface to Jira.

methodjira.client.JIRA.add_group(groupname:str) -> bool

Create a new group in Jira.

methodjira.client.JIRA.add_issue_property(issue:str, key:str, data) -> Response

Add or update a specific issue property Resource.

methodjira.client.JIRA.add_issues_to_epic(epic_id:str, issue_keys:str | list[str], ignore_epics:bool | None=None) -> Response

Add the issues in ``issue_keys`` to the ``epic_id``.

methodjira.client.JIRA.add_issues_to_sprint(sprint_id:int, issue_keys:list[str]) -> Response

Add the issues in ``issue_keys`` to the ``sprint_id``.

methodjira.client.JIRA.add_user_to_group(username:str, group:str) -> bool | dict[str, Any]

Add a user to an existing group.

methodjira.client.JIRA.add_vote(issue:str | int) -> Response

methodjira.client.JIRA.add_watcher(issue:str | int, watcher:str) -> Response

Add a user to an issue's watchers list.

methodjira.client.JIRA.application_properties(key:str | None=None) -> dict[str, str] | list[dict[str, str]]

Return the mutable server application properties.

methodjira.client.JIRA.applicationlinks(cached:bool=True) -> list

List of application links.

methodjira.client.JIRA.assign_issue(issue:int | str, assignee:str | None) -> bool

Assign an issue to a user.

methodjira.client.JIRA.attachment(id:str) -> Attachment

Get an attachment Resource from the server for the specified ID.

methodjira.client.JIRA.attachment_meta() -> dict[str, int]

Get the attachment metadata.

methodjira.client.JIRA.backup(filename:str='backup.zip', attachments:bool=False) -> bool | int | None

Will call jira export to backup as zipped xml.

methodjira.client.JIRA.backup_download(filename:str | None=None)

Download backup file from WebDAV (cloud only).

methodjira.client.JIRA.backup_progress() -> dict[str, Any] | None

Return status of cloud backup as a dict.

method

jira.client.JIRA.boards(startAt:int=0, maxResults:int=50, type:str | None=None, name:str | None=None, projectKeyOrID=None) -> ResultList[Board]

Get a list of board resources.

methodjira.client.JIRA.client_info() -> str

Get the server this client is connected to.

methodjira.client.JIRA.comment(issue:int | str, comment:str, expand:str | None=None) -> Comment

Get a comment Resource from the server for the specified ID.

methodjira.client.JIRA.component(id:str)

Get a component Resource from the server.

methodjira.client.JIRA.component_count_related_issues(id:str)

Get the count of related issues for a component.

method

jira.client.JIRA.copy_dashboard(id:str, name:str, description:str | None=None, edit_permissions:list[dict] | list | None=None, share_permissions:list[dict] | list | None=None) -> Dashboard

Copy an existing dashboard.

methodjira.client.JIRA.create_customer(email:str, displayName:str) -> Customer

Create a new customer and return an issue Resource for it.

methodjira.client.JIRA.create_issue(fields:dict[str, Any] | None=None, prefetch:bool=True, **fieldargs) -> Issue

Create a new issue and return an issue Resource for it.

method

jira.client.JIRA.create_issue_link(type:str | IssueLinkType, inwardIssue:str, outwardIssue:str, comment:dict[str, Any] | None=None) -> Response

Create a link between two issues.

method

jira.client.JIRA.create_sprint(name:str, board_id:int, startDate:Any | None=None, endDate:Any | None=None, goal:str | None=None) -> Sprint

Create a new sprint for the ``board_id``.

methodjira.client.JIRA.current_user(field:str | None=None) -> str

Return the `accountId` (Cloud) else `username` of the current user.

methodjira.client.JIRA.custom_field_option(id:str) -> CustomFieldOption

Get a custom field option Resource from the server.

methodjira.client.JIRA.dashboard(id:str) -> Dashboard

Get a dashboard Resource from the server.

methodjira.client.JIRA.deactivate_user(username:str) -> str | int

Disable/deactivate the user.

methodjira.client.JIRA.delete_attachment(id:str) -> Response

Delete attachment by id.

methodjira.client.JIRA.delete_board(id)

Delete an agile board.

methodjira.client.JIRA.delete_component(id:str) -> Response

Delete component by id.

methodjira.client.JIRA.delete_issue_link(id:str)

Delete a link between two issues.

methodjira.client.JIRA.delete_project(pid:str | Project, enable_undo:bool=True) -> bool | None

Delete project from Jira.

methodjira.client.JIRA.delete_project_avatar(project:str, avatar:str) -> Response

Delete a project's avatar.

methodjira.client.JIRA.delete_user(username:str) -> bool

Deletes a Jira User.

methodjira.client.JIRA.delete_user_avatar(username:str, avatar:str) -> Response

Delete a user's avatar.

methodjira.client.JIRA.editmeta(issue:str | int)

Get the edit metadata for an issue.

methodjira.client.JIRA.fields() -> list[dict[str, Any]]

Return a list of all issue fields.

methodjira.client.JIRA.filter(id:str) -> Filter

Get a filter Resource from the server.

methodjira.client.JIRA.find(resource_format:str, ids:tuple[str, str] | int | str='') -> Resource

Find Resource object for any addressable resource on the server.

methodjira.client.JIRA.get_project_version_by_name(project:str, version_name:str) -> Version | None

Get a version Resource by its name present on a project.

methodjira.client.JIRA.group(id:str, expand:Any | None=None) -> Group

Get a group Resource from the server.

methodjira.client.JIRA.group_members(group:str) -> OrderedDict

Return a hash or users with their information.

methodjira.client.JIRA.groups(query:str | None=None, exclude:Any | None=None, maxResults:int=9999) -> list[str]

Return a list of groups matching the specified criteria.

method

jira.client.JIRA.issue(id:Issue | str, fields:str | None=None, expand:str | None=None, properties:str | None=None) -> Issue

Get an issue Resource from the server.

methodjira.client.JIRA.issue_link(id:str) -> IssueLink

Get an issue link Resource from the server.

methodjira.client.JIRA.issue_link_type(id:str) -> IssueLinkType

Get an issue link type Resource from the server.

methodjira.client.JIRA.issue_link_types(force:bool=False) -> list[IssueLinkType]

Get a list of issue link type Resources from the server.

methodjira.client.JIRA.issue_properties(issue:str) -> list[IssueProperty]

Get a list of issue property Resource from the server for an issue.

methodjira.client.JIRA.issue_property(issue:str, key:str) -> IssueProperty

Get a specific issue property Resource from the server.

methodjira.client.JIRA.issue_type(id:str) -> IssueType

Get an issue type Resource from the server.

methodjira.client.JIRA.issue_type_by_name(name:str, project:str | None=None) -> IssueType

Get issue type by name.

methodjira.client.JIRA.issue_type_schemes() -> list[IssueTypeScheme]

Get all issue type schemes defined (Admin required).

methodjira.client.JIRA.issue_types() -> list[IssueType]

Get a list of issue type Resources from the server.

methodjira.client.JIRA.issue_types_for_project(projectIdOrKey:str) -> list[IssueType]

Get a list of issue types available within the project.

methodjira.client.JIRA.kill_session() -> Response

Destroy the session of the current authenticated user.

methodjira.client.JIRA.kill_websudo() -> Response | None

Destroy the user's current WebSudo session.

methodjira.client.JIRA.myself() -> dict[str, Any]

Get a dict of client information for this Jira instance.

methodjira.client.JIRA.pin_comment(issue:int | str, comment:int | str, pin:bool) -> Response

Pin/Unpin a comment on the issue.

methodjira.client.JIRA.pinned_comments(issue:int | str) -> list[PinnedComment]

Get a list of pinned comment Resources of the issue provided.

methodjira.client.JIRA.priorities() -> list[Priority]

Get a list of priority Resources from the server.

methodjira.client.JIRA.priority(id:str) -> Priority

Get a priority Resource from the server.

methodjira.client.JIRA.project(id:str, expand:str | None=None) -> Project

Get a project Resource from the server.

methodjira.client.JIRA.project_components(project:str) -> list[Component]

Get a list of component Resources present on a project.

methodjira.client.JIRA.project_issue_security_level_scheme(project:str) -> IssueSecurityLevelScheme

Get a IssueSecurityLevelScheme Resource from the server.

methodjira.client.JIRA.project_notification_scheme(project:str) -> NotificationScheme

Get a NotificationScheme Resource from the server.

methodjira.client.JIRA.project_permissionscheme(project:str) -> PermissionScheme

Get a PermissionScheme Resource from the server.

methodjira.client.JIRA.project_priority_scheme(project:str) -> PriorityScheme

Get a PriorityScheme Resource from the server.

methodjira.client.JIRA.project_role(project:str, id:str) -> Role

Get a role Resource.

methodjira.client.JIRA.project_roles(project:str) -> dict[str, dict[str, str]]

Get a dict of role names to resource locations for a project.

methodjira.client.JIRA.project_versions(project:str) -> list[Version]

Get a list of version Resources present on a project.

methodjira.client.JIRA.project_workflow_scheme(project:str) -> WorkflowScheme

Get a WorkflowScheme Resource from the server.

methodjira.client.JIRA.reindex(force:bool=False, background:bool=True) -> bool

Start jira re-indexing.

methodjira.client.JIRA.remote_link(issue:str | int, id:str) -> RemoteLink

Get a remote link Resource from the server.

methodjira.client.JIRA.remote_links(issue:str | int) -> list[RemoteLink]

Get a list of remote link Resources from an issue.

methodjira.client.JIRA.remove_group(groupname:str) -> bool

Delete a group from the Jira instance.

methodjira.client.JIRA.remove_user_from_group(username:str, groupname:str) -> bool

Remove a user from a group.

methodjira.client.JIRA.remove_watcher(issue:str | int, watcher:str) -> Response

Remove a user from an issue's watch list.

methodjira.client.JIRA.removed_issues(board_id:str, sprint_id:str)

Return the completed issues for the sprint.

methodjira.client.JIRA.rename_user(old_user:str, new_user:str)

Rename a Jira user.

methodjira.client.JIRA.rename_version(project:str, old_name:str, new_name:str) -> None

Rename a version Resource on a project.

methodjira.client.JIRA.request_types(service_desk:ServiceDesk) -> list[RequestType]

Returns request types supported by a service desk instance.

methodjira.client.JIRA.resolution(id:str) -> Resolution

Get a resolution Resource from the server.

methodjira.client.JIRA.resolutions() -> list[Resolution]

Get a list of resolution Resources from the server.

methodjira.client.JIRA.role() -> list[dict[str, Any]]

Return Jira role information.

methodjira.client.JIRA.security_level(id:str) -> SecurityLevel

Get a security level Resource.

methodjira.client.JIRA.server_info() -> dict[str, Any]

Get a dict of server information for this Jira instance.

methodjira.client.JIRA.server_url() -> str

Return the server url.

methodjira.client.JIRA.service_desk(id:str) -> ServiceDesk

Get a Service Desk Resource from the server.

methodjira.client.JIRA.set_application_property(key:str, value:str)

Set the application property.

method

jira.client.JIRA.set_dashboard_item_property(dashboard_id:str, item_id:str, property_key:str, value:dict[str, Any]) -> DashboardItemProperty

Set a dashboard item property.

methodjira.client.JIRA.set_project_avatar(project:str, avatar:str)

Set a project's avatar.

methodjira.client.JIRA.set_user_avatar(username:str, avatar:str) -> Response

Set a user's avatar.

methodjira.client.JIRA.sprint(id:int) -> Sprint

Return the information about a sprint.

methodjira.client.JIRA.sprint_info(board_id:str, sprint_id:str) -> dict[str, Any]

Return the information about a sprint.

method

jira.client.JIRA.sprints(board_id:int, extended:bool | None=None, startAt:int=0, maxResults:int=50, state:str | None=None) -> ResultList[Sprint]

Get a list of sprint Resources.

methodjira.client.JIRA.status(id:str) -> Status

Get a status Resource from the server.

methodjira.client.JIRA.statuscategory(id:int) -> StatusCategory

Get a status category Resource from the server.

methodjira.client.JIRA.statuses() -> list[Status]

Get a list of all status Resources from the server.

methodjira.client.JIRA.update_dashboard_automatic_refresh_minutes(id:str, minutes:int) -> Response

Update the automatic refresh interval of a dashboard.

method

jira.client.JIRA.update_sprint(id:str | int, name:str | None=None, startDate:Any | None=None, endDate:Any | None=None, state:str | None=None, goal:str | None=None) -> dict[str, Any]

Updates the sprint with the given values.

methodjira.client.JIRA.user(id:str, expand:Any | None=None) -> User

Get a user Resource from the server.

methodjira.client.JIRA.user_avatars(username:str) -> dict[str, Any]

Get a dict of avatars for the specified user.

methodjira.client.JIRA.version(id:str, expand:Any | None=None) -> Version

Get a version Resource.

methodjira.client.JIRA.votes(issue:str | int) -> Votes

Get a votes Resource from the server.

methodjira.client.JIRA.watchers(issue:str | int) -> Watchers

Get a watchers Resource from the server for an issue.

methodjira.client.JIRA.worklog(issue:str | int, id:str) -> Worklog

Get a specific worklog Resource from the server.

methodjira.client.JIRA.worklogs(issue:str | int) -> list[Worklog]

Get a list of worklog Resources from the server for an issue.

classjira.client.JiraCookieAuth

Jira Cookie Authentication.

methodjira.client.JiraCookieAuth.handle_401(response:requests.Response, **kwargs) -> requests.Response

Refresh cookies if the session cookie has expired.

classjira.client.TokenAuth

Bearer Token Authentication.

funcjira.client.cloud_api(client_method:Callable) -> Callable

A convenience decorator to check if the Jira instance is cloud.

funcjira.config.findfile(path)

Find the file named path in the sys.path.

classjira.exceptions.JIRAError

General error raised for all problems in operation of the client.

classjira.exceptions.NotJIRAInstanceError

Raised in the case an object is not a JIRA instance.

funcjira.resilientsession.parse_error_msg(resp:Response) -> str

Parse a Jira Error messages from the Response and join them by comma.

funcjira.resilientsession.parse_errors(resp:Response) -> list[str]

Parse a Jira Error messages from the Response.

funcjira.resilientsession.raise_on_error(resp:Response | None, **kwargs) -> TypeGuard[Response]

Handle errors from a Jira Request.

classjira.resources.AgileResource

A generic Agile resource.

classjira.resources.Attachment

An issue attachment.

methodjira.resources.Attachment.get()

Return the file content as a string.

classjira.resources.Board

An Agile board.

classjira.resources.Comment

An issue comment.

classjira.resources.Component

A project component.

methodjira.resources.Component.delete(moveIssuesTo:str | None=None)

Delete this component from the server.

classjira.resources.CustomFieldOption

An existing option for a custom issue field.

classjira.resources.Customer

A Service Desk customer.

classjira.resources.Dashboard

A Jira dashboard.

classjira.resources.DashboardGadget

A jira dashboard gadget.

methodjira.resources.DashboardGadget.delete(dashboard_id:str) -> Response

Delete gadget from dashboard.

method

jira.resources.DashboardGadget.update(dashboard_id:str, color:str | None=None, position:dict[str, Any] | None=None, title:str | None=None) -> DashboardGadget

Update this resource on the server.

classjira.resources.DashboardItemProperty

A jira dashboard item.

methodjira.resources.DashboardItemProperty.delete(dashboard_id:str, item_id:str) -> Response

Delete dashboard item property.

method

jira.resources.DashboardItemProperty.update(dashboard_id:str, item_id:str, value:dict[str, Any]) -> DashboardItemProperty

Update this resource on the server.

classjira.resources.DashboardItemPropertyKey

A jira dashboard item property key.

classjira.resources.Field

An issue field.

classjira.resources.Filter

An issue navigator filter.

classjira.resources.Group

A Jira user group.

classjira.resources.Issue

A Jira issue.

methodjira.resources.Issue.delete(deleteSubtasks=False)

Delete this issue from the server.

methodjira.resources.Issue.get_field(field_name:str) -> Any

Obtain the (parsed) value from the Issue's field.

classjira.resources.IssueLink

Link between two issues.

classjira.resources.IssueLinkType

Type of link between two issues.

classjira.resources.IssueProperty

Custom data against an issue.

classjira.resources.IssueSecurityLevelScheme

IssueSecurityLevelScheme information on a project.

classjira.resources.IssueType

Type of issue.

classjira.resources.IssueTypeScheme

An issue type scheme.

classjira.resources.NotificationScheme

NotificationScheme information on a project.

classjira.resources.PermissionScheme

Permissionscheme information on a project.

classjira.resources.PinnedComment

Pinned comment on an issue.

classjira.resources.Priority

Priority that can be set on an issue.

classjira.resources.PriorityScheme

PriorityScheme information on a project.

classjira.resources.Project

A Jira project.

classjira.resources.PropertyHolder

An object for storing named attributes.

classjira.resources.RemoteLink

A link to a remote application from an issue.

methodjira.resources.RemoteLink.update(object:dict[str, Any] | None, globalId=None, application=None, relationship=None)

Update a RemoteLink.

classjira.resources.RequestType

A Service Desk Request Type.

classjira.resources.Resolution

A resolution for an issue.

classjira.resources.Resource

Models a URL-addressable resource in the Jira REST API.

methodjira.resources.Resource.delete(params:dict[str, Any] | None=None) -> Response | None

Delete this resource from the server, passing the specified query parameters.

method

jira.resources.Resource.update(fields:dict[str, Any] | None=None, async_:bool | None=None, jira:JIRA | None=None, notify:bool=True, **kwargs:Any)

Update this resource on the server.

classjira.resources.Role

A role inside a project.

classjira.resources.SecurityLevel

A security level for an issue or project.

classjira.resources.ServiceDesk

A Service Desk.

classjira.resources.Sprint

An Agile sprint.

classjira.resources.Status

Status for an issue.

classjira.resources.StatusCategory

StatusCategory for an issue.

classjira.resources.UnknownResource

A Resource from Jira that is not (yet) supported.

classjira.resources.User

A Jira user.

classjira.resources.Version

A version of a project.

classjira.resources.Votes

Vote information on an issue.

classjira.resources.Watchers

Watcher information on an issue.

classjira.resources.WorkflowScheme

WorkflowScheme information on a project.

classjira.resources.Worklog

Worklog on an issue.

func

jira.resources.dict2resource(raw:dict[str, Any], top=None, options=None, session=None) -> PropertyHolder | type[Resource]

Convert a dictionary into a Jira Resource object.

classjira.utils.CaseInsensitiveDict

A case-insensitive ``dict``-like object.

funcjira.utils.json_loads(resp:Response | None) -> Any

Attempts to load json the result of a response.

About this data

These signatures were extracted from the public source of pycontribs/jira using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries