6. API Documentation¶
6.1. JIRA¶
-
class
jira.
JIRA
(server=None, options=None, basic_auth=None, oauth=None, jwt=None, kerberos=False, validate=False, get_server_info=True, async=False, logging=True, max_retries=3, proxies=None, timeout=None)[source]¶ Bases:
object
User interface to JIRA.
Clients interact with JIRA by constructing an instance of this object and calling its methods. For addressable resources in JIRA – those with “self” links – an appropriate subclass of
Resource
will be returned with customizedupdate()
anddelete()
methods, along with attribute access to fields. This means that calls of the formissue.fields.summary
will be resolved into the proper lookups to return the JSON value at that mapping. Methods that do not return resources will return a dict constructed from the JSON response or a scalar value; see each method’s documentation for details on what that method returns.-
AGILE_BASE_URL
= u'{server}/rest/{agile_rest_path}/{agile_rest_api_version}/{path}'¶
-
DEFAULT_OPTIONS
= {u'agile_rest_api_version': u'1.0', u'agile_rest_path': u'greenhopper', u'async': False, u'check_update': False, u'client_cert': None, u'context_path': u'/', u'headers': {u'Content-Type': u'application/json', u'X-Atlassian-Token': u'no-check', u'Cache-Control': u'no-cache'}, u'resilient': True, u'rest_api_version': u'2', u'rest_path': u'api', u'server': u'http://localhost:2990/jira', u'verify': True}¶
-
JIRA_BASE_URL
= u'{server}/rest/{rest_path}/{rest_api_version}/{path}'¶
-
add_attachment
(*args, **kwargs)[source]¶ Attach an attachment to an issue and returns a Resource for it.
The client will not attempt to open or validate the attachment; it expects a file-like object to be ready for its use. The user is still responsible for tidying up (e.g., closing the file, killing the socket, etc.)
Parameters: - issue – the issue to attach the attachment to
- attachment – file-like object to attach to the issue, also works if it is a string with the filename.
- filename – optional name for the attached file. If omitted, the file object’s
name
attribute is used. If you aquired the file-like object by any other method thanopen()
, make sure that a name is specified in one way or the other.
Return type: an Attachment Resource
-
add_comment
(*args, **kwargs)[source]¶ Add a comment from the current authenticated user on the specified issue and return a Resource for it.
The issue identifier and comment body are required.
Parameters: - issue – ID or key of the issue to add the comment to
- body – Text of the comment to add
- visibility – a dict containing two entries: “type” and “value”. “type” is ‘role’ (or ‘group’ if the JIRA server has configured comment visibility for groups) and ‘value’ is the name of the role (or group) to which viewing of this comment will be restricted.
-
add_group
(groupname)[source]¶ Create a new group in JIRA.
Parameters: groupname – The name of the group you wish to create. Returns: Boolean - True if succesfull.
-
add_issues_to_epic
(epic_id, issue_keys, ignore_epics=True)[source]¶ Add the issues in
issue_keys
to theepic_id
.Parameters: - epic_id – the epic to add issues to
- issue_keys – the issues to add to the epic
- ignore_epics – ignore any issues listed in
issue_keys
that are epics
-
add_issues_to_sprint
(sprint_id, issue_keys)[source]¶ Add the issues in
issue_keys
to thesprint_id
.The sprint must be started but not completed.
If a sprint was completed, then have to also edit the history of the issue so that it was added to the sprint before it was completed, preferably before it started. A completed sprint’s issues also all have a resolution set before the completion date.
If a sprint was not started, then have to edit the marker and copy the rank of each issue too.
Parameters: - sprint_id – the sprint to add issues to
- issue_keys – the issues to add to the sprint
-
add_remote_link
(issue, destination, globalId=None, application=None, relationship=None)[source]¶ Add a remote link from an issue to an external application and returns a remote link Resource for it.
object
should be a dict containing at leasturl
to the linked external URL andtitle
to display for the link inside JIRA.For definitions of the allowable fields for
object
and the keyword argumentsglobalId
,application
andrelationship
, see https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+for+Remote+Issue+Links.Parameters: - issue – the issue to add the remote link to
- destination – the link details to add (see the above link for details)
- globalId – unique ID for the link (see the above link for details)
- application – application information for the link (see the above link for details)
- relationship – relationship description for the link (see the above link for details)
-
add_simple_link
(issue, object)[source]¶ Add a simple remote link from an issue to web resource.
- This avoids the admin access problems from add_remote_link by just
- using a simple object and presuming all fields are correct and not
requiring more complex
application
data. object
should be a dict containing at leasturl
to the- linked external URL and
title
to display for the link inside JIRA.
For definitions of the allowable fields for
object
, see https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+for+Remote+Issue+Links.Parameters: - issue – the issue to add the remote link to
- object – the dictionary used to create remotelink data
-
add_user
(username, email, directoryId=1, password=None, fullname=None, notify=False, active=True, ignore_existing=False)[source]¶ Create a new JIRA user.
Parameters: - username (
str
) – the username of the new user - email (
str
) – email address of the new user - directoryId (
int
) – the directory ID the new user should be a part of - password (
str
) – Optional, the password for the new user - fullname (
str
) – Optional, the full name of the new user - notify (
bool
) – Whether or not to send a notification to the new user - active (
bool
) – Whether or not to make the new user active upon creation
- username (
-
add_user_to_group
(username, group)[source]¶ Add a user to an existing group.
Parameters: - username – Username that will be added to specified group.
- group – Group that the user will be added to.
Returns: json response from Jira server for success or a value that evaluates as False in case of failure.
-
add_vote
(*args, **kwargs)[source]¶ Register a vote for the current authenticated user on an issue.
Parameters: issue – ID or key of the issue to vote on
-
add_watcher
(*args, **kwargs)[source]¶ Add a user to an issue’s watchers list.
Parameters: - issue – ID or key of the issue affected
- watcher – username of the user to add to the watchers list
-
add_worklog
(*args, **kwargs)[source]¶ Add a new worklog entry on an issue and return a Resource for it.
Parameters: - issue – the issue to add the worklog to
- timeSpent – a worklog entry with this amount of time spent, e.g. “2d”
- adjustEstimate – (optional) allows the user to provide specific instructions to update the remaining
time estimate of the issue. The value can either be
new
,leave
,manual
orauto
(default). - newEstimate – the new value for the remaining estimate field. e.g. “2d”
- reduceBy – the amount to reduce the remaining estimate by e.g. “2d”
- started – Moment when the work is logged, if not specified will default to now
- comment – optional worklog comment
-
application_properties
(key=None)[source]¶ Return the mutable server application properties.
Parameters: key – the single property to return a value for
-
assign_issue
(*args, **kwargs)[source]¶ Assign an issue to a user. None will set it to unassigned. -1 will set it to Automatic.
Parameters: - issue – the issue to assign
- assignee – the user to assign the issue to
-
async_do
(size=10)[source]¶ Execute all async jobs and wait for them to finish. By default it will run on 10 threads.
Parameters: size – number of threads to run on.
-
backup
(filename=u'backup.zip', attachments=False)[source]¶ Will call jira export to backup as zipped xml. Returning with success does not mean that the backup process finished.
-
backup_complete
()[source]¶ Return boolean based on ‘alternativePercentage’ and ‘size’ returned from backup_progress (cloud only).
-
backup_progress
()[source]¶ Return status of cloud backup as a dict.
Is there a way to get progress for Server version?
-
boards
(*args, **kwargs)[source]¶ Get a list of board resources.
Parameters: - startAt – The starting index of the returned boards. Base index: 0.
- maxResults – The maximum number of boards to return per page. Default: 50
- type – Filters results to boards of the specified type. Valid values: scrum, kanban.
- name – Filters results to boards that match or partially match the specified name.
Return type: ResultList[Board]
When old GreenHopper private API is used, paging is not enabled and all parameters are ignored.
-
checked_version
= False¶
-
comment
(*args, **kwargs)[source]¶ Get a comment Resource from the server for the specified ID.
Parameters: - issue – ID or key of the issue to get the comment from
- comment – ID of the comment to get
-
comments
(*args, **kwargs)[source]¶ Get a list of comment Resources.
Parameters: issue – the issue to get comments from
-
component
(id)[source]¶ Get a component Resource from the server.
Parameters: id – ID of the component to get
Get the count of related issues for a component.
Parameters: id (integer) – ID of the component to use
-
confirm_project_avatar
(*args, **kwargs)[source]¶ Confirm the temporary avatar image previously uploaded with the specified cropping.
After a successful registry with
create_temp_project_avatar()
, use this method to confirm the avatar for use. The final avatar can be a subarea of the uploaded image, which is customized with thecropping_properties
: the return value ofcreate_temp_project_avatar()
should be used for this argument.Parameters: - project – ID or key of the project to confirm the avatar in
- cropping_properties – a dict of cropping properties from
create_temp_project_avatar()
-
confirm_user_avatar
(user, cropping_properties)[source]¶ Confirm the temporary avatar image previously uploaded with the specified cropping.
After a successful registry with
create_temp_user_avatar()
, use this method to confirm the avatar for use. The final avatar can be a subarea of the uploaded image, which is customized with thecropping_properties
: the return value ofcreate_temp_user_avatar()
should be used for this argument.Parameters: - user – the user to confirm the avatar for
- cropping_properties – a dict of cropping properties from
create_temp_user_avatar()
-
create_board
(name, project_ids, preset=u'scrum')[source]¶ Create a new board for the
project_ids
.Parameters: - name – name of the board
- project_ids – the projects to create the board in
- preset ('kanban', 'scrum', 'diy') – what preset to use for this board
-
create_component
(*args, **kwargs)[source]¶ Create a component inside a project and return a Resource for it.
Parameters: - name – name of the component
- project – key of the project to create the component in
- description – a description of the component
- leadUserName – the username of the user responsible for this component
- assigneeType – see the ComponentBean.AssigneeType class for valid values
- isAssigneeTypeValid – boolean specifying whether the assignee type is acceptable
-
create_filter
(name=None, description=None, jql=None, favourite=None)[source]¶ Create a new filter and return a filter Resource for it.
Parameters: - name – name of the new filter
- description – useful human readable description of the new filter
- jql – query string that defines the filter
- favourite – whether to add this filter to the current user’s favorites
-
create_issue
(fields=None, prefetch=True, **fieldargs)[source]¶ Create a new issue and return an issue Resource for it.
Each keyword argument (other than the predefined ones) is treated as a field name and the argument’s value is treated as the intended value for that field – if the fields argument is used, all other keyword arguments will be ignored.
By default, the client will immediately reload the issue Resource created by this method in order to return a complete Issue object to the caller; this behavior can be controlled through the ‘prefetch’ argument.
JIRA projects may contain many different issue types. Some issue screens have different requirements for fields in a new issue. This information is available through the ‘createmeta’ method. Further examples are available here: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Create+Issue
Parameters: - fields – a dict containing field names and the values to use. If present, all other keyword arguments will be ignored
- prefetch – whether to reload the created issue Resource so that all of its data is present in the value returned from this method
-
create_issue_link
(*args, **kwargs)[source]¶ Create a link between two issues.
Parameters: - type – the type of link to create
- inwardIssue – the issue to link from
- outwardIssue – the issue to link to
- comment – a comment to add to the issues with the link. Should be
a dict containing
body
andvisibility
fields:body
being the text of the comment andvisibility
being a dict containing two entries:type
andvalue
.type
isrole
(orgroup
if the JIRA server has configured comment visibility for groups) andvalue
is the name of the role (or group) to which viewing of this comment will be restricted.
-
create_issues
(field_list, prefetch=True)[source]¶ Bulk create new issues and return an issue Resource for each successfully created issue.
See create_issue documentation for field information.
Parameters: - field_list – a list of dicts each containing field names and the values to use. Each dict is an individual issue to create and is subject to its minimum requirements.
- prefetch – whether to reload the created issue Resource for each created issue so that all of its data is present in the value returned from this method.
-
create_project
(key, name=None, assignee=None, type=u'Software', template_name=None)[source]¶ Key is mandatory and has to match JIRA project key requirements, usually only 2-10 uppercase characters.
If name is not specified it will use the key value. If assignee is not specified it will use current user. Parameter template_name is used to create a project based on one of the existing project templates. If template_name is not specified, then it should use one of the default values. The returned value should evaluate to False if it fails otherwise it will be the new project id.
-
create_sprint
(name, board_id, startDate=None, endDate=None)[source]¶ Create a new sprint for the
board_id
.Parameters: - name – name of the sprint
- board_id – the board to add the sprint to
-
create_temp_project_avatar
(*args, **kwargs)[source]¶ Register an image file as a project avatar.
- The avatar created is temporary and must be confirmed before it can
- be used.
- Avatar images are specified by a filename, size, and file object. By default, the client will attempt to
- autodetect the picture’s content type: this mechanism relies on libmagic and will not work out of the box
on Windows systems (see http://filemagic.readthedocs.org/en/latest/guide.html for details on how to install
support). The
contentType
argument can be used to explicitly set the value (note that JIRA will reject any type other than the well-known ones for images, e.g.image/jpg
,image/png
, etc.) - This method returns a dict of properties that can be used to crop a subarea of a larger image for use. This
- dict should be saved and passed to
confirm_project_avatar()
to finish the avatar creation process. If you want to cut out the middleman and confirm the avatar with JIRA’s default cropping, pass the ‘auto_confirm’ argument with a truthy value andconfirm_project_avatar()
will be called for you before this method returns.
Parameters: - project – ID or key of the project to create the avatar in
- filename – name of the avatar file
- size – size of the avatar file
- avatar_img – file-like object holding the avatar
- contentType – explicit specification for the avatar image’s content-type
- auto_confirm (boolean) – whether to automatically confirm the temporary avatar by calling
confirm_project_avatar()
with the return value of this method.
-
create_temp_user_avatar
(user, filename, size, avatar_img, contentType=None, auto_confirm=False)[source]¶ Register an image file as a user avatar.
The avatar created is temporary and must be confirmed before it can be used.
Avatar images are specified by a filename, size, and file object. By default, the client will attempt to autodetect the picture’s content type: this mechanism relies on
libmagic
and will not work out of the box on Windows systems (see http://filemagic.readthedocs.org/en/latest/guide.html for details on how to install support). ThecontentType
argument can be used to explicitly set the value (note that JIRA will reject any type other than the well-known ones for images, e.g.image/jpg
,image/png
, etc.)This method returns a dict of properties that can be used to crop a subarea of a larger image for use. This dict should be saved and passed to
confirm_user_avatar()
to finish the avatar creation process. If you want to cut out the middleman and confirm the avatar with JIRA’s default cropping, pass theauto_confirm
argument with a truthy value andconfirm_user_avatar()
will be called for you before this method returns.Parameters: - user – user to register the avatar for
- filename – name of the avatar file
- size – size of the avatar file
- avatar_img – file-like object containing the avatar
- contentType – explicit specification for the avatar image’s content-type
- auto_confirm – whether to automatically confirm the temporary avatar by calling
confirm_user_avatar()
with the return value of this method.
-
create_version
(*args, **kwargs)[source]¶ Create a version in a project and return a Resource for it.
Parameters: - name – name of the version to create
- project – key of the project to create the version in
- description – a description of the version
- releaseDate – the release date assigned to the version
- startDate – The start date for the version
-
createmeta
(projectKeys=None, projectIds=[], issuetypeIds=None, issuetypeNames=None, expand=None)[source]¶ Get the metadata required to create issues, optionally filtered by projects and issue types.
Parameters: - projectKeys – keys of the projects to filter the results with. Can be a single value or a comma-delimited string. May be combined with projectIds.
- projectIds – IDs of the projects to filter the results with. Can be a single value or a comma-delimited string. May be combined with projectKeys.
- issuetypeIds – IDs of the issue types to filter the results with. Can be a single value or a comma-delimited string. May be combined with issuetypeNames.
- issuetypeNames – Names of the issue types to filter the results with. Can be a single value or a comma-delimited string. May be combined with issuetypeIds.
- expand – extra information to fetch inside each resource.
-
custom_field_option
(id)[source]¶ Get a custom field option Resource from the server.
Parameters: id – ID of the custom field to use
-
dashboard
(id)[source]¶ Get a dashboard Resource from the server.
Parameters: id – ID of the dashboard to get.
-
dashboards
(filter=None, startAt=0, maxResults=20)[source]¶ Return a ResultList of Dashboard resources and a
total
count.Parameters: - filter – either “favourite” or “my”, the type of dashboards to return
- startAt – index of the first dashboard to return
- maxResults – maximum number of dashboards to return. If maxResults evaluates as False, it will try to get all items in batches.
Return type: ResultList
-
delete_attachment
(id)[source]¶ Delete attachment by id.
Parameters: id – ID of the attachment to delete
-
delete_issue_link
(id)[source]¶ Delete a link between two issues.
Parameters: id – ID of the issue link to delete
-
delete_project
(pid)[source]¶ Delete project from Jira.
Parameters: pid (str) – JIRA projectID or Project or slug
Returns bool: True if project was deleted
Raises: - JIRAError – If project not found or not enough permissions
- ValueError – If pid parameter is not Project, slug or ProjectID
-
delete_project_avatar
(*args, **kwargs)[source]¶ Delete a project’s avatar.
Parameters: - project – ID or key of the project to delete the avatar from
- avatar – ID of the avater to delete
-
delete_user_avatar
(username, avatar)[source]¶ Delete a user’s avatar.
Parameters: - username – the user to delete the avatar from
- avatar – ID of the avatar to remove
-
editmeta
(*args, **kwargs)[source]¶ Get the edit metadata for an issue.
Parameters: issue – the issue to get metadata for
-
email_user
(user, body, title=u'JIRA Notification')[source]¶ (Obsolete) Send an email to an user via CannedScriptRunner.
-
favourite_filters
()[source]¶ Get a list of filter Resources which are the favourites of the currently authenticated user.
-
find
(resource_format, ids=None)[source]¶ Find Resource object for any addressable resource on the server.
This method is a universal resource locator for any RESTful resource in JIRA. The argument
resource_format
is a string of the formresource
,resource/{0}
,resource/{0}/sub
,resource/{0}/sub/{1}
, etc. The format placeholders will be populated from theids
argument if present. The existing authentication session will be used.The return value is an untyped Resource object, which will not support specialized
Resource.update()
orResource.delete()
behavior. Moreover, it will not know to return an issue Resource if the client uses the resource issue path. For this reason, it is intended to support resources that are not included in the standard Atlassian REST API.Parameters:
-
find_transitionid_by_name
(issue, transition_name)[source]¶ Get a transitionid available on the specified issue to the current user.
Look at https://developer.atlassian.com/static/rest/jira/6.1.html#d2e1074 for json reference
Parameters: - issue – ID or key of the issue to get the transitions from
- trans_name – iname of transition we are looking for
-
group_members
(group)[source]¶ Return a hash or users with their information. Requires JIRA 6.0 or will raise NotImplemented.
-
groups
(query=None, exclude=None, maxResults=9999)[source]¶ Return a list of groups matching the specified criteria.
Parameters: - query – filter groups by name with this string
- exclude – filter out groups by name with this string
- maxResults – maximum results to return. defaults to 9999
-
incompletedIssuesEstimateSum
(board_id, sprint_id)[source]¶ Return the total incompleted points this sprint.
-
issue
(id, fields=None, expand=None)[source]¶ Get an issue Resource from the server.
Parameters: - id – ID or key of the issue to get
- fields – comma-separated string of issue fields to include in the results
- expand – extra information to fetch inside each resource
-
issue_link
(id)[source]¶ Get an issue link Resource from the server.
Parameters: id – ID of the issue link to get
-
issue_link_type
(id)[source]¶ Get an issue link type Resource from the server.
Parameters: id – ID of the issue link type to get
-
issue_type
(id)[source]¶ Get an issue type Resource from the server.
Parameters: id – ID of the issue type to get
-
kill_websudo
()[source]¶ Destroy the user’s current WebSudo session.
Works only for non-cloud deployments, for others does nothing.
-
move_to_backlog
(issue_keys)[source]¶ Move issues in
issue_keys
to the backlog, removing them from all sprints that have not been completed.Parameters: issue_keys – the issues to move to the backlog
-
move_version
(id, after=None, position=None)[source]¶ Move a version within a project’s ordered version list and return a new version Resource for it.
One, but not both, of
after
andposition
must be specified.Parameters: - id – ID of the version to move
- after – the self attribute of a version to place the specified version after (that is, higher in the list)
- position – the absolute position to move this version to: must be one of
First
,Last
,Earlier
, orLater
-
my_permissions
(projectKey=None, projectId=None, issueKey=None, issueId=None)[source]¶ Get a dict of all available permissions on the server.
Parameters: - projectKey – limit returned permissions to the specified project
- projectId – limit returned permissions to the specified project
- issueKey – limit returned permissions to the specified issue
- issueId – limit returned permissions to the specified issue
-
priority
(id)[source]¶ Get a priority Resource from the server.
Parameters: id – ID of the priority to get
-
project
(id)[source]¶ Get a project Resource from the server.
Parameters: id – ID or key of the project to get
-
project_avatars
(*args, **kwargs)[source]¶ Get a dict of all avatars for a project visible to the current authenticated user.
Parameters: project – ID or key of the project to get avatars for
-
project_components
(*args, **kwargs)[source]¶ Get a list of component Resources present on a project.
Parameters: project – ID or key of the project to get components from
-
project_role
(*args, **kwargs)[source]¶ Get a role Resource.
Parameters: - project – ID or key of the project to get the role from
- id – ID of the role to get
-
project_roles
(*args, **kwargs)[source]¶ Get a dict of role names to resource locations for a project.
Parameters: project – ID or key of the project to get roles from
-
project_versions
(*args, **kwargs)[source]¶ Get a list of version Resources present on a project.
Parameters: project – ID or key of the project to get versions from
-
projects
()[source]¶ Get a list of project Resources from the server visible to the current authenticated user.
-
rank
(issue, next_issue)[source]¶ Rank an issue before another using the default Ranking field, the one named ‘Rank’.
Parameters: - issue – issue key of the issue to be ranked before the second one.
- next_issue – issue key of the second issue.
-
reindex
(force=False, background=True)[source]¶ Start jira re-indexing. Returns True if reindexing is in progress or not needed, or False.
If you call reindex() without any parameters it will perform a backfround reindex only if JIRA thinks it should do it.
Parameters: - force – reindex even if JIRA doesn’tt say this is needed, False by default.
- background – reindex inde background, slower but does not impact the users, defaults to True.
-
remote_link
(*args, **kwargs)[source]¶ Get a remote link Resource from the server.
Parameters: - issue – the issue holding the remote link
- id – ID of the remote link
-
remote_links
(*args, **kwargs)[source]¶ Get a list of remote link Resources from an issue.
Parameters: issue – the issue to get remote links from
-
remove_group
(groupname)[source]¶ Delete a group from the JIRA instance.
Parameters: groupname – The group to be deleted from the JIRA instance. Returns: Boolean. Returns True on success.
-
remove_user_from_group
(username, groupname)[source]¶ Remove a user from a group.
Parameters: - username – The user to remove from the group.
- groupname – The group that the user will be removed from.
-
remove_vote
(*args, **kwargs)[source]¶ Remove the current authenticated user’s vote from an issue.
Parameters: issue – ID or key of the issue to unvote on
-
remove_watcher
(*args, **kwargs)[source]¶ Remove a user from an issue’s watch list.
Parameters: - issue – ID or key of the issue affected
- watcher – username of the user to remove from the watchers list
-
removedIssuesEstimateSum
(board_id, sprint_id)[source]¶ Return the total incompleted points this sprint.
-
rename_user
(old_user, new_user)[source]¶ Rename a JIRA user. Current implementation relies on third party plugin but in the future it may use embedded JIRA functionality.
Parameters: - old_user – string with username login
- new_user – string with username login
-
resolution
(id)[source]¶ Get a resolution Resource from the server.
Parameters: id – ID of the resolution to get
-
search_allowed_users_for_issue
(user, issueKey=None, projectKey=None, startAt=0, maxResults=50)[source]¶ Get a list of user Resources that match a username string and have browse permission for the issue or project.
Parameters: - user – a string to match usernames against.
- issueKey – find users with browse permission for this issue.
- projectKey – find users with browse permission for this project.
- startAt – index of the first user to return.
- maxResults – maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches.
-
search_assignable_users_for_issues
(username, project=None, issueKey=None, expand=None, startAt=0, maxResults=50)[source]¶ Get a list of user Resources that match the search string for assigning or creating issues.
This method is intended to find users that are eligible to create issues in a project or be assigned to an existing issue. When searching for eligible creators, specify a project. When searching for eligible assignees, specify an issue key.
Parameters: - username – a string to match usernames against
- project – filter returned users by permission in this project (expected if a result will be used to create an issue)
- issueKey – filter returned users by this issue (expected if a result will be used to edit this issue)
- expand – extra information to fetch inside each resource
- startAt – index of the first user to return
- maxResults – maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches.
-
search_assignable_users_for_projects
(username, projectKeys, startAt=0, maxResults=50)[source]¶ Get a list of user Resources that match the search string and can be assigned issues for projects.
Parameters: - username – a string to match usernames against
- projectKeys – comma-separated list of project keys to check for issue assignment permissions
- startAt – index of the first user to return
- maxResults – maximum number of users to return. If maxResults evaluates as False, it will try to get all users in batches.
-
search_issues
(jql_str, startAt=0, maxResults=50, validate_query=True, fields=None, expand=None, json_result=None)[source]¶ Get a ResultList of issue Resources matching a JQL search string.
Parameters: - jql_str – the JQL search string to use
- startAt – index of the first issue to return
- maxResults – maximum number of issues to return. Total number of results
is available in the
total
attribute of the returned ResultList. If maxResults evaluates as False, it will try to get all issues in batches. - fields – comma-separated string of issue fields to include in the results
- expand – extra information to fetch inside each resource
- json_result – JSON response will be returned when this parameter is set to True. Otherwise, ResultList will be returned.
-
search_users
(user, startAt=0, maxResults=50, includeActive=True, includeInactive=False)[source]¶ Get a list of user Resources that match the specified search string.
Parameters: - user – a string to match usernames, name or email against.
- startAt – index of the first user to return.
- maxResults – maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches.
- includeActive – If true, then active users are included in the results.
- includeInactive – If true, then inactive users are included in the results.
-
security_level
(id)[source]¶ Get a security level Resource.
Parameters: id – ID of the security level to get
-
set_application_property
(key, value)[source]¶ Set the application property.
Parameters: - key – key of the property to set
- value – value to assign to the property
-
set_project_avatar
(*args, **kwargs)[source]¶ Set a project’s avatar.
Parameters: - project – ID or key of the project to set the avatar on
- avatar – ID of the avatar to set
-
set_user_avatar
(username, avatar)[source]¶ Set a user’s avatar.
Parameters: - username – the user to set the avatar for
- avatar – ID of the avatar to set
-
sprint_info
(board_id, sprint_id)[source]¶ Return the information about a sprint.
Parameters: - board_id – the board retrieving issues from. Deprecated and ignored.
- sprint_id – the sprint retrieving issues from
-
sprints
(*args, **kwargs)[source]¶ Get a list of sprint GreenHopperResources.
Parameters: - board_id – the board to get sprints from
- extended – Used only by old GreenHopper API to fetch additional information like startDate, endDate, completeDate, much slower because it requires an additional requests for each sprint. New JIRA Agile API always returns this information without a need for additional requests.
- startAt – the index of the first sprint to return (0 based)
- maxResults – the maximum number of sprints to return
- state – Filters results to sprints in specified states. Valid values: future, active, closed. You can define multiple states separated by commas
Return type: Returns: (content depends on API version, but always contains id, name, state, startDate and endDate) When old GreenHopper private API is used, paging is not enabled, and startAt, maxResults and state parameters are ignored.
-
status
(id)[source]¶ Get a status Resource from the server.
Parameters: id – ID of the status resource to get
-
transition_issue
(*args, **kwargs)[source]¶ Perform a transition on an issue.
Each keyword argument (other than the predefined ones) is treated as a field name and the argument’s value is treated as the intended value for that field – if the fields argument is used, all other keyword arguments will be ignored. Field values will be set on the issue as part of the transition process.
Parameters: - issue – ID or key of the issue to perform the transition on
- transition – ID or name of the transition to perform
- comment – Optional String to add as comment to the issue when performing the transition.
- fields – a dict containing field names and the values to use. If present, all other keyword arguments will be ignored
-
transitions
(*args, **kwargs)[source]¶ Get a list of the transitions available on the specified issue to the current user.
Parameters: - issue – ID or key of the issue to get the transitions from
- id – if present, get only the transition matching this ID
- expand – extra information to fetch inside each transition
-
update_filter
(filter_id, name=None, description=None, jql=None, favourite=None)[source]¶ Update a filter and return a filter Resource for it.
Parameters: - name – name of the new filter
- description – useful human readable description of the new filter
- jql – query string that defines the filter
- favourite – whether to add this filter to the current user’s favorites
-
user
(id, expand=None)[source]¶ Get a user Resource from the server.
Parameters: - id – ID of the user to get
- expand – extra information to fetch inside each resource
-
user_avatars
(username)[source]¶ Get a dict of avatars for the specified user.
Parameters: username – the username to get avatars for
-
version
(id, expand=None)[source]¶ Get a version Resource.
Parameters: - id – ID of the version to get
- expand – extra information to fetch inside each resource
Get a dict of the counts of issues fixed and affected by a version.
Parameters: id – the version to count issues for
-
version_count_unresolved_issues
(id)[source]¶ Get the number of unresolved issues for a version.
Parameters: id – ID of the version to count issues for
-
votes
(*args, **kwargs)[source]¶ Get a votes Resource from the server.
Parameters: issue – ID or key of the issue to get the votes for
-
watchers
(*args, **kwargs)[source]¶ Get a watchers Resource from the server for an issue.
Parameters: issue – ID or key of the issue to get the watchers for
-
6.4. Worklog¶
-
class
jira.
Worklog
(options, session, raw=None)[source]¶ Bases:
jira.resources.Resource
Worklog on an issue.
-
delete
(adjustEstimate=None, newEstimate=None, increaseBy=None)[source]¶ Delete this worklog entry from its associated issue.
Parameters: - adjustEstimate – one of
new
,leave
,manual
orauto
.auto
is the default and adjusts the estimate automatically.leave
leaves the estimate unchanged by this deletion. - newEstimate – combined with
adjustEstimate=new
, set the estimate to this value - increaseBy – combined with
adjustEstimate=manual
, increase the remaining estimate by this amount
- adjustEstimate – one of
-