# jira-api

> A library for working with JIRA's RESTful API

Latest version **0.2.2** (published 2012-08-19) · Apache License, Version 2.0 license · 0 weekly downloads

## Install

```sh
npm install jira-api
pnpm add jira-api
yarn add jira-api
bun add jira-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2012-08-19 |
| First published | 2012-08-17 |
| Weekly downloads | 0 |
| License | Apache License, Version 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | alexkappa |
| Keywords | jira, JIRA |

## Links

- npm: https://www.npmjs.com/package/jira-api
- npm.io page: https://npm.io/package/jira-api

## Recent versions

- 0.2.2 (latest) — 2012-08-19
- 0.2.1 — 2012-08-19
- 0.2.0 — 2012-08-19
- 0.1.1 — 2012-08-17
- 0.1.0 — 2012-08-17

## README

# JIRA API wrapper for Node.JS

A library for working with JIRA's RESTful API. No dependencies.
So far the following resources are supported:

	/rest/api/2/issue [GET, POST, PUT, DELETE]
	/rest/api/2/issue/createmeta [GET]

If you wish to contribute please follow the conventions used so far, make a new directory inside ``lib/`` named after the resource you wish to access. Thats it. Enjoy!

# Installation

Install with NPM

	npm install jira-api

In your application, require the library using

	var jira = require('jira-api');

# Usage

Now you're ready to make calls to the API

	var options = {
		config: {
			"username": "someuser",
			"passowrd": "secretpass",
			"host": "/example.com/jira/"
		},
		issueIdOrKey: "123"
	};

	jira.issue.get(options, function(response) {
		console.log(JSON.stringify(response, null, 4));
	});

You can also specify the data to send (in case of POST, PUT etc.)

	var options = {
		config: {
			"username": "someuser",
			"passowrd": "secretpass",
			"host": "example.com/jira/"
		},
		data: {
			fields: {
				project: {
					key: "PROJ999",
				},
				priority: {
					name: "Critical",
				},
				summary: "A short summary of the issue",
				description: "A more elaborate decription of the issue",
				issueType: {
					name: "Improvement"
				},
				assignee: {
					name: "Bob"
				}
			}
		}
	};

	jira.issue.post(options, function(response) {
		console.log(JSON.stringify(response, null, 4));
	});

For a list of available request representations consult the [official API documentation](http://docs.atlassian.com/jira/REST/latest/).

---
_Source: https://npm.io/package/jira-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._