Skip to content

Added get_dashboard method #1109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 12, 2023
Merged

Added get_dashboard method #1109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c4b3144
Added request_current_index_from_node method and docs for the cluster…
SLRover Nov 15, 2022
70efeeb
Added description to docs for method get_cluster_all_nodes
SLRover Nov 15, 2022
1314fb3
Merge branch 'master' of https://github.com/atlassian-api/atlassian-p…
SLRover Jan 12, 2023
5a5c058
Added get_dashboard method. Ability to get dashboard by ID.
SLRover Jan 12, 2023
15999c1
Fix resource_url for get_dashboard method
SLRover Jan 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions atlassian/jira.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,16 @@ def get_dashboards(self, filter="", start=0, limit=10):
url = self.resource_url("dashboard")
return self.get(url, params=params)

def get_dashboard(self, dashboard_id):
"""
Returns a single dashboard

:param dashboard_id: Dashboard ID Int
:return:
"""
url = self.resource_url("dashboard/{dashboard_id}".format(dashboard_id=dashboard_id))
return self.get(url)

"""
Filters. Resource for searches
Reference: https://docs.atlassian.com/software/jira/docs/api/REST/8.5.0/#api/2/filter
Expand Down
9 changes: 9 additions & 0 deletions docs/jira.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,15 @@ Manage Boards
# Add/Move Issues to sprint
jira.add_issues_to_sprint(sprint_id, issues_list)


Manage dashboards
-----------------

.. code-block:: python

# Get dashboard by ID
jira.get_dashboard(dashboard_id)

Attachments actions
-------------------

Expand Down