Description Usage Arguments Value Warning See Also Examples
Calls JIRA's latest REST API, optionally with basic authentication, to get all issues of a JIRA query (JQL). Allows to specify which fields to obtain.
1 2 3 4 5 6 7 8 9 10 | get_jira_issues(
domain = NULL,
username = NULL,
password = NULL,
jql_query,
fields = basic_jql_fields(),
maxResults = 50,
verbose = FALSE,
as.data.frame = TRUE
)
|
domain |
Custom JIRA domain URL as for example
https://bugreports.qt.io. Can be passed as a
parameter or can be previously defined through the |
username |
Username used to authenticate the access to the JIRA |
password |
Password used to authenticate the access to the JIRA |
jql_query |
JIRA's decoded JQL query. By definition, it works with:
To learn how to create a query visit this ATLASSIAN site or the following cheatsheet. |
fields |
Optional argument to define the specific JIRA fields to obtain. If no value is entered, by default the following fields are passed:
To obtain a list of all supported fields use the following function: |
maxResults |
Max results authorized to obtain for each API call. By default JIRA sets this value to 50 issues. |
verbose |
Explicitly informs the user of the JIRA API request process. |
as.data.frame |
Defines if the function returns a flattened |
Returns a flattened, formatted data.frame
with the issues according to the JQL query.
If the comment
field is used as a fields
parameter input, each issue and its
attributes are repeated the number of comments the issue has. The function works with the
latest JIRA REST API and to work you need to have a internet connection. Calling the function
too many times might block your access, you will receive a 403 error code. To unblock your
access you will have to access interactively through your browser, signing out and signing
in again, and might even have to enter a CAPTCHA at
https://jira.yourdomain.com/secure/Dashboard.jspa. This only happens if the API
is called upon multiple times in a short period of time.
For more information about Atlassians JIRA API visit the following link: JIRA API Documentation.
1 2 | get_jira_issues(domain = "https://bugreports.qt.io",
jql_query = 'project="QTWB"')
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.