get_jira_server_info: Get the JIRA server information as a 'data.frame'

In JirAgileR: JIRA REST API Wrapper for R

Description

Makes a request to JIRA's latest REST API to retrieve all the necessary information regarding the JIRA server version.

Usage

get_jira_server_info(
  domain = NULL,
  username = NULL,
  password = NULL,
  verbose = FALSE
)

Arguments

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 save_jira_credentials() function.
username	Username used to authenticate the access to the JIRA domain. If both username and password are not passed no authentication is made and only public domains can bet accessed. Optional parameter.
password	Password used to authenticate the access to the JIRA domain. If both username and password are not passed no authentication is made and only public domains can bet accessed. Optional parameter.
verbose	Explicitly informs the user of the JIRA API request process.

Value

Returns a data.frame with all the JIRA server information

Warning

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.

See Also

For more information about Atlassians JIRA API go to JIRA API Documentation

Examples

## Not run: 
get_jira_server_info("https://bugreports.qt.io")

## End(Not run)

JirAgileR documentation built on June 8, 2021, 9:06 a.m.