Code Monkey home page Code Monkey logo

jira-rest-essentials's Introduction

JIRA REST Essentials

Build Status codecov Donate

This JIRA plugin exists to close some gaps of the JIRA REST API.

FieldScreen

GET https://example.com/jira/rest/essentials/1.0/screen

  • lists all screens by id and name

GET https://example.com/jira/rest/essentials/1.0/screen?projectKey={projectKey}

  • lists all screens associated with a given project

GET https://example.com/jira/rest/essentials/1.0/screen?name={screenName}

  • returns the id for a screen with the given name

CustomField

GET https://example.com/jira/rest/essentials/1.0/customfield/description

  • lists all custom field descriptions by field (with prefix custom_*)

GET https://example.com/jira/rest/essentials/1.0/customfield/description?id={id}

  • returns a custom field description for a given field (id as long without prefix)

GET https://example.com/jira/rest/essentials/1.0/customfield/translations

  • returns all available translations for all fields

PUT https://example.com/jira/rest/essentials/1.0/customfield/translations

Request body example:

[
    {
        "id" : "customfield_12345",
        "name" : {
            "de_DE" : "Hinweis",
            "en_UK" : "Hint"
        },
        "description" : {
            "de_DE" : "Zusatzinformation",
            "en_UK" : "Additional information"
        }
    }
]

GET https://example.com/jira/rest/essentials/1.0/status/translations

  • returns all available translations of status name / description

PUT https://example.com/jira/rest/essentials/1.0/status/translations

Request body example:

[
    {
        "id": "1",
        "name": {
            "de": "Offen",
            "en_US": "Open"
        },
        "description": {
            "de": "Ein offener Vorgang.",
            "en_US": "An open issue."
        }
    },
    {
        "id": "2",
        "name": {
            "de": "Geschlossen",
            "en_US": "Closed"
        },
        "description": {
            "de": "Ein geschlossener Vorgang.",
            "en_US": "A closed issue."
        }
    }
]

GET https://example.com/jira/rest/essentials/1.0/workflowscheme?projectKey=EXAMPLE

  • returns workflow scheme id for given project

Comments

POST https://example.com/jira/rest/essentials/1.0/comment?issueKey=EXAMPLE-123

Request body example:

{
  "author": "someuser",
  "body": "secret comment",
  "projectAdminsOnly": true
}

Create option

PUT https://example.com/jira/rest/essentials/1.0/option?customfieldId=customfield_12345&value=Yes

  • returns the id of the created option
  • Limit: works only with the first configuration scheme of a custom field.

Disabled options

GET https://example.com/jira/rest/essentials/1.0/disabled-options

  • returns all options marked as disabled

Build the Add-on

  • Use Maven to build a deployable jar file: mvn clean package

jira-rest-essentials's People

Contributors

jenspiegsa avatar jhansen54 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.