build-jira

Integrate JIRA APIs with your node application easily

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
build-jira
161.0.86 years ago6 years agoMinified + gzip package size for build-jira in KB

Readme

NPM Package For JIRA (Service Desk) REST API
HitCount Generic badge GitHub license GitHub contributors GitHub issues GitHub issues-closed
NPM
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:
$ npm install build-jira

How To Use?

Create the JIRA client

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

const jira = new JiraApi({
  host: <your-jira-host>,
  username: <jira-user>,
  password: <jira-user-password>
});

Get Service Desk Information

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

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

Get All Service Desks

/* 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);
});

Get Service Desk By Id

jira.getServiceDeskById(<service-desk-id>, (error, body) => {
  console.log('RESPONSE: ', error, body);
});

Create New Ticket In Service Desk

let input = {
  serviceDeskId: <service-desk-id>,
  requestTypeId: <request-queue-id>,
  summary: <your-ticket-title>,
  description: <explanation-about-ticket>
};

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

Get Customer Requests(Tickets)

/* 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: <start-index>,
  limit: <number-of-records-to-return>,
  requestOwnership: <ticket-ownership-type>,
  requestStatus: <request-ticket-status>,
  searchString: <string-to-get-matching-records>,
  serviceDeskId: <servicedeskid-to-get-records>
};

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

Get Customer Request By Id

jira.getCustomerRequestById(<issue-id-key>, (error, body) => {
  console.log('RESPONSE: ', error, body);
});

Create Attachment For Issue/Ticket/Request In Service Desk

let input = {
  serviceDeskId: <service-desk-id>,
  issueId: <issue-id-to-add-attachment>,
  file: [<array-of-file-paths-to-attach>],
  comment: <comment-to-add-for-attachment-if-any>
};

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

Add Comment On Customer Issue/Ticket/Request In Service Desk

let input = {
  issueId: <issue-id-to-add-attachment>,
  comment: <comment-to-add>
};

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

Get All Comments On Customer Issue/Ticket/Request In Service Desk

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

let input = {
  start: <start-index>,
  limit: <number-of-records-to-return>,
  issueId: <issue-id-to-add-attachment>
};

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

Get Customer Issue/Ticket/Request Status

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

let input = {
  start: <start-index>,
  limit: <number-of-records-to-return>,
  issueId: <issue-id-to-add-attachment>
};

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

Options

jiraApi options:
  • host<string>: The hostname for your jira server
  • user<string>: The username to log in with
  • password<string>: 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