This Ballerina client connector allows to connect to Atlassian JIRA, which provides bug tracking, issue tracking, and project management functions. It uses the JIRA REST API to connect to JIRA, work with JIRA projects, view and update issues, work with jira user accounts, and more. It also handles basic authentication, provides auto completion and type conversions.

The JIRA REST API is an ideal solution for the developers who want to integrate JIRA with other standalone or web applications, and administrators who want to script interactions with the JIRA server. Because the JIRA REST API is based on open standards, you can use any web development language to access the API.

The following sections provide information on how to use Ballerina JIRA Connector.

• Getting started
• Authentication
• Working with JIRA Connector Actions

• Refer https://ballerina.io/learn/getting-started/ to download Ballerina and install tools.

• Create a new Ballerina project by executing the following command.

  <PROJECT_ROOT_DIRECTORY>$ ballerina init

• Import the jira module to your Ballerina program as follows.This will download the jira7 artifacts from the ballerina central to your local repository.

   import wso2/jira7;

Note - JIRA’s REST API is protected by the same restrictions which are provided via JIRAs standard web interface. This means that if you do not have valid jira credentials, you are accessing JIRA anonymously. Furthermore, if you log in and do not have permission to view something in JIRA, you will not be able to view it using the Ballerina JIRA Connector as well.

Ballerina JIRA connector currently provides basic authentication as the authentication method.
Please follow the following steps to authenticate your connector.

• Obtain your JIRA user account credentials(username and password). If you currently dont have a JIRA account, you can create a new JIRA account from JIRA Sign-Up Page.

• Provide the credentials to your endpoint in the initialization step, as shown in the following sample code.

import ballerina/http;
import wso2/jira7;

//Creation of connector endpoint
jira7:JiraConfiguration jiraConfig = {
    baseUrl: config:getAsString("test_url"),
    clientConfig: {
        auth: {
            scheme: http:BASIC_AUTH,
            config: {
                username: config:getAsString("test_username"),
                password: config:getAsString("test_password")
            }
        }
    }
};

jira7:Client jiraConnectorEP = new(jiraConfig);

All actions of the JIRA connector return either the response or an error.

If a action was successfull, then the requested struct object or boolean true response will be returned or otherwise will returns an Connector error with error message,error type and cause.

• Request

import ballerina/http;
import ballerina/io;
import wso2/jira7;

// Create the jira client.
jira7:JiraConfiguration jiraConfig = {
    baseUrl: config:getAsString("test_url"),
    clientConfig: {
        auth: {
            scheme: http:BASIC_AUTH,
            config: {
                username: config:getAsString("test_username"),
                password: config:getAsString("test_password")
            }
        }
    }
};

jira7:Client jiraClient = new(jiraConfig);

public function main(string... args) {

    string projectKey = "RRDEVSPRT";

    var output = jiraClient->getProject(projectKey);
    if (output is jira7:Project) {
        io:println("Project Details: ", output);
    } else {
        io:println("Error: ", output.message);
    }
}

• Response Object

public type Project record {
    string self;
    string id;
    string key;
    string name;
    string description;
    string leadName;
    string projectTypeKey;
    AvatarUrls avatarUrls;
    ProjectCategory projectCategory;
    IssueType[] issueTypes;
    ProjectComponentSummary[] components;
    ProjectVersion[] versions;
}

Now that you have basic knowledge about to how Ballerina JIRA endpoint works, use the information in the following sections to perform various operations with the endpoint.

• Working with Projects in JIRA

• Working with Project Categories in JIRA

• Working with Project Components in JIRA

• Working with Issues in JIRA

• getAllProjectSummaries()
• getAllDetailsFromProjectSummary()
• getProject()
• createProject()
• updateProject()
• deleteProject()
• getLeadUserDetailsOfProject()
• getRoleDetailsOfProject()
• addUserToRoleOfProject()
• addGroupToRoleOfProject()
• removeUserFromRoleOfProject()
• removeGroupFromRoleOfProject()
• getAllIssueTypeStatusesOfProject()
• changeTypeOfProject()

• getAllProjectCategories()
• createProjectCategory()
• getProjectCategory()
• deleteProjectCategory()

• createProjectComponent()
• getProjectComponent()
• deleteProjectComponent()
• getAssigneeUserDetailsOfProjectComponent()
• getLeadUserDetailsOfProjectComponent()

• createIssue()
• updateIssue()
• deleteIssue()