jira-rest
v0.0.2
Published
Atlasian Jira Api
Downloads
3
Readme
JIRA REST API for NodeJS
This gives access to most Jira Rest API data
Installation
npm install jira-rest
Usage
Initialization
var jira = require('jira-rest');
var config = {
"url": "http://jira.example.com",
"authorization": {
"username": "xyz",
"password": "***************"
}
};
var jiraconnection = jira.connect(config);
Methods
All Projects
jiraconnection.fetchProjects(function(error, data) {
//statement
});
Single Project
jiraconnection.fetchProject({
projectid: "xxxx"
}, function(error, data, config) {
// statement
});
All release of a project
jiraconnection.fetchProjectVersions({
projectid: "xxxx",
rapidviewid: "yyyy"
}, function(error, data, config) {
//statement
});
Single release of a project
jiraconnection.fetchProjectVersion({
projectid: "xxxx",
rapidviewid: "yyyy",
versionid: "zzzz"
}, function(error, data, config) {
//statement
});
Single release defectscreated
jiraconnection.fetchProjectVersionDefectsCreated({
projectid: "xxxx",
startdate: "YYYY-MM-DD hh:mm",
enddate: "YYYY-MM-DD hh:mm"
}, function(error, data, config) {
//statement
});
Single release defectscreated
jiraconnection.fetchProjectVersionDefectsResolved({
projectid: "xxxx",
versionid: "zzzz",
startdate: "YYYY-MM-DD hh:mm",
enddate: "YYYY-MM-DD hh:mm"
}, function(error, data, config) {
//statement
});
All sprints of a Project
jiraconnection.fetchProjectSprints({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Single sprint of a Project
jiraconnection.fetchProjectSprint({
rapidviewid: "yyyy",
sprintid: "zzzz"
}, function(error, data, config) {
//statement
});
Defects created for a sprint of a Project
jiraconnection.fetchProjectSprintDefectsCreated({
projectid: "xxxx",
startdate: "YYYY-MM-DD hh:mm",
enddate: "YYYY-MM-DD hh:mm"
}, function(error, data, config) {
//statement
});
Defects resolved for a sprint of a Project
jiraconnection.fetchProjectSprintDefectsResolved({
projectid: "xxxx",
startdate: "YYYY-MM-DD hh:mm",
enddate: "YYYY-MM-DD hh:mm"
}, function(error, data, config) {
//statement
});
Defects unresolved for a sprint of a Project
jiraconnection.fetchProjectSprintDefectsUnresolved({
projectid: "xxxx",
startdate: "YYYY-MM-DD hh:mm",
enddate: "YYYY-MM-DD hh:mm"
}, function(error, data, config) {
//statement
});
Defects by Severity of a Project
jiraconnection.fetchProjectDefectsBySeverity({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Defects by Environment of a Project
jiraconnection.fetchProjectDefectsByEnvironment({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Single Project's Defects Age Less than 15 days
jiraconnection.fetchProjectDefectsByAgeLess15d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Single Project's Defects Age More than 15 days & Less than 30 days
jiraconnection.fetchProjectDefectsByAgeLess30d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Single Project's Defects Age More than 30 days & Less than 60 days
jiraconnection.fetchProjectDefectsByAgeLess60d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Single Project's Defects Age More than 60 days & Less than 90 days
jiraconnection.fetchProjectDefectsByAgeLess90d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Single Project's Defects Age More than 90 days
jiraconnection.fetchProjectDefectsByAgeMore90d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Defects Resoulution Time Report Less than 15 days
jiraconnection.fetchProjectDefectsResolutionLess15d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Defects Resoulution Time Report More than 15 days & Less than 30 days
jiraconnection.fetchProjectDefectsResolutionLess30d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Defects Resoulution Time Report More than 30 days & Less than 60 days
jiraconnection.fetchProjectDefectsResolutionLess60d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Defects Resoulution Time Report More than 60 days & Less than 90 days
jiraconnection.fetchProjectDefectsResolutionLess90d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Defects Resoulution Time Report More than 90 days
jiraconnection.fetchProjectDefectsResolutionMore90d({
projectid: "xxxx"
}, function(error, data, config) {
//statement
});
Features
- supports read only operation
- supports only basic authentication
- supports non-secured api url (http)