NPM Package For JIRA (Service Desk) REST API



A node.js module, which provides an object oriented wrapper for the JIRA REST API.

This library is built to support version 3.9.1 of the JIRA Service Desk API.

JIRA Service Desk API documentation can be found here

Service Desk Public REST API

Installation

Install with the node package manager npm:

``shell
$ npm install build-jira
`

How To Use?

$3

`javascript
const JiraApi = require('build-jira').jira;

const jira = new JiraApi({
host: ,
username: ,
password:
});
`

$3

`javascript
/ For servicedeskInfo input is not required, hence first parameter is null in this call. /

jira.serviceDeskInfo(null, (error, body) => {
console.log('RESPONSE: ', error, body);
});
`

$3

`javascript
/ If start and limit is not passed, then default values 0 and 10 will get applied respectively /

jira.getAllServiceDesks({ start: 0, limit: 10 }, (error, body) => {
console.log('RESPONSE: ', error, body);
});
`

$3

`javascript
jira.getServiceDeskById(, (error, body) => {
console.log('RESPONSE: ', error, body);
});
`

$3

`javascript
let input = {
serviceDeskId: ,
requestTypeId: ,
summary: ,
description:
};

jira.createServiceDeskTicket(input, (error, body) => {
console.log('RESPONSE:', error, body);
});
`

$3

`javascript
/ If start and limit is not passed, then default values 0 and 10 will get applied respectively /

/*
NOTE: HERE input IS NOT MANDATORY
IF YOU PASS IT THEN IT WILL RETURN DATA ACCORDINGLY
ELSE IT WILL RETURN DEFAULT DATA
*/

let input = {
start: ,
limit: ,
requestOwnership: ,
requestStatus: ,
searchString: ,
serviceDeskId:
};

jira.getAllRequestsOfCustomer(input, (error, body) => {
console.log('RESPONSE:', error, body);
});
`

$3

`javascript
jira.getCustomerRequestById(, (error, body) => {
console.log('RESPONSE: ', error, body);
});
`

$3

`javascript

let input = {
serviceDeskId: ,
issueId: ,
file: [],
comment:
};

jira.createCustomerAttachment(input, (error, body) => {
console.log('RESPONSE:', error, body);
});
`

$3

`javascript

let input = {
issueId: ,
comment:
};

jira.addCommentOnCustomerRequest(input, (error, body) => {
console.log('RESPONSE:', error, body);
});
`

$3

`javascript
/ If start and limit is not passed, then default values 0 and 10 will get applied respectively /

let input = {
start: ,
limit: ,
issueId:
};

jira.getCommentsOnCustomerRequest(input, (error, body) => {
console.log('RESPONSE:', error, body);
});
`

$3

`javascript
/ If start and limit is not passed, then default values 0 and 10 will get applied respectively /

let input = {
start: ,
limit: ,
issueId:
};

jira.getCustomerRequestStatus(input, (error, body) => {
console.log('RESPONSE:', error, body);
});
`

Options

jiraApi options:

- host: The hostname for your jira server
- user: The username to log in with
- password`: Keep it secret, keep it safe

Implemented APIs

- Service Desk

- Infomation
- Get All Service Desks
- Get Service Desk By Id
- Create New Ticket In Service Desk
- Get All Requests Of Customer
- Get Customer Request By Id
- Create Attachment To Customer Request
- Add Comment on Customer Request
- Get All Comments On Customer Request
- Get Customer Request Status (Current And History)

Changelog

- _1.0.8 addCommentOnCustomerRequest, getCommentsOnCustomerRequest, getCustomerRequestStatus functions added, and other changes_
- _1.0.6 createCustomerAttachment function added_
- _1.0.5 getAllRequestsOfCustomer, getCustomerRequestById functions added and Javascript Standard Style Guid applied_
- _1.0.4 README updated_
- _1.0.3 createServiceDeskTicket function added_
- _1.0.2 serviceDeskInfo parameter corrected_
- _1.0.1 READEME file added_
- _1.0.0 Initial version_